Eplan Platform API
Eplan.EplApi.Base Namespace
/
IEplProgress Interface
/ CancelPressed 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 ribbon items 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 ribbon commands
Add-ons
Structure
Registration
Unregistration
Shadow Copying
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
Orientation of 3d objects
Transformations in 3D space
Mates
InstallationSpace
Component
Cabinet
MountingPanel
Plane
MountingRail
Area
Duct
PlaceHolder3D
Drilling
RoutingSegment
Connection3D
3D macros
ViewPlacement (model view in GUI)
Import/export 3D graphics
BusBar BusBarSystem
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 MasterData
Working with parts database
Basic operations on parts
Filtering parts database items
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
Ribbon bar
Trace output
Working with settings
Query user rights
Signing EPLAN assemblies
XMLProcessor
Command line parameters
IdentityClient
API Reference
Assemblies
Eplan.EplApi.AFu Assembly
Eplan.EplApi.Baseu Assembly
Overview
Namespaces
Eplan.EplApi.Base Namespace
Overview
Classes
BaseException
Context
ContextParameterBlock
Decider
EplAssert
EplTrace
FileSelectDecisionContext
ISOCode
LanguageList
Languages
ListSelectDecisionContext
LockingException
MultiLangString
ParserParameter
PathMap
Progress
ProgressFactory
Range
SchemeSetting
SettingNode
Settings
SysMessagesCollection
SysMessagesEnumerator
TraceListener
UnitParser
Enumerations
EnumDecisionIcon
EnumDecisionReturn
EnumDecisionType
ISettings.CreationFlag
ISettings.SettingType
ISOCode.Language
MessageLevel
Unit
UnitGroup
Structures
PointD
PointD3D
RectangleD
Interfaces
IContext
IEplProgress
Overview
Methods
BeginPartCalled Method
CancelPressed Method
CreateProgressWindow Method
DestroyProgressWindow Method
EndPartCalled Method
GetLevelCount Method
GetTitle Method
OnRegister Method
ResetCanceled Method
SetActionText Method
SetAllowCancel Method
SetOverallActionText Method
SetProgressStep Method
SetTitle Method
ISettings
Eplan.EplApi.Base.Enums Namespace
Overview
Enumerations
BusSystemType
FunctionCategory
ItemType
PinPotentialType
Eplan.EplApi.DataModelu Assembly
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
Eplan.IdentityClient.Authentification Assembly
Eplan.IdentityClient.Types Assembly
Actions
backup
changelayer
check
CleanWorkspaceAction
compress
devicelist
edit
EplApiModuleAction
EsCorrectConnections
ExecuteScript
export
export3d
ExportNCData
ExportProductionWiring
ExportSegmentsTemplate
exportToGraphics
gedRedraw
generate
generatemacros
graphicallayertable
import
ImportPrePlanningData
ImportSegmentsTemplate
InsertModelViewAction
label
masterdata
MfExportRibbonBarAction
MfImportRibbonBarAction
MfToggleMainMenuAction
navigateToEEC
OpenWorkspaceAction
partslist
partsmanagementapi
plcservice
preparemacros
print
ProjectAction
projectmanagement
ProjectOpen
RegisterCustomPropertyEditorAction
RegisterScript
renumber
reports
restore
SaveWorkspaceAction
search
selectionset
SetProjectLanguage
subprojects
SwitchProjectType
synchronize
Topology
translate
UnregisterScript
UpdateSegmentsFilling
XAfActionSetting
XAfActionSettingProject
XAMlExportProductionData2RASCenterAction
XCMRemoveUnnecessaryNDPsAction
XCMUniteNetDefinitionPointsAction
XDLInsertDeviceAction
XEGActionInsertSymRef
XEsGetPagePropertyAction
XEsGetProjectPropertyAction
XEsGetPropertyAction
XEsSetPagePropertyAction
XEsSetProjectPropertyAction
XEsSetPropertyAction
XEsUserPropertiesExportAction
XEsUserPropertiesImportAction
XGedClosePage
XGedStartInteractionAction
XGedUpdateMacroAction
XMActionDCCommonExport
XMActionDCImport
XMDeleteReprTypeAction
XMExportConnectionsAction
XMExportDCArticleDataAction
XMExportFunctionAction
XMExportLocationBoxesAction
XMExportPagesAction
XMExportPipeLineDefsAction
XMExportPotentialDefsAction
XMImportDCArticleDataAction
XPamArticlesSyncAction
XPamConvertPartDatabaseToArticleDatabaseAction
XPamsDeviceSelectionAction
XPamSelectPart
XPartsSetDataSourceAction
XPlaUpdateDetailAction
XPrjActionUpgradeProjects
XPrjConvertBaseProjectsAction
XSDPreviewAction
XSettingsExport
XSettingsImport
XSettingsRegisterAction
XSettingsUnregisterAction
Events
Eplan.EplApi.OnMainEnd
Eplan.EplApi.OnMainStart
Eplan.EplApi.OnPostOpenProject
Eplan.EplApi.OnResetRibbon
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
PlcDcAMLExchangerGeneral
PlcDcExchangerBeckhoffTC3AML
PlcDcExchangerBoschAML
PlcDcExchangerLogiCals3AML
PlcDcExchangerMitsubishiAML
PlcDcExchangerMitsubishi110AML
PlcDcExchangerPhoenixContactAML
PlcDcExchangerRockwellArchitectAML
PlcDcExchangerSiemensTIA15AML
PlcDcExchangerSiemensTIA16AML
PlcDcExchangerSiemensTIA17AML
PlcDcExchangerSiemensTIA151AML
PlcDcExchangerSiemensTSTAML
PlcDcXMLExchangerABB
PlcDcXMLExchangerBandR
PlcDcXmlExchangerRexroth
PlcDCXmlExchangerSchneider
PlcDcXMLExchangerSiemens
PlcDcXMLExchangerUniversal
XmlLblXmlExportConverterImpl
CancelPressed Method
In This Topic
Syntax
See Also
Return true when the user pressed the cancel button
Syntax
C#
C++/CLI
bool
CancelPressed()
bool
CancelPressed();
See Also
Reference
IEplProgress Interface
IEplProgress Members
