New Features for Eplan API

Area Description

New API offered in parallel on the basis of .NET 8

In parallel to the previous API based on .Net Framework 4.8.1, a new API based on .NET 8 is now available for Eplan. This way the Eplan API can now also be used in .NET core applications.

The scripts in Eplan now only use .NET 8, as well as the current C# language standard (C# 13).

Class (API)

New class for mounting grids

By means of the new GridMate class it is now possible to generate mounting grids via Eplan API and to retrieve information about existing mounting grids.

Methods (API)

Updating all reports of a project

The Reports method is now available in the Update(project) class to exclusively update all existing reports of a project via the Eplan API. Analog to this the reports action for the parameter TYPE has been extended by the new value UPDATEPROJECT.

Methods (API)

Exporting parts with referenced data

The new MDPartsDatabase method is now available in the ExportPartsToEdz class. This allows the referenced data to be exported completely during the EDZ export of parts data. In the user interface this corresponds to the Export referenced data completely check box of the EDZ export options dialog.

Properties (API)

Activating the "Update using this form" setting via the Eplan API

A report block can be updated with a specific form. By means of the new UpdateUsingThisForm property from the ReportBlock class you can now specify via Eplan API whether a report block is updated with a specific form or not. In the user interface, this corresponds to the Update using this form check box.

Methods (API)

Deleting revision data of the property comparison

By means of the new RemovePropertyComparisionData method from the Revision class it is now possible to delete the revision data from a property comparison via Eplan API.

Methods (API)

Generating functions using a numbering pattern

The new CreateFunctions method is now available in the DeviceService class. By means of this method you can - as in the Generate functions dialog - generate several unplaced functions for a new or existing DT according to a specific numbering pattern.

Properties (API)

New property for the values of variables in placeholder objects

To determine the currently set value of a variable in a selected value set of a placeholder object, the new CurrentVariableValue property is now available in the Placeholder class. This way the changed value of a user-defined value set can also be determined.

Methods (API)

Creating projects and opening in standard mode

During the creation of projects from a basic project by means of the CreateProject method from the ProjectManager class, the created project was previously always opened exclusively. Now there is an overload of the method with which you can also open the created project in the standard mode.

Properties (API)

Creating large buttons in the ribbon

You can now also create large buttons for the ribbon by means of the Eplan API. To this purpose, the RibbonIcon class has been extended, for example, by the optional IsLarge property.

Properties (API)

Creating drop-down buttons in the ribbon

You can now also create drop-down buttons for the ribbon by means of the Eplan API. In the process you can specify whether the button itself is to perform an action or only opens a drop-down list with commands. To this purpose, the RibbonCommandInfo class has been extended, for example, by the optional IsDropdownRoot and IsSplitButton properties.

Properties (API)

Determining placeholder value sets of pre-planning segments

If placeholder objects from associated macros are considered in the pre-planning, only the placeholder value sets at planning objects (PlanningObject) could be determined via the MacroPlaceHolderValueSets property by means of Eplan API in the past. By means of the new MacroPlaceHolders property from the PlanningSegment class, the placeholder value sets can now also determined at the pre-planning segments (PlanningSegment), PCT loops (PCTLoop) and PCT loop functions (PCTLoopFunction). The PlanningSegment class is the base class of the previously used PlanningObject class. In the course of this new feature the previous MacroPlaceHolderValueSets property has been identified as outdated.

Methods (API)

Adding a handle to grouped 3D items

It is now possible to add a handle to grouped 3D items via the Eplan API. To this purpose. you use the Create method from the HandleMate class to define a new handle and assign this handle to the group by means of the AddMate method from the Group3D class.

Methods (API)

Delete user-defined properties not to be used anymore

Two new methods have been added so that the properties that are no longer to be used can also be removed for user-defined properties via Eplan API. For the deletion of project-specific and part-specific user-defined properties the Project and MDPartsDatabase classes have respectively been extended by the new RemoveUnusedUserPropertyDefinitions method.

Methods (API)

New method for routing connections

There is a new overload for the RouteConnections method from the ConnectionService3D class. You can now specify by means of the routingType parameter whether the specified 3D routing connections are to be routed through cable ducts or freely.

Methods (API)

New method for the export of manufacturing data for the Rittal - RiPanel Processing Center

In the Export3D class, the new ExportForRittalRiPanelProcCtr method is now available in order to export manufacturing data for the machining of enclosures in the form of an AML file for the Rittal - RiPanel Processing Center.

Properties (API)

New property for subordinate segment templates

By means of the new SubordinateSegmentTemplates property from the SegmentTemplate class, you can now also assign subordinate segment templates to a segment template by means of the Eplan API or determine the subordinate segment templates added to a segment template.

Cross-references

Using additional representation types in the Eplan API

The new additional representation types "Additional representation: Multi-line schematic", "Additional representation: Fluid power schematic" and "Additional representation: P&I diagram" are now available in Eplan. The following options have been added to the DocumentTypeManager.DocumentType list so that these representation types can also be used in the Eplan API:

  • PairCrossReferenceElectric (Value -14)
  • PairCrossReferenceFluid (Value -15)
  • PairCrossReferenceProcessAndInstrumentation (Value -16)
Methods (API)

New method for placing items in the layout space

It is now also possible to place complex items from the mounting layout navigator in a layout space by means of the new methods Place and PlaceAssembly from the Placement3D class.

Methods (API)

Bundle connections specifically

By means of an overload of the BundleConnections method from the ConnectionService3D_ class you can now specify exactly which 3D connections are bundled. This new feature is available as of Version 2026 Update5.