Eplan.EplApi.ApplicationFramework Namespace
In This Topic
This namespace provides all necessary functionality to integrate API add-ins into EPLAN, to react on events and to work with actions.
Classes
| | Class | Description |
|---|
 | Action | An action performs a task in the system. It is usually called via ribbon items or the CallingActions. \Parameters can be passed to the action in a context class, and return values can be obtained with this parameter. Actions are implemented in an add-in by deriving a class from IEplAction. |
| ActionCallingContext | This is the ActionCallingContext class used to pass \parameters to an action and to receive return values of the action. This is the ActionCallingContext class used to pass \parameters to an action and to receive return values of the action. |
| ActionManager | Class for retrieving Action objects |
| ActionParameterProperties | Description of a parameter that can be passed to an ActionCallingContext. This class only serves for documentation purposes. |
| ActionProperties | This class returns a description text and a list of the parameters that can be passed as context parameters. |
| BatchActionManager | Class for executing a batch action |
| CommandLineInterpreter | Class for executing commands in command-line style. |
| EventHandler | Base class to handle events. |
| EventHandlerWrapper | Event handler to process EPLAN events in a remoting client. It is not possible to directly use the EventHandler in a remoting client! |
| EventManager | Class for sending events. |
| EventParameter | Base class for event parameters |
| EventParameterString | Event parameter of the System::String data type |
| License | Class for querying EPLAN licensing options (LicenseOptions). |
| QuietModeStep | Allows setting quiet mode for a part of code |
| UserRights | Class for checking execute permissions. In the rights management module, you can assign execute permissions to individual actions. These execute permissions are also assigned to specific users. As a result, the rights management system can decide whether the logged-on user has the right to perform a specific action. The rights management system can be completely disabled CheckUserRights, or it can be set to a specific operating mode (logging on with the current windows user). However, this operating mode cannot be queried or set via API. |
Interfaces
| | Interface | Description |
|---|
 | IActionCallingContext | Interface class for the ActionCallingContext class. Can be used instead of the class in function parameters.Interface class for the ActionCallingContext class. Can be used instead of the class in function parameters. |
| ICommandLineInterpreter | For internal use only. A fixed interface ID is specified which is used to generate this interface in W3u.exe. This ID is specified in the source code and cannot be changed. |
| IEplAction | Interface declaration for an action. When an action 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. |
| IEplActionBatchExtension | |
| IEplActionChecked | Interface to switch the status on / off of an Action. If this interface is not used, the Action is off by default. If you implement this interface in an action class, you can set the state of the respective Action to on. If 0, unchecks; if 1, checks; and if 2, sets indeterminate. |
| IEplActionEnable | Interface to enable or disable an Action. If this interface is not used, the Action is enabled by default. If you implement this interface in an action class, you can set the respective Action to disabled. If a ribbon item points to this Action, they will be also disabled (grayed out). |
| IEplAddIn | Interface declaration for an EPLAN add-in. If an assembly is to be loaded as an EPLAN add-in, exactly one class of the assembly must implement this interface. |
| IEplAddInShadowCopy | Provides a mechanism for framework to pass information about original location of the add-in assembly. |
| IEplanEvents | Declaration of the interface for EPLAN events. |
| IEplanEventsWrapper | For internal use only. |
| IEventParameter | Base interface declaration for event parameters |
| IExtendedProcessor | Interface for implementing an extended processor in connection with the IXMLProcessor. |
| IInterface | A type implementing this interface can be registered as an EPLAN interface. |
| IOptions | If a class implements this interface, a settings dialog can be assigned to the XML processor. |
| IXMLProcessor | Interface for implementing an XML processor. |
Delegates
Enumerations
| | Enumeration | Description |
|---|
 | LicenseOptions | License options provided by the EPLAN licensing system. |
| LicenseType | License type: local, network (remote) or borrowed |
| ProjectOpenRequirement | Interface to make an action batchable on a server. This action requires the project in one of the following mode. |
| QuietModes | Quiet modes |
See Also
