EPLAN 21 API Command Reference


1. Contents


2. Command Reference

This reference contains all the commands that are available for the EPLAN 21 API.

Add-ins

Commands used for the registration of add-ins, their menu items, as well as for the access to the current selection.

EPLAN.EPLAN21.ADDIN.REGISTER

Command for creating menu items for an add-in.

EPLAN.EPLAN21.SELECTION

Command for querying the current selection.


Administration

Commands used for the management and maintenance of EPLAN 21.

EPLAN.EPLAN21.PAGE.CHECK

Command for checking a schematic page.

EPLAN.EPLAN21.PROJECT.CHECK

Command for checking a project.

EPLAN.EPLAN21.CIRCUIT.COMPRESS

Command for compressing a project or macro.


Database

Commands for managing EPLAN 21 databases (working sets).

EPLAN.EPLAN21.DATABASE.CREATE

Creates a new EPLAN 21 main database (working set).

EPLAN.EPLAN21.DATABASE.OPEN

Opens an existing EPLAN 21 working set together with all databases belonging to this working set: main, sub-, macro and resource databases.

EPLAN.EPLAN21.DATABASE.CLOSE

Closes the open working set together with all associated databases.

EPLAN.EPLAN21.DATABASE.CREATE_SLAVE

Creates a new EPLAN 21 subdatabase and connects it to an already open working set.

EPLAN.EPLAN21.DATABASE.OPEN_SLAVE

Opens an existing EPLAN 21 subdatabase and connects it to an already open working set.

EPLAN.EPLAN21.DATABASE.CLOSE_SLAVE

Breaks the connection between an open EPLAN 21 subdatabase and an open working set and closes the project subdatabase.

EPLAN.EPLAN21.DATABASE.LOCK

Locks an already opened main or subdatabase for exclusive use. The database is closed and then re-opened with write access.

EPLAN.EPLAN21.DATABASE.UNLOCK

Unlocks the already opened main or subdatabase that was locked for exclusive use. The database is closed and then re-opened with write-protection.

EPLAN.EPLAN21.WORKINGSET.MERGE

Creates a new working set out of an already opened working set. The new working set only consists of one project in a main database.

EPLAN.EPLAN21.DATABASE.IMPORT

Imports a working-set definition file and creates a new working set in the process.

EPLAN.EPLAN21.DATABASE.COMPRESS

Compresses an EPLAN 21 project database.


Foreign Languages

Commands for accessing functions and settings of the foreign language module of EPLAN 21.

EPLAN.EPLAN21.TRANSLATE.OFFLINE

Starts an offline translation of the defined objects.

EPLAN.EPLAN21.DISPLAY_LANGUAGES

Command for setting and/or querying the displayed languages.

EPLAN.EPLAN21.DISPLAY_LANGUAGES.REMOVE

Command for removing languages from the list of displayed languages.

EPLAN.EPLAN21.DESTINATION_LANGUAGES

Command for setting and/or querying the languages to be translated.

EPLAN.EPLAN21.DESTINATION_LANGUAGES.REMOVE

Command for removing languages from the list of the languages to be translated.


Import / Export

Commands for importing and exporting EPLAN 21 objects in various formats.

EPLAN.EPLAN21.EASY.IMPORT

Imports EASY files and returns a handle to the new object.

EPLAN.EPLAN21.EASY.EXPORT

Exports master data or projects into the easy file format.

EPLAN.EPLAN21.DWG_EXTERN.EXPORT

Exports pages and projects into the AutoCAD DWG format.

EPLAN.EPLAN21.DXF.EXPORT

Exports pages and projects into the AutoCAD DXF format.


Archive

Commands for reading archive information.

EPLAN.EPLAN21.ARCHIVE.BACKUP

Backs up projects and their dependencies into an archive.

EPLAN.EPLAN21.ARCHIVE.RESTORE

Restores a previously performed data backup.

EPLAN.EPLAN21.ARCHIVE.READ_INFO

Reads the information associated with an archive.

EPLAN.EPLAN21.ARCHIVE.READ_PROJECTFILES

Reads the project dependencies in an EPLAN archive.


Output

Commands for outputting pages in a window or to the printer.

EPLAN.EPLAN21.OUTPUT_ON

Outputs a page, a frame, or a form in a window.

EPLAN.EPLAN21.PRINT

Outputs a page to a printer.


Communication

Commands for communicating between add-ins, EPLAN 21 commands etc.

EPLAN.EPLAN21.NOTIFICATION.SEND

Command for sending a notification to all notification handlers, that are registered for a notification of the same name. The notification can be sent with any parameters.


Licensing

EPLAN.EPLAN21.LICENSE

Command for licensing the API.


Generation

Commands used for the generation of data.

EPLAN.EPLAN21.FORMGEN.GENERATE_PAGE

Command for generating pages with the Form generator.

EPLAN.EPLAN21.FORMGEN.GENERATE_FILE

Command for generating files with the Form generator.

EPLAN.EPLAN21.FORMGEN.REGENERATE

Command for updating generation runs with the Form generator.


Numbering

Commands for renumbering wires or device tags.

EPLAN.EPLAN21.DT.RENUMBER

Command for the numbering of device tags.

EPLAN.EPLAN21.WIRENUMBERING.CIRCUIT

Command for the numbering of wires.

EPLAN.EPLAN21.WIRENUMBERING.BUILDCONFIG

Command for creating configurations for wire numbering.


General

Commands that can be used for different objects of the data model.

EPLAN.EPLAN21.OBJECT.DELETE

Command for deleting objects.

EPLAN.EPLAN21.ELEMENT.CREATE_AND_INSTANTIATE

Command for generating schematic elements.


Project Data

Commands that can be used for the project data of a project.

EPLAN.EPLAN21.TERMINALSTRIP.CREATE

Command for generating terminal strips.

EPLAN.EPLAN21.PLUG.CREATE

Command for generating entire plugs.

EPLAN.EPLAN21.POTENTIALDEFINITION.CREATE

Command for generating potential definitions.

EPLAN.EPLAN21.INTERRUPTIONPOINT.CREATE

Command for generating interruption points.


Parts

Commands for creating and deleting parts.

EPLAN.EPLAN21.PART.CREATE

Command for creating a part.

EPLAN.EPLAN21.PART.DELETE

Command for deleting a part.

EPLAN.EPLAN21.PART_SYMBOL.INSERT

This command inserts a part symbol into a page.

EPLAN.EPLAN21.PART_SYMBOL.REGENERATE

This command updates mounting-panel pages.

EPLAN.EPLAN21.PART_SYMBOL.UPDATE

This command updates a part symbol (on a mounting panel).


devices

Commands for inserting and creating devices.

EPLAN.EPLAN21.COMPONENT.CREATE

Command for creating a device on a page.

EPLAN.EPLAN21.DEVICE.CREATE

Command for creating an empty device.


Wires

Commands for inserting and creating wires.

EPLAN.EPLAN21.WIRE.CREATE

Command for creating a wire in a network.


Graphical Elements & Texts

Commands for creating graphical elements and texts.

EPLAN.EPLAN21.ARC.CREATE

Command for creating an arc on a page.

EPLAN.EPLAN21.CIRCLE.CREATE

Command for creating a circle on a page.

EPLAN.EPLAN21.ELLIPSE.CREATE

Command for creating an ellipse on a page.

EPLAN.EPLAN21.LINE.CREATE

Command for creating a line on a page.

EPLAN.EPLAN21.PIE.CREATE

Command for creating an arc sector on a page.

EPLAN.EPLAN21.RECTANGLE.CREATE

Command for creating a rectangle on a page.

EPLAN.EPLAN21.SQUARE.CREATE

Command for creating a square on a page.

EPLAN.EPLAN21.TEXT.CREATE

Command for creating a text object on a page.

EPLAN.EPLAN21.DIMENSION.CREATE

Command for creating a dimensioning line.

EPLAN.EPLAN21.DATA.CREATE

Command for creating a data object.

EPLAN.EPLAN21.GROUP.CREATE

Command for creating a group.

EPLAN.EPLAN21.GROUP.DEGROUP

Command for degrouping a group.

EPLAN.EPLAN21.GROUP.DEEPDEGROUP

Command for completely degrouping a group.


Macros

Commands for inserting and creating macros.

EPLAN.EPLAN21.MACRO.REPLACEPROPS

Command for replacing a string in a macro.

EPLAN.EPLAN21.MACRO.COPY

Command for creating a temporary macro.

EPLAN.EPLAN21.MACRO.INSERT

Command for inserting a macro.

EPLAN.EPLAN21.DB_MACRO.INSERT

Command for inserting a macro from the database.

EPLAN.EPLAN21.FILE_MACRO.INSERT

Command for inserting a macro from file.

EPLAN.EPLAN21.MACRO.DXF_IMPORT

Command for importing a DXF file as macro.


Pages

Commands for inserting, creating, and editing pages.

EPLAN.EPLAN21.PAGE.CREATE

Command for creating a new page in the project.


Plot frames

Commands for editing plot frames.


Projects

Commands for inserting, creating, and editing projects.

EPLAN.EPLAN21.PROJECT.CREATE

Command for creating a new project in the database.

EPLAN.EPLAN21.REVISION.CREATE

Generates a project revision.

EPLAN.EPLAN21.REVISION.COMPARE

Compares two project revisions.

EPLAN.EPLAN21.REVISION.WRITE_BACK

Command for writing the results or the revision comparison back into the project.

EPLAN.EPLAN21.PROJECT.CLEAR_MARKERS

Removes the revision marker from the project.



Other Commands

Commands that do not fit into any of the other categories or that have not been categorized yet.

EPLAN.EPLAN21.LOGIN

Allows for switching the current user group. The user groups known in the system can be determined via the EPL_ITERATOR_ROLES iterator.

EPLAN.EPLAN21.TEMPORARY_PROPERTY.CREATE

Generates a temporary property.