Eplan Platform API
Eplan.EplApi.DataModel.Graphics Namespace / GraphicalLayer Class
Members

In This Topic
    GraphicalLayer Class
    In This Topic
    This class represents a graphical layer of the project. It can be used to modify layer's properties.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.Graphics.GraphicalLayer

    Syntax
    public class GraphicalLayer 
    public ref class GraphicalLayer
    Remarks
    This class, unlike others in DataModel, saves properties like Name,Description,Visible and others after calling Store() function. It is NOT done automatic. For properly work objects of this class, they have to be associated in a GraphicalLayerTable. Some properties of Data model classes are not linked with their owners even if from the syntax it may seem otherwise. Like in this line: oRectangle.Pen.ColorId = 5, the ColorId of the Pen is changed but oRectangle object doesn't know about it since the Pen property is a stand alone value not aware of oRectangle object existence. This remark applies to the following GraphicalLayer property: Pen.
    Public Constructors
     NameDescription
    Public ConstructorGraphicalLayer ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAlignmentSpecifies the Justification.  
    Public PropertyDescriptionLayer's description  
    Public PropertyDrawTextBoxReturns true if the text frame exist.  
    Public PropertyDrawTextBoxTypeReturns the GraphicalLayer text box type  
    Public PropertyIdGets layer Id.  
    Public PropertyIs3DSpecifies if layer is used for 3D graphics It is not allowed to change this property for standard layers  
    Public PropertyIsBackGroundLayerSpecifies, if the layer is background layer  
    Public PropertyisCustomReturns true, if the layer is a custom layer.  
    Public PropertyisLockedSpecifies, if the layer is locked  
    Public PropertyisPrintedSpecifies, if the layer is printed  
    Public PropertyIsScalableSpecifies if scale is considered with this layer  
    Public PropertyisValidChecks, if layer object is attached to existing project's layer.  
    Public PropertyisVisibleSpecifies visibility of the layer  
    Public PropertyNameLayer's name  
    Public PropertyParagraphSpacingSpecifies the Paragraph Spacing. This property is used for PropertyPlacemets attributes.  
    Public PropertyPenLayer's pen  
    Public PropertyRowSpacingSpecifies the Row Spacing. This property is used for PropertyPlacemets attributes. From layer: -16002, Single: 100, 1.5 lines: 150, Double: 200.  
    Public PropertyTextHeightLayer's text height  
    Public PropertyTextRotationLayer's rotation of texts  
    Public PropertyTransparencySpecifies transparency of layer as double with a value between 0.0 and 1.0  
    Top
    Public Methods
     NameDescription
    Public MethodCreateCreates new graphical layer in graphical table. This function calls Eplan.EplApi.DataModel.Graphics.GraphicalLayerTable.AddLayer() and returned object is merged with created object.  
    Public MethodDisposeDestructor for deterministic finalization of GraphicalLayer object. Destroys layer object without storing any changes into project.  
    Public MethodEquals.NET operator for comparing two GraphicalLayers. Comparison is made by comparing each of GraphicalLayers members instead of internal object id.  
    Public MethodGetHashCodeServes as the default hash function.  
    Public MethodStoreStores modified layer's properties into project.  
    Top
    Public Operators
    public Operator Equality .NET operator for comparing two GraphicalLayers. Comparision is made by comparing each of GraphicalLayers members instead of internal object id.
    Top
    See Also

    Reference

    GraphicalLayer Members
    Eplan.EplApi.DataModel.Graphics Namespace

     

     

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

    Use the Eplan Global Support Portal for feedback and support