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
    ClassThis class represents Arc on the page.
    ClassThis class is used only as container for enumerations, like a namespace.
    ClassThis class represents collection of properties of Arc class. Please check also base classes for other properties which are available for Arc objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class is used only as container for color id constants Depending of the used color table, additional Values for ColorId are possible
    ClassRepresents a comment on page which was imported from PDF file.
    ClassRepresents list of possible states that a PDF comment can have.
    ClassThis class represents collection of properties of Comment class. Please check also base classes for other properties which are available for Comment objects: TextPropertyList, TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassClass represents Contact image object.
    Class 
    ClassThis class represents circle dimension on the page.
    ClassThis class is used only as container for enumerations, like a namespace.
    ClassThis class represents collection of properties of DimensionCircle class. Please check also base classes for other properties which are available for DimensionCircle objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents the DimensionItem on the page.
    ClassThis class is used only as container for enumerations, like a namespace.
    ClassThis class represents collection of properties of DimensionItem class. Please check also base classes for other properties which are available for DimensionItem objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents a graphical layer of the project. It can be used to modify layer's properties.
    ClassThis class represents the table of all graphical layers of the project. It can be used for creating, deleting, merging, and retrieving project's layers.
    ClassThis class is a superclass for all graphical classes, like Line, Arc etc.
    ClassThis class represents collection of properties of GraphicalPlacement class. Please check also base classes for other properties which are available for GraphicalPlacement objects: Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents hyperlinks.
    ClassThis class represents collection of properties of HyperLink class. Please check also base classes for other properties which are available for HyperLink objects: TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents image.
    ClassThis class represents collection of properties of Image class. Please check also base classes for other properties which are available for Image objects: RectanglePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents a line on the Eplan.EplApi.DataModel.Page.
    ClassThis class represents collection of properties of Line class. Please check also base classes for other properties which are available for Line objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class is a reserved area which can be set on a mounting panel. It is forbidden to set article placements into this area.
    ClassThis class represents collection of properties of LockedMountingArea class. Please check also base classes for other properties which are available for LockedMountingArea objects: RectanglePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents path function text object on the Eplan.EplApi.DataModel.Page.
    ClassThis class represents collection of properties of PathText class. Please check also base classes for other properties which are available for PathText objects: TextPropertyList, TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassPen class represents graphical objects' drawing settings.
    ClassUsing the PlaceHolder object you can forward records of properties to the references objects. You also can get information about place holders in macros.
    ClassRepresents values table of a placeholder
    ClassRepresents value sets of a placeholder
    Class 
    ClassRepresents variable of a placeholder
    ClassRepresents variables of a placeholder
    Class 
    ClassThis class represents collection of properties of PlaceHolder class. Please check also base classes for other properties which are available for PlaceHolder objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represent PolyLine on the Eplan.EplApi.DataModel.Page. The following example shows how to use class PolyLine.
    ClassThis class represents collection of properties of PolyLine class. Please check also base classes for other properties which are available for PolyLine objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassProject Parameter Class for the usage with UnitParser. Configure the unit and the look of the Parser result.
    ClassThis 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.
    ClassThis class represents collection of properties of PropertyPlacement class. Please check also base classes for other properties which are available for PropertyPlacement objects: TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents QRCode.
    ClassThis class represents collection of properties of QRCode class. Please check also base classes for other properties which are available for QRCode objects: RectanglePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents a Rectangle on the Eplan.EplApi.DataModel.Page.
    ClassThis class represents collection of properties of Rectangle class. Please check also base classes for other properties which are available for Rectangle objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThe class is a graphical representation of Shield
    ClassThis class represents collection of properties of Shielding class. Please check also base classes for other properties which are available for Shielding objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents spline placed on the Eplan.EplApi.DataModel.Page.
    ClassThis class represents collection of properties of Spline class. Please check also base classes for other properties which are available for Spline objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents text displayed on the Eplan.EplApi.DataModel.Page.
    ClassThis class represents text displayed on the Eplan.EplApi.DataModel.Page.
    ClassClass for representation font information in text objects.
    ClassThis class represents collection of properties of TextBase class. Please check also base classes for other properties which are available for TextBase objects: GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassThis class represents collection of properties of Text class. Please check also base classes for other properties which are available for Text objects: TextBasePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassRepresents a topology connection line.
    ClassThis class represents collection of properties of TopologyLine class. Please check also base classes for other properties which are available for TopologyLine objects: LinePropertyList, GraphicalPlacementPropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    ClassClass represents object which can display 3D objects on page.
    ClassThis class represents collection of properties of ViewPlacement class. Please check also base classes for other properties which are available for ViewPlacement objects: Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList
    Structures
     StructureDescription
    StructureDefines 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
    EnumerationTypes of arcs.
    Enumeration 
    EnumerationEnum describes all possibilities where contact image can be displayed.
    EnumerationEnum containing all possible setting of contact image.
    EnumerationEnumeration of Dimension's precision types
    EnumerationEnumeration of Dimension's unit types
    EnumerationEnumeration of dimension line termination
    EnumerationEnumeration of dimension's precision types
    EnumerationEnumeration of dimension type
    EnumerationEnumeration of dimension's unit types
    EnumerationAlignment
    EnumerationFillPaternType used for getting and setting FillPattern on PolyLine.
    EnumerationSpecifies relation type of property placement
    EnumerationSpecifies docking style of text.
    EnumerationAlignment box type
    Enumeration 
    EnumerationText box type
    EnumerationSpecifies docking direction of text.
    EnumerationSpecifies language mode of text.
    EnumerationDirections from which objects can be seen.
    EnumerationTypes of view.
    EnumerationPossible ways of scaling.
    EnumerationPossible styles of rendering objects in ViewPlacement.
    See Also