API Help
Inheritance Hierarchy
In This Topic
    Eplan.EplApi.HEServices Namespace
    In This Topic
    The higher electrotechnical services (HEServices) provide access to all the higher functionality of EPLAN, which is not directly connected to the data model. There are classes for backing up projects and master data, for creating reports, or for printing. A lot of modules of EPLAN are represented in this namespace, like the labeling module and the parts management.
    Classes
     ClassDescription
    ClassThis class provides functions for the data backup. Following example shows how to use Backup class.
    ClassClass providing functionality for cables: numbering, automatic cable selection, generate cable automatically, delete automatically generated cables and add up cable length.
    ClassThis class contains methods for activating and deactivating change info handling.
    ClassThis class is used to switch back mode.
    ClassClass for checking projects or pages.
    ClassClass providing connection functionality: Placing , designating, re-aligning, re-formatting, and deleting connection definition points.
    ClassClass providing functionality to work with 3d connections.
    ClassClass for converting coordinate systems
    ClassClass providing functionality for managing devices.
    ClassThis class provides information about the templates associated with a specific part number contained in the device list. Objects of this class are returned by DeviceService::GetTemplatesFromDeviceList method.
    ClassThis class allows the user to create previews of macros and other DataModel objects.
    ClassClass to open pages in the graphics editor for editing.
    ClassClass to help with working on 3D objects in the graphics editor.
    ClassClass for exporting projects and project data to various formats. The following example shows how to use class Export.
    ClassClass for exporting 3d objects to various formats.
    ClassClass for updating connections and cables
    ClassClass providing harness functionalities such as import or export.
    ClassClass for importing different sorts of external data. The EPLAN P8 API provides means to import PXF, DXF, and DWG files.
    ClassClass for inserting different kinds of external data. The class Insert contains all methods for placing window macros or inserting window macros.
    ClassTODO
    ClassClass used for labeling. The following example shows how to use class Label.
    ClassClass providing master data functionalities such as updating the master data in a project.
    ClassClass providing mounting panel functionalities such as reorganize legend numbers.
    ClassClass providing mounting panel functionalities such as reorganize legend numbers.
    ClassClass for managing the Function names (device tags) on the specified Page
    ClassClass for managing the Function3D names (device tags) on the specified InstallationSpace
    ClassClass providing parts list and parts management functionality.
    ClassClass for editing Placement3D objects.
    ClassClass providing functionality for importing and exporting PLC data.
    ClassA structure containing a PLC converter's ID together with its full name. This structure instances are elements of the array returned by the GetAvailableConverters method.
    ClassUsed as a container for PLC re-addressing settings.
    ClassClass providing functionality for handling pre-planning data.
    ClassClass providing functionality for printing complete projects or a number of pages.
    ClassThis class contains methods for some project related tasks, like finding a project by its ID, compressing a project, or importing a ProjectInfo.xml file.
    ClassClass providing functionality for numbering various types of data, like device tags.
    Class 
    ClassClass providing functionality for generating reports.
    ClassClass providing functionality to restore backups of projects or master data.
    ClassClass providing functionality of the revision control.
    ClassClass providing functionality to search within a project. The following example shows how to use class Search. Search oSearch = new Search(); // Set settings which will influence the search result oSearch[Search.Settings.CaseSensitive] = false; oSearch[Search.Settings.Texts] = false; oSearch[Search.Settings.DeviceTag] = true; oSearch[Search.Settings.AllProperties] = false; oSearch[Search.Settings.Texts] = false; oSearch[Search.Settings.PageData] = false; oSearch[Search.Settings.ProjectData] = false; oSearch[Search.Settings.GraphicPages] = false; oSearch[Search.Settings.EvalutionPages] = false; oSearch[Search.Settings.NotPlaced] = false; oSearch[Search.Settings.LogicPages] = true; Project oProject = new ProjectManager().OpenProject("$(MD_PROJECTS)\\ESS_Sample_Project.elk"); //clear active search result list oSearch.ClearSearchDB(oProject); string textToFind = "EB3*"; //Search the project oSearch.Project(oProject, textToFind); //Get search results StorableObject[] arrObjects = oSearch.GetAllSearchDBEntries(oProject);
    ClassClass providing functionality to get selected objects from a current dialog of EPLAN.
    ClassClass providing functionality for synchronizing project and system master data and synchronizing properties between different representation types.
    ClassClass providing functionality for processing terminals and terminal strips.
    ClassOptions for optimizing distributed terminals.
    ClassClass providing functionality for working with topology.
    ClassClass to determine displacement and scaling of objects (used for methods of the Import class). The following example shows how to use class Import.
    ClassClass providing functionality for translating project data.
    Structures
     StructureDescription
    StructureStruct that holds basic part description.
    StructureInternal class created in order to make fake selection. This is necessary for the internal interface
    Enumerations
     EnumerationDescription
    EnumerationScope of data backup
    EnumerationMaster data types
    EnumerationMedium for data backup
    EnumerationScope of data backup
    EnumerationMode for aligning and formatting connection definition points
    EnumerationSupported modes for avoiding multiple designations.
    EnumerationMode for deleting wire designations and connection definition points
    EnumerationMode for overwriting connection designations.
    EnumerationSupported types of wire fabrication machine for wire manufacturing data export.
    EnumerationSupported modes for changing visibility of designations.
    Enumeration 
    Enumeration 
    Enumeration 
    EnumerationEnumeration of coordinate systems
    EnumerationImport/Export format
    Enumeration 
    EnumerationTerminal strips sort methods
    EnumerationCompression for TIFF format
    EnumerationColor / Grey levels for PDF
    EnumerationImage format
    EnumerationScope of data export
    EnumerationMode for the import can be a combination of following values
    EnumerationEnumeration, which determines whether a macro will be placed using absolute coordinates or coordinates relative to its original position on the page.
    EnumerationEnumeration, which determines whether a macro will be placed using absolute coordinates or coordinates relative to its original position on the page.
    EnumerationNumbering direction
    EnumerationLogon type
    EnumerationExport formats
    EnumerationImport Indentifier
    EnumerationImport mode
    EnumerationDatabase type
    EnumerationMatching options for PLC data import.
    EnumerationOrder in which addresses are to be assigned
    EnumerationMedium for publishing the project
    EnumerationParameter enum for device tag numbering. The enum members can be combined by a logical or (|), e.g. OmitNumeratedBySPS | NumerateCables.
    EnumerationParameter enum for device tag numbering with PLC data.
    EnumerationParameter enum to define the scope of numbering:
    EnumerationParameter enum for numbering terminals with "Allow same designations" property .
    EnumerationNumbering direction of 3d objects
    EnumerationParameter enum for parts list position numbering. The enum determines, which kinds of parts will be numbered. The enum \members may be combined by a logical or (|), e.g.: DeviceTagsWithoutPartNumber | ClampParts
    EnumerationParameter enum for plug numbering.
    EnumerationParameter enum for pages numbering.
    EnumerationParameter enum for PE and N terminals during terminal numbering.
    EnumerationParameter enum for the terminal sequence during terminal numbering..
    EnumerationParameter enum how terminals or pins with alphabetical elements in the designation should be numbered: .
    EnumerationSettings for how to search.
    EnumerationStore mode determines, whether parts, which are already existing in the parts database, should be modified.
    See Also