Eplan Platform API
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
    ClassBackup This class provides functions for the data backup. Following example shows how to use Backup class.
    ClassCableService Class providing functionality for cables: numbering, automatic cable selection, generate cable automatically, delete automatically generated cables and add up cable length.
    ClassChangeInfoService This class contains methods for activating and deactivating change info handling.
    ClassChangeInfoService.ChangeInfoServiceHelper This class is used to switch back mode.
    ClassChangeOfStandard Class providing functionality to work with 3d connections.
    ClassCheck Class for checking projects or pages.
    ClassConnectionService Class providing connection functionality: Placing , designating, re-aligning, re-formatting, and deleting connection definition points.
    ClassConnectionService3D Class providing functionality to work with 3d connections.
    ClassCoordinateService Class for converting coordinate systems
    ClassDeviceService Class providing functionality for managing devices.
    ClassDeviceService.TemplatesInfo This class provides information about the templates associated with a specific part number and variant contained in the device list. Objects of this class are returned by DeviceService::GetTemplatesFromDeviceList method.
    ClassDrawingService This class allows the user to create previews of macros and other DataModel objects.
    ClassEdit Class to open pages in the graphics editor for editing.
    ClassEdit3D Class to help with working on 3D objects in the graphics editor.
    ClassExport Class for exporting projects and project data to various formats. The following example shows how to use class Export.
    ClassExport3D Class for exporting 3d objects to various formats.
    ClassGenerate Class for updating connections and cables
    ClassHarnessService Class providing harness functionalities such as import or export.
    ClassImport Class for importing different sorts of external data. The EPLAN P8 API provides means to import PXF, DXF, and DWG files.
    ClassInsert Class for inserting different kinds of external data. The class Insert contains all methods for placing window macros or inserting window macros.
    ClassInsert3D Inserts 3-d macros into layout space.
    ClassLabel Class used for labeling. The following example shows how to use class Label.
    ClassMasterdata Class providing master data functionalities such as updating the master data in a project.
    ClassMergeDataService Class providing mounting panel functionalities such as reorganize legend numbers.
    ClassMountingPanelService Class providing mounting panel functionalities such as reorganize legend numbers.
    ClassNameService Class for managing the Function names (device tags) on the specified Page
    ClassNameService3D Class for managing the Function3D names (device tags) on the specified InstallationSpace
    ClassPartsService Class providing parts list and parts management functionality.
    ClassPlacement3DService Class for editing Placement3D objects.
    ClassPlcService Class providing functionality for importing and exporting PLC data.
    ClassPlcService.PLCDataConverterInfo A 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.
    ClassPlcService.ReadressingConfig Used as a container for PLC re-addressing settings.
    ClassPrePlanningService Class providing functionality for handling pre-planning data.
    ClassPrint Class providing functionality for printing complete projects or a number of pages.
    ClassProjectManagement This class contains methods for some project related tasks, like finding a project by its ID, compressing a project, or importing a ProjectInfo.xml file.
    ClassRenumber Class providing functionality for numbering various types of data, like device tags.
    ClassRenumber.Enums  
    ClassReports Class providing functionality for generating reports.
    ClassRestore Class providing functionality to restore backups of projects or master data.
    ClassRevision Class providing functionality of the revision control.
    ClassSearch Class providing functionality to search within a project.
    ClassSelectionSet Class providing functionality to get selected objects from a current dialog of EPLAN.
    ClassSynchronize Class providing functionality for synchronizing project and system master data and synchronizing properties between different representation types.
    ClassTerminalsService Class providing functionality for processing terminals and terminal strips.
    ClassTerminalsService.OptimizeDistributedTerminalsConfig Options for optimizing distributed terminals.
    ClassTopologyService Class providing functionality for working with topology.
    ClassTransformation Class to determine displacement and scaling of objects (used for methods of the Import class). The following example shows how to use class Import.
    ClassTransformation.DrawingLimits Class contains drawing limits which are needed for scale calculations.
    ClassTranslate Class providing functionality for translating project data.
    Structures
     StructureDescription
    StructureObjectsToSynchronizeSelection  
    StructurePartsService.PartInfo Struct that holds basic part description.
    StructureSelectionFake Internal class created in order to make fake selection. This is necessary for the internal interface
    Enumerations
     EnumerationDescription
    EnumerationBackup.Amount Scope of data backup
    EnumerationBackup.MasterDataType Master data types
    EnumerationBackup.Type Scope of data backup
    EnumerationChangeOfStandard.RotationAndFlipping Rotation and flipping
    EnumerationConnectionService.Align Mode for aligning and formatting connection definition points
    EnumerationConnectionService.AvoidIdenticalDesignations Supported modes for avoiding multiple designations.
    EnumerationConnectionService.Deletion Mode for deleting wire designations and connection definition points
    EnumerationConnectionService.DesignateOverwrition Mode for overwriting connection designations.
    EnumerationConnectionService.PWMachineType Supported types of wire fabrication machine for wire manufacturing data export.
    EnumerationConnectionService.Visibility Supported modes for changing visibility of designations.
    EnumerationConnectionService3D.BundleCriteria  
    EnumerationConnectionService3D.BundleOptions  
    EnumerationConnectionService3D.ImportMode  
    EnumerationCoordinateService.CoordinateSystems Enumeration of coordinate systems
    EnumerationDeviceService.Format Import/Export format
    EnumerationDeviceService.ImportMode  
    EnumerationDeviceService.TerminalStripSortMethods Terminal strips sort methods
    EnumerationExport.Compression Compression for TIFF format
    EnumerationExport.DegreeOfColor Color / Grey levels for PDF
    EnumerationExport.Format Image format
    EnumerationHarnessService.FilterMode Scope of data export
    EnumerationHarnessService.ImportMode Mode for the import can be a combination of following values
    EnumerationInsert.MoveKind Enumeration, which determines whether a macro will be placed using absolute coordinates or coordinates relative to its original position on the page.
    EnumerationInsert3D.MoveKind Enumeration, which determines whether a macro will be placed using absolute or relative coordinates
    EnumerationMountingPanelService.NumberingDirection Numbering direction
    EnumerationPartsService.AuthenticationType Logon type
    EnumerationPartsService.Format Export formats
    EnumerationPartsService.ImportIdentifier Import Indentifier
    EnumerationPartsService.ImportMode Import mode
    EnumerationPartsService.PartsDatabaseType Database type
    EnumerationPlcService.ImportMatch Matching options for PLC data import.
    EnumerationPlcService.Sorting Order in which addresses are to be assigned
    EnumerationProjectManagement.AuthenticationType Logon type
    EnumerationProjectManagement.DatabaseType Database type
    EnumerationProjectManagement.SynchronizationMode Synchronization mode.
    EnumerationRenumber.Enums.DeviceTags Parameter enum for device tag numbering. The enum members can be combined by a logical or (|), e.g. OmitNumeratedBySPS | NumerateCables.
    EnumerationRenumber.Enums.DeviceTagsWithPLCOverwrition Parameter enum for device tag numbering with PLC data.
    EnumerationRenumber.Enums.Extent Parameter enum to define the scope of numbering:
    EnumerationRenumber.Enums.MultipleTerminals Parameter enum for numbering terminals with "Allow same designations" property .
    EnumerationRenumber.Enums.NumberingDirection3D Numbering direction of 3d objects
    EnumerationRenumber.Enums.Parts Parameter 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
    EnumerationRenumber.Enums.PlugsSequence Parameter enum for plug numbering.
    EnumerationRenumber.Enums.SubPages Parameter enum for pages numbering.
    EnumerationRenumber.Enums.TerminalsPotential Parameter enum for PE and N terminals during terminal numbering.
    EnumerationRenumber.Enums.TerminalsSequence Parameter enum for the terminal sequence during terminal numbering..
    EnumerationRenumber.Enums.TerminalsWithAlphabeticalCharacters Parameter enum how terminals or pins with alphabetical elements in the designation should be numbered: .
    EnumerationSearch.Settings Settings for how to search.
    EnumerationSynchronize.StoreMode Store mode determines, whether parts, which are already existing in the parts database, should be modified.
    EnumerationTransformation.PositionMode Position mode
    EnumerationTransformation.ScalingMode Scaling mode
    EnumerationTranslate.AuthenticationType Logon type
    EnumerationTranslate.DatabaseType Database type
    See Also

    Reference

    Eplan.EplApi.HEServicesu Assembly

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Send Feedback