API Help
Eplan.EplApi.DataModel Namespace
/
LockingStep Class
/ Dispose() Method
Collapse All
Expand All
Language Filter: All
Language Filter: Multiple
Language Filter: Visual Basic
Language Filter: C#
Language Filter: C++/CLI
C#
C++/CLI
In This Topic
Syntax
See Also
EPLAN API
Limitation of Liability
Help structure
User Guide
Development environment
EPLAN .Net API
API Framework
Scripts
Structure of a simple script
Simple script with parameters
Loading a script
Event handling in scripts
Adding menu points by a script
Add-ins
Creating add-ins in CSharp
Creating add-ins in Visual Basic.Net
Creating an add-in in VisualStudio
Shadow Copying API Assemblies
Actions
Calling actions
Automatic actions
Adding menu points
Using EPLAN in other applications
EPLAN API offline applications
EPLAN Remoting
Using other applications
Events
API DataModel
Creating or opening projects
Creating pages
Working with parts
Navigating the project data
DataModel overview
DataModel navigation overview
DMObjectsFinder overview
Filtering overview
Connections overview
MasterData ovierview
EObjects overview
Graphics overview
EPLAN properties
Project settings
Transactions
Locking
API Pro Panel
Creating 3D objects
Getting 3D objects
Transformations in 3D space
InstallationSpace
Component
Cabinet
MountingPanel
Plane
MountingRail
Area
Duct
PlaceHolder3D
Drilling
RoutingSegment
Connection3D
3D macros
ViewPlacement (model view in GUI)
Import/export 3D graphics
API Pre-planning
StructureSegment
SegmentDefinition
SegmentTemplate
PCTLoop
SegmentPlacement
Pre-planning macro
API Higher Electrotechnical services
Accessing selected objects
Displaying a preview
Placing window macros
API Electrotechnical services
Messages
Verifications
Interactions
API Miscellaneous
API Parts Selection Interface
API Parts Management Extension
How to display a MessageBox with the EPLAN window as owner
API Reports Modification Interface
API Labeling Modification Interface
Writing system messages
Throwing and catching exceptions
Trace output
Working with settings
Query user rights
Signing EPLAN assemblies
XMLProcessor
Command line parameters
API Reference
Assemblies
Eplan.EplApi.AFu Assembly
Eplan.EplApi.Baseu Assembly
Eplan.EplApi.DataModelu Assembly
Overview
Namespaces
Eplan.EplApi.DataModel Namespace
Overview
Classes
AbstractDMObjectFilter
AnyPropertyId
Article
Article.Accessory
Article.Assembly
Article.Module
ArticlePropertyList
ArticleReference
ArticleReferencePropertyList
ArticleReferencesFilter
Block
BlockPropertyList
BoxedDevice
CannotAddArticleException
Connection
Connection.Enums
ConnectionDefinitionPoint
ConnectionDefinitionPointPropertyList
ConnectionPointPosition
ConnectionPointsInfo
ConnectionPointsInfoPropertyList
ConnectionPropertyList
ConnectionsFilter
ContextPropertyPlacement
ContextPropertyPlacement.Enums
ContextPropertyPlacementPropertyList
CreatingConnectionDefinitionPointsFailedException
DataModelException
DeletedObjectInfo
DeletedObjectInfoPropertyList
DeviceGroup
DeviceGroupPropertyList
DeviceListEntry
DeviceListEntryPropertyList
DimensionGroup
DimensionGroup.Enums
DimensionGroupPropertyList
DisableConnectionUpdateStep
DMObjectsFinder
DocumentBase
DocumentBasePropertyList
DocumentTypeManager
DynamicConnectionLine
DynamicConnectionLinePropertyList
ElementFromWrongPageException
EmptyPropertyException
FixedDeviceException
ForbiddenOperationException
Function
Function.Enums
FunctionBase
FunctionBasePropertyList
FunctionDefinition
FunctionDefinitionPropertyList
FunctionPropertyList
Functions3DFilter
FunctionsFilter
Group
GroupPropertyList
ImageCopyException
IncompatibleDatabaseException
IncorrectNameFormatException
IncorrectObjectTypeException
IncorrectSymbolTypeException
IndexedPropertyException
InsufficientElementsCountException
InsufficientLicenceException
InternalQueryException
InterruptionPoint
InterruptionPointPropertyList
InterruptionPointsFilter
InvalidArgumentException
InvalidHandleException
InvalidIndexException
InvalidPageNameException
InvalidPageNameException_EmptyCounter
InvalidPageNameException_EmptyName
InvalidPageNameException_IncorrectParts
InvalidPageNameException_IncorrectSubcounter
InvalidTimeValueException
ITransaction
LicensingNotAvailableException
Location
LocationBox
LocationBoxPropertyList
LocationPropertyList
LockingExceptionFailedLockAttempt
LockingStep
Overview
LockingStep Constructor
Methods
Dispose Method
LockingVector
MacroBox
MacroBox.Enums
MacroBoxPropertyList
MacroMissingException
MacroVariantNotFoundException
MergedArticleReference
MergedArticleReferencePropertyList
MergedConnection
MergedConnectionPropertyList
MergedFunction
MergedFunctionPropertyList
NameConflictException
NetDefinitionPoint
NetDefinitionPointPropertyList
NoLockingStepException
NoPropertyListException
NoSuchPinException
NotIndexedPropertyException
NotLockedException
ObjectAlreadyCreatedException
ObjectCreationException
ObjectNotCreatedException
OperationCanceledException
OperationFailedException
Option
OptionBase
OptionBasePropertyList
OptionFragment
OptionFragmentPropertyList
OptionGroup
OptionGroupPropertyList
OptionPropertyList
Page
PagePropertyList
PagesFilter
PathInfo
PermissionException
Pin
PinBase
PipingDefinition
PipingDefinitionPropertyList
PlaceHolders3DFilter
PlaceHolderText
PlaceHolderText.Enums
PlaceHolderTextPropertyList
Placement
PlacementPropertyList
Placements3DFilter
PlacementsFilter
PlanningSegmentsFilter
PlcIO
PlcIOPropertyList
PLCMergedFunction
PotentialDefinition
PotentialDefinitionPropertyList
Project
Project.DeviceTagSettings
ProjectCantAddArticleReferenceException
ProjectCopyException
ProjectCreationException
ProjectEventsProvider
ProjectLockingException
ProjectManager
ProjectManager.DatabaseVersion
ProjectNeedsUpgradeException
ProjectNotFoundException
ProjectOpenException
ProjectPropertyList
ProjectSchemeSetting
ProjectSections
ProjectSections.Enums
ProjectSettingNode
ProjectSettings
Properties
PropertyAlreadyExistsException
PropertyDefinition
PropertyNotFoundException
PropertyReadOnlyException
PropertyTypesMismachException
PropertyValue
PropertyValueOutOfRangeException
RemoveFailedException
ReportBlock
ReportBlockReference
ReportBlockReferencePropertyList
SafetyPoint
SegmentDefinitionsFilter
SegmentPlacementsFilter
SegmentTemplatesFilter
SettingStepAlreadyOpenException
SettingValueFailedException
SnappingFailedException
StorableObject
StorableObjectContext
StorableObjectPropertyList
StorableObjectsFilter
StrandConnector
StrandConnectorPropertyList
StrandInterConnector
StrandInterConnectorPropertyList
SymbolLibraryOpeningFailedException
SymbolNotFoundException
SymbolReference
SymbolReference.GraphicalConnection
SymbolReference.PropertyPlacementsSchema
SymbolReference.PropertyPlacementsSchemasList
SymbolReference.Segment
SymbolReferencePropertyList
SymbolVariantNotFoundException
TerminalsToConnectionPointsMappingException
Transaction
TransactionManager
UndoManager
UndoStep
UniversalPropertyList
UserDefinedPropertyDefinition
UserDefinedPropertyDefinition.Enums
UserInfo
ViewPart
ViewPartPropertyList
WriteProtectionChangeNotAllowed
WriteProtectionNotSet
WrongCategoryException
WrongSegmentDefinitionException
Enumerations
Connection.Enums.KindOfWire
ConnectionCategory
ConnectionPointSide
ContextPropertyPlacement.Enums.BasePoint
DimensionGroup.Enums.DimensionType
DocumentTypeManager.DocumentType
Function.Enums.Category
Function.Enums.SearchDirection
IWriteProtection.WriteProtectionKind
MacroBox.Enums.InsertMacroBox
MacroBox.Enums.TakeConnectionPointDesignationsIntoAccount
MacroBox.Enums.TypeOfUsage
NetDefinitionPoint.NetbasedRoutingSymbols
Pin.ConnPointType
Pin.PortTypes
Pin.PotentialType
Pin.SignalType
PinBase.Directions
PlaceHolderText.Enums.GroupType
PlaceHolderText.Enums.Type
Placement.Visibility
Project.FunctionGroup
Project.Hierarchy
Project.LocationRelativePosition
Project.LocationSortOrder
Project.ProjectType
ProjectManager.CopyMode
ProjectManager.DatabaseVersion.Status
ProjectManager.OpenMode
ProjectSections.Enums.State
Properties.Arc
Properties.Article
Properties.ArticleReference
Properties.Block
Properties.BusBar
Properties.Cable
Properties.CommunicationEntity
Properties.Connection
Properties.Connection3D
Properties.ConnectionDefinitionPoint
Properties.ConnectionPointsInfo
Properties.CopperBundle
Properties.DeletedObjectInfo
Properties.DeviceListEntry
Properties.DimensionCircle
Properties.DimensionItem
Properties.Function
Properties.Function3D
Properties.FunctionBase
Properties.FunctionDefinitionLibrary
Properties.GraphicalPlacement
Properties.HyperLink
Properties.Image
Properties.InstallationSpace
Properties.InterruptionPoint
Properties.Line
Properties.Location
Properties.LocationBox
Properties.MacroBox
Properties.MergedArticleReference
Properties.Option
Properties.OptionFragment
Properties.OptionGroup
Properties.Page
Properties.PathText
Properties.PipingDefinition
Properties.PlaceHolder
Properties.Placement
Properties.Placement3D
Properties.PlanningSegment
Properties.PlcIO
Properties.PlotFrame
Properties.PlugStrip
Properties.PotentialDefinition
Properties.Project
Properties.Rectangle
Properties.RoutedConnection
Properties.Segment
Properties.SegmentDefinition
Properties.SegmentPlacement
Properties.SegmentTemplate
Properties.StorableObject
Properties.StrandConnector
Properties.Symbol
Properties.SymbolLibrary
Properties.SymbolReference
Properties.SymbolVariant
Properties.TerminalStrip
Properties.Text
Properties.TextBase
Properties.ViewPlacement
PropertyDefinition.PropertyType
RoutingDirections
SymbolReference.PointVariant
SymbolReference.PropertyPlacementType
UserDefinedPropertyDefinition.Enums.CategoryType
UserDefinedPropertyDefinition.Enums.ClientType
UserDefinedPropertyDefinition.Enums.InputAidType
Structures
Article.ArticleInfo
Relation
Interfaces
IArticleInfo
IArticleUser
ICustomFilter
IFunctionBase
IPlaceHolder
IWriteProtection
Delegates
ProjectEventsProvider.AnyChangeHandler
ProjectEventsProvider.ProjectChangeEventHandler
Eplan.EplApi.DataModel.ArticlePositions Namespace
Overview
Eplan.EplApi.DataModel.E3D Namespace
Overview
Classes
Area
AreaPropertyList
AuxiliaryLine
AuxiliaryLinePropertyList
BarBase
BarBasePropertyList
BusBar
BusBarPropertyList
BusBarSystem
BusBarSystemPropertyList
Cabinet
CabinetPropertyList
Component
ComponentPropertyList
Connection3D
Connection3D.Enums
Connection3DPropertyList
ContextPropertyPlacement3D
ContextPropertyPlacement3DPropertyList
CopperBundle
CopperBundlePropertyList
Drilling
DrillingPropertyList
Duct
DuctPropertyList
Function3D
Function3DPropertyList
InstallationSpace
InstallationSpacePropertyList
LineMate
Mate
Mate.Enums
Mesh
MountingPanel
MountingPanelPropertyList
MountingRail
MountingRailPropertyList
PlaceHolder3D
PlaceHolder3DPropertyList
Placement3D
Placement3D.Enums
Placement3DPropertyList
PlacementArea
Plane
PlaneMate
PlanePropertyList
PointMate
RoutingAccessory
RoutingAccessoryPropertyList
RoutingHose
RoutingHosePropertyList
RoutingSegment
RoutingSegmentPropertyList
RoutingSpline
RoutingSplinePropertyList
Enumerations
Connection3D.Enums.RoutingType
Mate.Enums.LogicalType
Mate.Enums.MateServiceErrorCodes
Mate.Enums.PlacementOptions
Mate.Enums.RotationType
Mate.Enums.Type
Placement3D.Enums.AdditionalType
Placement3D.Enums.PlaneModeType
Structures
InternalMateContainer
InternalMatePointer
Eplan.EplApi.DataModel.EObjects Namespace
Overview
Classes
BusTerminal
Cable
CablePropertyList
CablePropertyListComplete
Harness
PLC
Plug
PlugStrip
PlugStripPropertyList
PlugStripPropertyListComplete
Shield
Terminal
Terminal.Bridge
Terminal.Bridge.BridgeInfo
Terminal.ConnectionInfo
Terminal.TerminalStripCache
TerminalAccessory
TerminalStrip
TerminalStripPropertyList
TerminalStripPropertyListComplete
Enumerations
BusTerminal.BusSystemType
Terminal.Bridge.Kinds
Terminal.ConnectionSide
Eplan.EplApi.DataModel.Filters Namespace
Overview
Eplan.EplApi.DataModel.Graphics Namespace
Overview
Classes
Arc
Arc.Enums
ArcPropertyList
Color.Id
Comment
Comment.Enums
CommentPropertyList
ContactImage
ContactImage.Enums
DimensionCircle
DimensionCircle.Enums
DimensionCirclePropertyList
DimensionItem
DimensionItem.Enums
DimensionItemPropertyList
GraphicalLayer
GraphicalLayerTable
GraphicalPlacement
GraphicalPlacementPropertyList
HyperLink
HyperLinkPropertyList
Image
ImagePropertyList
Line
LinePropertyList
LockedMountingArea
LockedMountingAreaPropertyList
PathText
PathTextPropertyList
Pen
PlaceHolder
PlaceHolder.ValuesClass
PlaceHolder.ValueSetsClass
PlaceHolder.ValueSetsClass.ValueSetEnumerator
PlaceHolder.Variable
PlaceHolder.VariablesClass
PlaceHolder.VariablesClass.VariablesEnumerator
PlaceHolderPropertyList
PolyLine
PolyLinePropertyList
ProjectParserParameter
PropertyPlacement
PropertyPlacementPropertyList
Rectangle
RectanglePropertyList
Shielding
ShieldingPropertyList
Spline
SplinePropertyList
Text
TextBase
TextBase.FontInfo
TextBasePropertyList
TextPropertyList
TopologyLine
TopologyLinePropertyList
ViewPlacement
ViewPlacementPropertyList
Enumerations
Arc.Enums.Type
Comment.Enums.ReviewStateType
ContactImage.Enums.ContactImageType
ContactImage.Enums.DisplayMaskType
DimensionCircle.Enums.DimensionPrecision
DimensionCircle.Enums.DimensionUnit
DimensionItem.Enums.DimensionLineTermination
DimensionItem.Enums.DimensionPrecision
DimensionItem.Enums.DimensionType
DimensionItem.Enums.DimensionUnit
GraphicalLayer.AlignmentType
GraphicalPlacement.FillPatternType
PropertyPlacement.RelationType
PropertyPlacement.TextDockingStyle
TextBase.AlignmentBoxType
TextBase.JustificationType
TextBase.TextBoxType
TextBase.TextDockingDirection
TextBase.TextLanguageMode
ViewDirectionType
ViewPlacementType
ViewScaleType
ViewStyleType
Structures
Color
Eplan.EplApi.DataModel.Helpers Namespace
Overview
Classes
SettingPropertiesManager
SettingPropertiesStep
Eplan.EplApi.DataModel.MasterData Namespace
Overview
Classes
FunctionDefinitionEnumerator
FunctionDefinitionLibrary
FunctionDefinitionLibraryPropertyList
Macro
PageMacro
PageMacro.Enums
PlotFrame
PlotFramePropertyList
PrePlanningMacro
Symbol
SymbolLibrary
SymbolLibraryPropertyList
SymbolMacro
SymbolPropertyList
SymbolVariant
SymbolVariantPropertyList
WindowMacro
WindowMacro.Enums
Enumerations
PageMacro.Enums.NumerationMode
Symbol.SymbolType
WindowMacro.Enums.NumerationMode
WindowMacro.Enums.RepresentationType
Eplan.EplApi.DataModel.Planning Namespace
Overview
Classes
PCTLoop
PCTLoopFunction
PCTLoopFunctionPropertyList
PCTLoopPropertyList
PlanningObject
PlanningObject.MacroPlaceHolderValueSet
PlanningObject.MacroPlaceHolderValueSetsClass
PlanningObject.MacroPlaceHolderValueSetsClass.MacroPlaceHolderValueSetsEnumerator
PlanningObjectPropertyList
PlanningSegment
PlanningSegment.PLCAddress
PlanningSegment.PLCAddress.Enums
PlanningSegmentPropertyList
PropertyConfiguration
SegmentDefinition
SegmentDefinitionPropertyList
SegmentPlacement
SegmentPlacementPropertyList
SegmentTemplate
SegmentTemplatePropertyList
StructureSegment
StructureSegmentPropertyList
Vessel
VesselPropertyList
Enumerations
PlanningSegment.PLCAddress.Enums.PlcAddressDirection
Eplan.EplApi.DataModel.Revisions Namespace
Overview
Classes
Comparison
ComparisonEntry
ComparisonEntryDetail
Enumerations
ComparisonEntry.StateType
Eplan.EplApi.DataModel.Topology Namespace
Overview
Classes
RoutedConnection
RoutedConnectionPropertyList
Segment
SegmentPropertyList
Eplan.EplApi.EServicesu Assembly
Eplan.EplApi.Guiu Assembly
Eplan.EplApi.HEServicesu Assembly
Eplan.EplApi.MasterDatau Assembly
Eplan.EplApi.RemoteClientu Assembly
Eplan.EplApi.Remotingu Assembly
Eplan.EplApi.Starteru Assembly
Eplan.EplApi.Systemu Assembly
Actions
backup
changelayer
check
compress
CopyToolBarAction
devicelist
E21EasyImportSettingAction
edit
EsCorrectConnections
EplApiModuleAction
ExecuteScript
export
export3d
ExportNCData
ExportProductionWiring
ExportSegmentsTemplate
exportToGraphics
gedRedraw
generate
generatemacros
graphicallayertable
import
InsertModelViewAction
ImportPrePlanningData
ImportSegmentsTemplate
label
masterdata
MfExportToolbarAction
MfImportToolbarAction
MfRemoveToolbarAction
OpenWorkspaceAction
partslist
plcservice
print
ProjectAction
projectmanagement
ProjectOpen
RegisterCustomPropertyEditorAction
RegisterScript
renumber
reports
restore
SaveWorkspaceAction
search
selectionset
SetProjectLanguage
SpExportSubProject
SpImportSubProject
SwitchProjectType
synchronize
Topology
translate
UnregisterScript
UpdateSegmentsFilling
XAfActionSetting
XAfActionSettingProject
XCMRemoveUnnecessaryNDPsAction
XCMUniteNetDefinitionPointsAction
XDLInsertDeviceAction
XEGActionInsertSymRef
XEsSetPagePropertyAction
XEsSetProjectPropertyAction
XEsSetPropertyAction
XEsUserPropertiesExportAction
XEsUserPropertiesImportAction
XGedClosePage
XGedStartInteractionAction
XGedUpdateMacroAction
XMActionDCImport
XMActionDCCommonExport
XMDeleteReprTypeAction
XMExportConnectionsAction
XMExportFunctionAction
XMExportPagesAction
XPamSelectPart
XSDPreviewAction
XPamsDeviceSelectionAction
XPlaUpdateDetailAction
XPrjActionUpgradeProjects
XSettingsExport
XSettingsImport
Events
Eplan.EplApi.OnMainEnd
Eplan.EplApi.OnMainStart
Eplan.EplApi.OnPostOpenProject
Eplan.EplApi.OnUserPreCloseProject
onActionEnd.String.*
onActionStart.String.*
Ged.Redraw
NCSettingsMachineTools.Redraw
Page.ConnectionDirty
Project.CablingDirty
RefreshPageFilter
Interactions
XGedIaFormatDefPoints
XGedIaFormatGraphic
XGedIaFormatSymbol
XGedIaFormatText
XMIaInsertMacro
XML Converters
Category DeviceListXmlConverter
XDLCsvCommaSepImporterExporter
XDLCsvImporterExporter
XDLTxtImporterExporter
XDLXmlExporter
Category LanguageDbXmlConverter
XTrLanguageDbXml2E21UnicodeTabConverter
XTrLanguageDbXml2TabConverterImpl
Category PartsListXmlConverter
XPalCSVConverter
XPalXmlExporter
Category XPamExport
IXPartsImportExportEdz
XPamExportXml
Category XPamImport
XPamImportXml
Category PLCXmlConverter
PlcDcExchangerMitsubishiAML
PlcDcExchangerSiemensTIAAML
PlcDcXMLExchangerABB
PlcDcXMLExchangerBandR
PlcDcXMLExchangerBeckhoff
PlcDcXMLExchangerCodesys
PlcDcXMLExchangerLogiCals
PlcDcXMLExchangerMitsubishi
PlcDcXmlExchangerRexroth
PlcDCXmlExchangerSchneider
PlcDcXMLExchangerSiemens
PlcDcXMLExchangerUniversal
XMLRockwellExchanger
Dispose() Method
In This Topic
Syntax
See Also
Ends a locking step (identified by internal nLockingStepId). ManualLocking mode is set to its previous value; Original locking state is restored. The same as !LockingStep.
Syntax
C#
C++/CLI
public
void
Dispose()
public
:
void
Dispose();
See Also
Reference
LockingStep Class
LockingStep Members
