API Help
Eplan.EplApi.DataModel.E3D Namespace / ContextPropertyPlacement3D Class
Members

In This Topic
    ContextPropertyPlacement3D Class
    In This Topic
    This class represents text object showing a value of property of Eplan.EplApi.DataModel.ViewPart object.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.Placement
             Eplan.EplApi.DataModel.Graphics.GraphicalPlacement
                Eplan.EplApi.DataModel.Graphics.TextBase
                   Eplan.EplApi.DataModel.Graphics.PropertyPlacement
                      Eplan.EplApi.DataModel.ContextPropertyPlacement
                         Eplan.EplApi.DataModel.E3D.ContextPropertyPlacement3D

    Syntax
    public class ContextPropertyPlacement3D : Eplan.EplApi.DataModel.ContextPropertyPlacement 
    public ref class ContextPropertyPlacement3D : public Eplan.EplApi.DataModel.ContextPropertyPlacement 
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertySpecifies that height is fixed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies that width is fixed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies the height of alignment box. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies that words are wrapped. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies that breaks are removed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies the width of alignment box. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns Eplan.EplApi.DataModel.ContextPropertyPlacement.Enums.BasePoint. (Inherited from Eplan.EplApi.DataModel.ContextPropertyPlacement)
    Public PropertyThe property specifies whether the block (main property + docked properties) should be centered (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyContents of object represented by this type. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturn Eplan.EplApi.DataModel.AnyPropertyId equal to displayed property id. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public Property (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns the alignment box type (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySets display sequence. The drawing order flag will be used to sort elements according to drawing order within a group. If elements chare the same value the drawing order will result from order of the data model. Default value is 67. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyReturns the text box type (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies language for text when property LanguageMode value is set to LangModeFix. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyFont for displayed text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyReturns true if the Text has an alignment box. In GUI it's 'Activate alignment box' checkbox. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns height of the Text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyGets/sets the flag which corresponds to "Do not translate automatically" checkbox in GUI. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyGets/Sets a value that indicates whether the text is docked or not. Setting IsDocked to true is possible only on PropertyPlacement object which Parent is a SymbolReference object. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns true if the leader line is activated (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public Property

    Determines if the the StorableObject is transient.

    The StorableObject is transient when it was created by default constructor and:

    it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project,

    it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets the actual visibility state of the object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyReturns the justification of the Text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies language mode of text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyGets or sets object's graphical layer. If object is not assigned to a project (Project is null), null is returned (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyGets layer id of layer assigned to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the page the Placement is on, or assigns a Page object to the placement. If the placement was previously assigned to another page, it is removed from old one and assigned to the page given as an argument. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertySpecifies the Paragraph Spacing. This property is used for PropertyPlacemets attributes. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public Property (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertySet / Get Parameters of the text (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySets Eplan.EplApi.DataModel.Graphics.Pen related to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public Property.NET Property enabling access to EPLAN properties of the ContextPropertyPlacement3D object.  
    Public PropertyGets/Sets Relation of PropertyPlacement. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyGets/Sets RelationIndex of PropertyPlacement. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyPosition relative to the parent represented by transformation matrix.  
    Public PropertyReturns the rotation of the Text, in radians. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertySpecifies the Row Spacing. This property is used for PropertyPlacemets attributes. From layer: -16002, Single: 100, 1.5 lines: 150, Double: 200. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns the object, that properties are shown by this PropertyPlacement (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyColor for displayed text. Color index (0-255) Please use -16002 as "From layer" value.

    Predefined values for line color index are:

    0 = black

    1 = red

    2 = yellow

    3 = green

    4 = cyan

    5 = blue

    6 = magenta

    7 = white

    252 = darkgray

    253 = gray

    (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodCopy Placement and insert the Copy into destination group Placement will be copied into the same Project as the destination group If this placement is transient, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodOverloaded. Creates the ContextPropertyPlacement3D object.  
    Public MethodCreates and insert into page ContextPropertyPlacement which displays page property. (Inherited from Eplan.EplApi.DataModel.ContextPropertyPlacement)
    Public MethodCreates and insert into page ContextPropertyPlacement which displays project property. (Inherited from Eplan.EplApi.DataModel.ContextPropertyPlacement)
    Public MethodDestructor for deterministic finalization of ContextPropertyPlacement3D object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodDocks one text to another. You can see how it works in GUI. Select element on schematic, display properties, show property placements and dock / undock them. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodPlacement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. (Inherited from Eplan.EplApi.DataModel.ContextPropertyPlacement)
    Public MethodReturns formated display string of the content (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodRemoves placement. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public MethodOverloaded. Scales the placement (or group of placements) by the specified factors in X and Y axis with scaling origin point specified by the ptOrigin parameter X axis factor. E.g. value of 2 makes the width two times bigger.Y axis factor. E.g. value of 0.5 makes the height two times smaller.Scaling origin point. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodThis method sets the visibility of the graphical instance to depend on the layer setting (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public MethodTries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Method (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Top
    See Also