Eplan Platform API
Inheritance Hierarchy
In This Topic
    Eplan.EplApi.DataModel.Graphics Namespace
    In This Topic
    This sub-namespace of the electrotechnical data model, contains all classes for graphical items like lines, circles, images, or texts.
    Classes
     ClassDescription
    ClassArc This class represents Arc on the page.
    ClassArc.Enums This class is used only as container for enumerations, like a namespace.
    ClassArcPropertyList This class represents a collection of properties of Arc class. Please also check the base classes for other properties that are available for Arc objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassColor.Id This class is used only as container for color id constants Depending of the used color table, additional Values for ColorId are possible
    ClassComment Represents a comment on page which was imported from PDF file.
    ClassComment.Enums Represents list of possible states that a PDF comment can have.
    ClassCommentPropertyList This class represents a collection of properties of Comment class. Please also check the base classes for other properties that are available for Comment objects: TextPropertyList, TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassContactImage Class represents Contact image object.
    ClassContactImage.Enums  
    ClassDimensionCircle This class represents circle dimension on the page.
    ClassDimensionCircle.Enums This class is used only as container for enumerations, like a namespace.
    ClassDimensionCirclePropertyList This class represents a collection of properties of DimensionCircle class. Please also check the base classes for other properties that are available for DimensionCircle objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassDimensionItem This class represents the DimensionItem on the page.
    ClassDimensionItem.Enums This class is used only as container for enumerations, like a namespace.
    ClassDimensionItemPropertyList This class represents a collection of properties of DimensionItem class. Please also check the base classes for other properties that are available for DimensionItem objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassGraphicalLayer This class represents a graphical layer of the project. It can be used to modify layer's properties.
    ClassGraphicalLayerTable This class represents the table of all graphical layers of the project. It can be used for creating, deleting, merging, and retrieving project's layers.
    ClassGraphicalPlacement This class is a superclass for all graphical classes, like Line, Arc etc.
    ClassGraphicalPlacementPropertyList This class represents a collection of properties of GraphicalPlacement class. Please also check the base classes for other properties that are available for GraphicalPlacement objects: Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassHyperLink This class represents hyperlinks.
    ClassHyperLinkPropertyList This class represents a collection of properties of HyperLink class. Please also check the base classes for other properties that are available for HyperLink objects: TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassImage This class represents image.
    ClassImagePropertyList This class represents a collection of properties of Image class. Please also check the base classes for other properties that are available for Image objects: RectanglePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassLine This class represents a line on the Eplan.EplApi.DataModel.Page.
    ClassLinePropertyList This class represents a collection of properties of Line class. Please also check the base classes for other properties that are available for Line objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassLockedMountingArea This class is a reserved area which can be set on a mounting panel. It is forbidden to set article placements into this area.
    ClassLockedMountingAreaPropertyList This class represents a collection of properties of LockedMountingArea class. Please also check the base classes for other properties that are available for LockedMountingArea objects: RectanglePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassPathText This class represents path function text object on the Eplan.EplApi.DataModel.Page.
    ClassPathTextPropertyList This class represents a collection of properties of PathText class. Please also check the base classes for other properties that are available for PathText objects: TextPropertyList, TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassPen The Pen class represents the drawing settings of graphical objects.
    ClassPlaceHolder Using the PlaceHolder object you can forward records of properties to the references objects. You also can get information about place holders in macros.
    ClassPlaceHolder.ValuesClass Represents values table of a placeholder
    ClassPlaceHolder.ValueSetsClass Represents value sets of a placeholder
    ClassPlaceHolder.ValueSetsClass.ValueSetEnumerator  
    ClassPlaceHolder.Variable Represents variable of a placeholder
    ClassPlaceHolder.VariablesClass Represents variables of a placeholder
    ClassPlaceHolder.VariablesClass.VariablesEnumerator  
    ClassPlaceHolderPropertyList This class represents a collection of properties of PlaceHolder class. Please also check the base classes for other properties that are available for PlaceHolder objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassPolyLine This class represent PolyLine on the Eplan.EplApi.DataModel.Page. The following example shows how to use class PolyLine.
    ClassPolyLinePropertyList This class represents a collection of properties of PolyLine class. Please also check the base classes for other properties that are available for PolyLine objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassProjectParserParameter Project Parameter Class for the usage with UnitParser. Configure the unit and the look of the Parser result.
    ClassPropertyPlacement This class represents text object showing a value of property of other object. It is not possible to change property placements of SymbolVariant because symbols library database is readonly. In this case BaseException will be thrown (e.g. when changing IsVisible property). Please use the Eplan.EplApi.Datamodel.SymboReference.UseLocalPropertyPlacements() method in order to change the local PropertyPlacements of Eplan.EplApi.DataModel.SymbolReference object. The following example shows how to use class PropertyPlacement.
    ClassPropertyPlacementPropertyList This class represents a collection of properties of PropertyPlacement class. Please also check the base classes for other properties that are available for PropertyPlacement objects: TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassQRCode This class represents QRCode.
    ClassQRCodePropertyList This class represents a collection of properties of QRCode class. Please also check the base classes for other properties that are available for QRCode objects: RectanglePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassRectangle This class represents a Rectangle on the Eplan.EplApi.DataModel.Page.
    ClassRectanglePropertyList This class represents a collection of properties of Rectangle class. Please also check the base classes for other properties that are available for Rectangle objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassShielding The class is a graphical representation of Shield
    ClassShieldingPropertyList This class represents a collection of properties of Shielding class. Please also check the base classes for other properties that are available for Shielding objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassSpline This class represents spline placed on the Eplan.EplApi.DataModel.Page.
    ClassSplinePropertyList This class represents a collection of properties of Spline class. Please also check the base classes for other properties that are available for Spline objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassText This class represents text displayed on the Eplan.EplApi.DataModel.Page.
    ClassTextBase This class represents text displayed on the Eplan.EplApi.DataModel.Page.
    ClassTextBase.FontInfo Class for representation font information in text objects.
    ClassTextBasePropertyList This class represents a collection of properties of TextBase class. Please also check the base classes for other properties that are available for TextBase objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassTextPropertyList This class represents a collection of properties of Text class. Please also check the base classes for other properties that are available for Text objects: TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassTopologyLine Represents a topology connection line.
    ClassTopologyLinePropertyList This class represents a collection of properties of TopologyLine class. Please also check the base classes for other properties that are available for TopologyLine objects: LinePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassViewPlacement Class represents object which can display 3D objects on page.
    ClassViewPlacement.PropertyPlacementsSchema A structure representing a property placements configuration. Such configuration is described by name and ID. The ID is used to select a specific configuration through SelectPropertyPlacementsSchema method.
    ClassViewPlacement.PropertyPlacementsSchemasList A structure representing a property placements schemes.
    ClassViewPlacementPropertyList This class represents a collection of properties of ViewPlacement class. Please also check the base classes for other properties that are available for ViewPlacement objects: Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    Structures
     StructureDescription
    StructureColor Defines color of graphical placements or 3d placements Color can be stored as a) a colorId as reference into an internal color table (Default) b) RGB values of the color c) a special color id ByLayer, that says: color is defined by layer Usually the color is defined by color id. Imported 3d graphics may store RGB values directly If the ColorId==ByLayer then the color must be taken from layer If the TransparencyDefinedByLayer is true, then the transparency must be taken from layer otherwise the transparency is stored in this object The mapping between R,G,B values and colorId is done in a way that at first there is checked background-dependant palette and afterwards extended one.
    Enumerations
     EnumerationDescription
    EnumerationArc.Enums.Type Types of arcs.
    EnumerationComment.Enums.ReviewStateType  
    EnumerationContactImage.Enums.ContactImageType Enum describes all possibilities where contact image can be displayed.
    EnumerationContactImage.Enums.DisplayMaskType Enum containing all possible setting of contact image.
    EnumerationDimensionCircle.Enums.DimensionPrecision Enumeration of Dimension's precision types
    EnumerationDimensionCircle.Enums.DimensionUnit Enumeration of Dimension's unit types
    EnumerationDimensionItem.Enums.DimensionLineTermination Enumeration of dimension line termination
    EnumerationDimensionItem.Enums.DimensionPrecision Enumeration of dimension's precision types
    EnumerationDimensionItem.Enums.DimensionType Enumeration of dimension type
    EnumerationDimensionItem.Enums.DimensionUnit Enumeration of dimension's unit types
    EnumerationGraphicalLayer.AlignmentType Alignment
    EnumerationGraphicalLayer.TextBoxType Text box type
    EnumerationGraphicalPlacement.FillPatternType FillPaternType used for getting and setting FillPattern on PolyLine.
    EnumerationPropertyPlacement.RelationType Specifies relation type of property placement
    EnumerationPropertyPlacement.TextDockingStyle Specifies docking style of text.
    EnumerationTextBase.AlignmentBoxType Alignment box type
    EnumerationTextBase.JustificationType  
    EnumerationTextBase.TextBoxType Text box type
    EnumerationTextBase.TextDockingDirection Specifies docking direction of text.
    EnumerationTextBase.TextLanguageMode Specifies language mode of text.
    EnumerationViewDirectionType Directions from which objects can be seen.
    EnumerationViewPlacementType Types of view.
    EnumerationViewScaleType Possible ways of scaling.
    EnumerationViewStyleType Possible styles of rendering objects in ViewPlacement.
    See Also

    Reference

    Eplan.EplApi.DataModelu Assembly

     

     

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

    Use the Eplan Global Support Portal for feedback and support