Eplan Platform API
Eplan.EplApi.DataModel Namespace / ContextPropertyPlacement Class
Members

In This Topic
    ContextPropertyPlacement Class
    In This Topic
    This class represents text object showing a value of property of other 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 ContextPropertyPlacement : Eplan.EplApi.DataModel.Graphics.PropertyPlacement 
    public ref class ContextPropertyPlacement : public Eplan.EplApi.DataModel.Graphics.PropertyPlacement
    Remarks
    It is not possible to change property placements of SymbolVariant because symbols library database is read-only. In this case BaseException will be thrown (e.g. when changing IsVisible property). PropertyPlacement must be embedded in another datamodel object and can show a property or a related property of this datamodel object. ContextPropertyPlacement can be placed on page and show a property from the source object, from which the property is taken e.g. the following objects are possible: * A property from the page, that is currently drawn. * A Property of the Project, where the PropertyInstance belongs to.
    Public Constructors
     NameDescription
    Public ConstructorContextPropertyPlacement ConstructorConstructor. When object created with this constructor, its create method must be call.  
    Top
    Public Properties
     NameDescription
    Public PropertyAlignmentBoxFixedHeightSpecifies that height is fixed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyAlignmentBoxFixedWidthSpecifies that width is fixed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyAlignmentBoxHeightSpecifies the height of alignment box. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyAlignmentBoxNeverHyphenateWordsSpecifies that words are wrapped. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyAlignmentBoxRemoveBreaksSpecifies that breaks are removed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyAlignmentBoxWidthSpecifies the width of alignment box. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyBasePointReturns ContextPropertyPlacement.Enums.BasePoint.  
    Public PropertyCenteredThe property specifies whether the block (main property + docked properties) should be centered (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyContentsContents of object represented by this type. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyCrossReferencedObjectsAllReturns 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 PropertyDatabaseIdentifierReturns 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 PropertyDisplayedPropertyReturn AnyPropertyId equal to displayed property id. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyDockingDirectionSpecifies docking direction for text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyDrawAlignmentBoxReturns the alignment box type (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyDrawingOrderSets 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 PropertyDrawTextBoxTypeReturns the text box type (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyFixedLanguageSpecifies language for text when property LanguageMode value is set to LangModeFix. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyFontFont for displayed text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyGroupReturns 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 PropertyHasBoxReturns true if the Text has an alignment box. In GUI it's 'Activate alignment box' checkbox. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyHeightReturns height of the Text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyIsAutomaticallyTranslatedGets/sets the flag which corresponds to "Do not translate automatically" checkbox in GUI. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyIsDockedGets/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 PropertyIsLeaderLineActivatedReturns true if the leader line is activated (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyIsLocked

    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 PropertyIsPlacedReturns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsSetAsVisibleGets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyIsTransient

    Determines if the the StorableObject is transient.

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

    it is a Page and it was not assigned a Project,

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

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsValidDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsVisibleGets/Sets the actual visibility state of the object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyJustificationReturns the justification of the Text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyLanguageModeSpecifies language mode of text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyLayerGets 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 PropertyLayerIdGets layer id of layer assigned to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyLocationGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPageReturns 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 PropertyParagraphSpacingSpecifies the Paragraph Spacing. This property is used for PropertyPlacemets attributes. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyParent (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyParserParameterSet / Get Parameters of the text (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyPenSets Eplan.EplApi.DataModel.Graphics.Pen related to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyProperties.NET Property enabling access to EPLAN properties of the ContextPropertyPlacement object.  
    Public PropertyRelationGets/Sets Relation of PropertyPlacement. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyRelationIndexGets/Sets RelationIndex of PropertyPlacement. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyRotationReturns the rotation of the Text, in radians. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
    Public PropertyRowSpacingSpecifies 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 PropertySourceReturns the object, that properties are shown by this PropertyPlacement (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public PropertyTextColorIdColor 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 PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodCopyToOverloaded. Copy Placement and insert the Copy into destination group. Copied placement will be inserted into desired project of destination group. If this placement is temporary, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted. Defines whether a layer should be matched by name. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public Methodstatic (Shared in Visual Basic)CreateOverloaded. Creates and inserts it into a group ContextPropertyPlacement which displays symbol properties.  
    Public MethodCreateFromPagePropertiesCreates and insert into page ContextPropertyPlacement which displays page property.  
    Public MethodCreateFromProjectPropertiesCreates and insert into page ContextPropertyPlacement which displays project property.  
    Public MethodDispose()Destructor (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodDockTextDocks 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 MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetBoundingBoxOverridden. Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size.  
    Public MethodGetDisplayStringReturns formated display string of the content (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetIsVisibleReturns the property placement visibility in symbol editor, for the given schema.  
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodRemoveRemoves placement. (Inherited from Eplan.EplApi.DataModel.Graphics.PropertyPlacement)
    Public MethodScaleOverloaded. 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 MethodSetVisibilityDependingOnLayerThis method sets the visibility of the graphical instance to depend on the layer setting (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public MethodSmartLockTries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodStoreWithSymbolPropertyPlacementSchemaStores property placement with given schema to symbol variant.  
    Public MethodToStringIdentifierReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodUndockTextUndock text from another oner one. 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)
    Top
    See Also

    Reference

    ContextPropertyPlacement Members
    Eplan.EplApi.DataModel Namespace

     

     

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

    Send Feedback