Eplan Platform API
Eplan.EplApi.DataModel.Graphics Namespace / TextPropertyList Class
Members Example

In This Topic
    TextPropertyList Class
    In This Topic
    This 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
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.UniversalPropertyList
          Eplan.EplApi.DataModel.StorableObjectPropertyList
             Eplan.EplApi.DataModel.PlacementPropertyList
                Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList
                   Eplan.EplApi.DataModel.Graphics.TextBasePropertyList
                      Eplan.EplApi.DataModel.Graphics.TextPropertyList
                         Eplan.EplApi.DataModel.Graphics.CommentPropertyList
                         Eplan.EplApi.DataModel.Graphics.PathTextPropertyList
                         Eplan.EplApi.DataModel.PlaceHolderTextPropertyList

    Syntax
    [DefaultMember("Property")]
public class TextPropertyList : TextBasePropertyList 
    [DefaultMember("Property")]
public ref class TextPropertyList : public TextBasePropertyList
    Remarks
    It uses operator[] in order to access its elements (stored properties).

    Property list is a container for property values and just like them can be online or offline. If property list is online it means that is associated with properties of some StorableObject or other property list. In this case if any property is added, changed or removed from property list the result is also visible in related objects. Whether property list is online or offline is being determine in time of it's creation and can not be changed.

    Example
    Example shows usage of online an offline property list: 
    //creation of online property list
FunctionPropertyList oPropertyListOnline1 = oFunction.Properties;
oPropertyListOnline1.FUNC_COMMENT = "Comment";
//now oFunction.Properties.FUNC_COMMENT is equal "Comment"

FunctionPropertyList oPropertyLineOnline2 = new FunctionPropertyList(oFunction);
oPropertyLineOnline2.FUNC_COMMENT = "Test";
//now oFunction.Properties.FUNC_COMMENT is equal "Test"

//creation of offline property list
FunctionPropertyList oPropertyLineOffline = new FunctionPropertyList();
oPropertyLineOffline.FUNC_COMMENT = "Test comment";
oFunction.Properties.FUNC_COMMENT = oPropertyLineOffline.FUNC_COMMENT;
oPropertyLineOffline.FUNC_COMMENT = "Offline comment";
//now oPropertyLineOffline.FUNC_COMMENT is equal "Test comment"
    Public Constructors
     NameDescription
    Public ConstructorTextPropertyList ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyExistingIdsReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyExistingValuesReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyINSTANCE_COLOROverloaded. Color # 19010. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_DIRECTIONOverloaded. Alignment # 19016. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBasePropertyList)
    Public PropertyINSTANCE_FONTOverloaded. Font # 19015. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBasePropertyList)
    Public PropertyINSTANCE_FULLPLACEMENTLOCATIONOverloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_GEDLOCATIONOverloaded. Graphical placement # 19103. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_INVISIBLEOverloaded. Invisible # 19101. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_LAYEROverloaded. Layer # 19019. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_PAGEFULLNAMEOverloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_PAGENAMEOverloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_PAGENOMINATIONOverloaded. Page description # 19024. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_PAGETYPEOverloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_PARAMETRICRULEOverloaded. Parametric rules # 19100. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_PATHIDOverloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_POSIDOverloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_DATEOverloaded. Modification date (change tracking) # 19032. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_MARKEROverloaded. Revision marker (change tracking) # 19030. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_MARKER_FORMATOverloaded. Revision marker format (change tracking) # 19031. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_TIMEOverloaded. Modification time (change tracking) # 19034. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_USEROverloaded. Creator (change tracking) # 19033. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISIONIDOverloaded. Revision change marker (from property comparison) # 10153. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISIONMARKEROverloaded. Revision marker (from property comparison) # 10152. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_SIZEOverloaded. Font size # 19017. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBasePropertyList)
    Public PropertyINSTANCE_XCOORDOverloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyINSTANCE_YCOORDOverloaded. Y coordinate # 19003. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyTEXT_ANGLERotation angle for text # 19343.  
    Public PropertyTEXT_CONTENTSText contents # 19201.  
    Public PropertyWRITEPROTECTED_AUTOMATICOverloaded. Change protection (hierarchical) # 3015. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Top
    Public Methods
     NameDescription
    Public MethodCopyToOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDispose()Destructor for deterministic finalization of TextPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodExistsOverloaded. Checks property existence for used obiect.  
    Public MethodgetPropListInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Top
    See Also

    Reference

    TextPropertyList Members
    Eplan.EplApi.DataModel.Graphics Namespace
    Text Class
    TextBasePropertyList Class

     

     

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

    Send Feedback