Eplan Platform API
Inheritance Hierarchy
In This Topic
    Eplan.EplApi.Base Namespace
    In This Topic
    This namespace exposes base functionality of EPLAN, like a base class for exceptions, and classes to access the EPLAN settings.
    ClassException class derived from ApplicationException. This is the base class for the exceptions that might occur in the API.
    ClassThe Context classes are used to pass information about the current state of the environment as well as generic parameters to objects that can be registered such as actions, dialogs, etc.
    ClassA Parameter block for a context. This parameterblock can have System::Object^ as parameters. This block can be used to add objects to a context and work with this objects p.e. inside an action.
    ClassThis class implements the standard EPLAN decider dialog.
    ClassThe EplAssert class. When the advaced mode is activated in ELogFileConfigTool, Asserts are written to the epllog.txt Its also possible to activate a debugger break. Set the registry value User / Software / Eplan / Eplan W3 / Assert / BreakOnAssert to true, and the debugger will stop at a failed assert.
    ClassTrace the output to the EplLog.txt file. This Trace class works in debug and release mode, while the trace listener works only in debug mode. Traces are written when the registry key HKCU / Software / Eplan / Eplan W3 / Trace / \-ModuleName- is found.
    ClassThis class can be used for an standard eplan decider
    ClassClass for managing language codes (abbreviations). MultiLangString can handle these languages.
    ClassClass for managing a list of languages.
    ClassClass for language information.
    ClassThis class can be used for a standard Eplan decider
    ClassException class that signals locking errors in DataModel.
    ClassThis class can save strings in various languages at the same time. Each string can be added, queried, and deleted individually.
    ClassParameter Class for the usage with UnitParser. Configure the unit and the look of the Parser result.
    ClassThis class enables you access to the functions used for processing strings that could contain EPLAN path variables.
    ClassThis class enables you to access the functions of the progress bar in EPLAN.
    ClassThis class can be used for OfflineApplications. With RegisterProgress a progress can be installed in Eplan. UnregisterProgress removes this progress from Eplan again.
    ClassRange of setting values
    ClassClass for editing settings that are grouped into schemes
    ClassAllows access to settings and relative access to setting-nodes. A setting key consists of a number of sections separated by '.' Each section except the last one is called a setting-node. Setting-nodes and settings together build the settings tree. The settings are the leaves of this tree. The SettingNode class helps iterating trough the nodes and e.g. gives you the possibility to delete a node completely.
    ClassSettings are used to save values of variables beyond the runtime of the program and to make them available again the next time program is run (similar to the Windows registry). A setting has a unique identifier in the system. A value or a list of values can be saved to a setting. It is possible to group settings into structures SchemeSetting.
    ClassClass that represents the system-wide message tree. The collection contains the system messages as BaseException objects.
    Classsupports a simple iteration over SysMessagesCollection
    ClassOutput of trace messages to the EPLAN system message management (incl. EPLAN log file)
    ClassThe UnitParser class. Here it is possible to read the unit from a string and convert it in other units (of the same unit group)
    InterfaceIContext is an abstract interface for Context classes.
    InterfaceInterface declaration for a progress. When a progress is to be registered for an add-in (an assembly) in the system, this interface must be implemented by a class of the add-in.
    InterfaceThe common interface to P8 settings.
    StructureThis class represents a set of coordinates in EPLAN.
    StructureThis class represents a set of 3D coordinates in EPLAN.
    StructureThis class specifies an area in a coordinate space.
    EnumerationUsed by the Decider, to determine which icon is to be shown.
    EnumerationThis enum is returned by the Decider method.
    EnumerationThe type one setting can hold data in.
    EnumerationCreation flag
    EnumerationThe type one setting can hold data in.
    EnumerationMultiLangString can handle these languages.
    EnumerationSeverity of the error
    EnumerationA unit. Every unit enum starts with the group name.
    EnumerationThe group of one unit. Conversion is only possible inside groups
    See Also