Eplan Platform API
Eplan.EplApi.DataModel Namespace / PropertyValue Class
Properties Methods

In This Topic
    PropertyValue Class Members
    In This Topic

    The following tables list the members exposed by PropertyValue.

    Public Constructors
     NameDescription
    Public ConstructorDefault constructor. Creates the PropertyValue object.  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns an object that provides information about the property and its definition. The information includes:

    • name of the property

    • its data type

    • whether it's indexed or not

    • whether it's read-only or not

    • upper/lower bounds of values for numerical properties

    To use the Definition property, the PropertyValue object must point to a project property (persistent property). It cannot point to an individual value (transient property).  
    Public PropertyReturns the P8 property descriptor (Id and index) that the object points to. To use the Id property, the PropertyValue object must point to a project property (persistent property). Transient PropertyValue objects don't have descriptors because they point directly to a value. A transient PropertyValue is created by operator and takes values of base types.  
    Public PropertyReturns the valid / actually used indexes. It can be used with the PropertyValue::operator []. To use the Indexes property, the PropertyValue object must point to a project property (persistent property). It cannot point to an individual value (transient property).  
    Public Property

    Checks if the property is empty. If it's not, it could be read.

    IMPORTANT: If property is indexed, you have to set the index.

     
    Public PropertyReturns or sets the object of a persistent PropertyValue that points to a specific index. To use the Item property, the PropertyValue object must point to a project property (persistent property). It cannot point to an individual value (transient property).  
    Public PropertyReturns the number of the highest used index. Indexes start at 1. If the property is not indexed or there is no used index, LastUsedIndex is 0. To use the LastUsedIndex property, the PropertyValue object must point to a project property (persistent property).It cannot point to an individual value (transient property).  
    Public PropertyProperty list to which this property value is connected.  
    Top
    Public Methods
     NameDescription
    Public MethodCopies a PropertyValue object to a destination including all indexes. If the source property is indexed, the destination has to be also indexed. Only indexes from 1 to minimum of both MaxIndex are copied.  
    Public MethodDestructor for deterministic finalization of PropertyValue object.  
    Public MethodOverloaded. Determines whether two PropertyValues objects have the same value.  
    Public MethodDisplay value of property as Eplan.EplApi.Base.MultiLangString.  
    Public MethodServes as the default hash function.  
    Public MethodOverloaded. Sets a System.DateTime value in the PropertyValue object.  
    Public MethodUsed in conversion of the PropertyValue object to bool.  
    Public MethodUsed in conversion of the PropertyValue object to double.  
    Public MethodUsed in conversion of the PropertyValue object to int.  
    Public MethodUsed in conversion of the PropertyValue object to Eplan.EplApi.Base.MultiLangString.  
    Public MethodUsed in conversion of the PropertyValue object to Eplan.EplApi.Base.PointD.  
    Public MethodOverloaded. 

    Used in conversion of the PropertyValue object to MultiLangString.

    If the type of property is MultiLangString, only the specified language is returned. In case of a transient PropertyValue object, the stored value is returned without any cast.

     
    Public MethodUsed in conversion of the PropertyValue object to time.  
    Top
    Public Operators
    Determines whether two PropertyValues objects have the same value.
    Overloaded. Used in conversion of the PropertyValue object to int.
     
    Top
    See Also