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

	Class	Description
	Backup	This class provides functions for the data backup. Following example shows how to use Backup class.
	CableService	Class providing functionality for cables: numbering, automatic cable selection, generate cable automatically, delete automatically generated cables and add up cable length.
	ChangeInfoService	This class contains methods for activating and deactivating change info handling.
	ChangeInfoService.ChangeInfoServiceHelper	This class is used to switch back mode.
	Check	Class for checking projects or pages.
	ConnectionService	Class providing connection functionality: Placing , designating, re-aligning, re-formatting, and deleting connection definition points.
	ConnectionService3D	Class providing functionality to work with 3d connections.
	CoordinateService	Class for converting coordinate systems
	DeviceService	Class providing functionality for managing devices.
	DeviceService.TemplatesInfo	This 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.
	DrawingService	This class allows the user to create previews of macros and other DataModel objects.
	Edit	Class to open pages in the graphics editor for editing.
	Edit3D	Class to help with working on 3D objects in the graphics editor.
	Export	Class for exporting projects and project data to various formats. The following example shows how to use class Export.
	Export3D	Class for exporting 3d objects to various formats.
	Generate	Class for updating connections and cables
	HarnessService	Class providing harness functionalities such as import or export.
	Import	Class for importing different sorts of external data. The EPLAN P8 API provides means to import PXF, DXF, and DWG files.
	Insert	Class for inserting different kinds of external data. The class Insert contains all methods for placing window macros or inserting window macros.
	Insert3D	TODO
	Label	Class used for labeling. The following example shows how to use class Label.
	Masterdata	Class providing master data functionalities such as updating the master data in a project.
	MergeDataService	Class providing mounting panel functionalities such as reorganize legend numbers.
	MountingPanelService	Class providing mounting panel functionalities such as reorganize legend numbers.
	NameService	Class for managing the Function names (device tags) on the specified Page
	NameService3D	Class for managing the Function3D names (device tags) on the specified InstallationSpace
	PartsService	Class providing parts list and parts management functionality.
	Placement3DService	Class for editing Placement3D objects.
	PlcService	Class providing functionality for importing and exporting PLC data.
	PlcService.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.
	PlcService.ReadressingConfig	Used as a container for PLC re-addressing settings.
	PrePlanningService	Class providing functionality for handling pre-planning data.
	Print	Class providing functionality for printing complete projects or a number of pages.
	ProjectManagement	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.
	Renumber	Class providing functionality for numbering various types of data, like device tags.
	Renumber.Enums
	Reports	Class providing functionality for generating reports.
	Restore	Class providing functionality to restore backups of projects or master data.
	Revision	Class providing functionality of the revision control.
	Search	Class 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);
	SelectionSet	Class providing functionality to get selected objects from a current dialog of EPLAN.
	Synchronize	Class providing functionality for synchronizing project and system master data and synchronizing properties between different representation types.
	TerminalsService	Class providing functionality for processing terminals and terminal strips.
	TerminalsService.OptimizeDistributedTerminalsConfig	Options for optimizing distributed terminals.
	TopologyService	Class providing functionality for working with topology.
	Transformation	Class to determine displacement and scaling of objects (used for methods of the Import class). The following example shows how to use class Import.
	Translate	Class providing functionality for translating project data.

Structures

	Structure	Description
	PartsService.PartInfo	Struct that holds basic part description.
	SelectionFake	Internal class created in order to make fake selection. This is necessary for the internal interface

Enumerations

	Enumeration	Description
	Backup.Amount	Scope of data backup
	Backup.MasterDataType	Master data types
	Backup.Medium	Medium for data backup
	Backup.Type	Scope of data backup
	ConnectionService.Align	Mode for aligning and formatting connection definition points
	ConnectionService.AvoidIdenticalDesignations	Supported modes for avoiding multiple designations.
	ConnectionService.Deletion	Mode for deleting wire designations and connection definition points
	ConnectionService.DesignateOverwrition	Mode for overwriting connection designations.
	ConnectionService.PWMachineType	Supported types of wire fabrication machine for wire manufacturing data export.
	ConnectionService.Visibility	Supported modes for changing visibility of designations.
	ConnectionService3D.BundleCriteria
	ConnectionService3D.BundleOptions
	ConnectionService3D.ImportMode
	CoordinateService.CoordinateSystems	Enumeration of coordinate systems
	DeviceService.Format	Import/Export format
	DeviceService.ImportMode
	DeviceService.TerminalStripSortMethods	Terminal strips sort methods
	Export.Compression	Compression for TIFF format
	Export.DegreeOfColor	Color / Grey levels for PDF
	Export.Format	Image format
	HarnessService.FilterMode	Scope of data export
	HarnessService.ImportMode	Mode for the import can be a combination of following values
	Insert.MoveKind	Enumeration, which determines whether a macro will be placed using absolute coordinates or coordinates relative to its original position on the page.
	Insert3D.MoveKind	Enumeration, which determines whether a macro will be placed using absolute coordinates or coordinates relative to its original position on the page.
	MountingPanelService.NumberingDirection	Numbering direction
	PartsService.AuthenticationType	Logon type
	PartsService.Format	Export formats
	PartsService.ImportIdentifier	Import Indentifier
	PartsService.ImportMode	Import mode
	PartsService.PartsDatabaseType	Database type
	PlcService.ImportMatch	Matching options for PLC data import.
	PlcService.Sorting	Order in which addresses are to be assigned
	ProjectManagement.Medium	Medium for publishing the project
	Renumber.Enums.DeviceTags	Parameter enum for device tag numbering. The enum members can be combined by a logical or (\|), e.g. OmitNumeratedBySPS \| NumerateCables.
	Renumber.Enums.DeviceTagsWithPLCOverwrition	Parameter enum for device tag numbering with PLC data.
	Renumber.Enums.Extent	Parameter enum to define the scope of numbering:
	Renumber.Enums.MultipleTerminals	Parameter enum for numbering terminals with "Allow same designations" property .
	Renumber.Enums.NumberingDirection3D	Numbering direction of 3d objects
	Renumber.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
	Renumber.Enums.PlugsSequence	Parameter enum for plug numbering.
	Renumber.Enums.SubPages	Parameter enum for pages numbering.
	Renumber.Enums.TerminalsPotential	Parameter enum for PE and N terminals during terminal numbering.
	Renumber.Enums.TerminalsSequence	Parameter enum for the terminal sequence during terminal numbering..
	Renumber.Enums.TerminalsWithAlphabeticalCharacters	Parameter enum how terminals or pins with alphabetical elements in the designation should be numbered: .
	Search.Settings	Settings for how to search.
	Synchronize.StoreMode	Store mode determines, whether parts, which are already existing in the parts database, should be modified.

Reference

Eplan.EplApi.HEServicesu Assembly

Send Feedback