API Help
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, upper/lower bounds of values for numerical properties.  
    Public PropertyReturns P8-Property descriptor ( id and index ) on which points object. Transient PropertyValue objects don't have descriptors because they points directly to value. Transient PropertyValue is created operator by operators which takes base types values.  
    Public PropertyReturns valid indexes. It can be used with PropertyValue::operator [];  
    Public PropertyChecks if property is empty. If it's not it could be read. IMPORTANT: If property is indexed you have to set index.  
    Public PropertyReturns or set object of PropertyValue which points to specific index.  
    Public PropertyReturns number of highest used index. Indexes start from 1. If it wasn't a indexed-property or there is no used index, LastUsedIndex is 0; Object of PropertyValue had to point to property from project not to individual value.  
    Public PropertyProperty list to which this property value is connected.  
    Top
    Public Methods
     NameDescription
    Public MethodCopies property value to destination including all indexes. If source property is indexed destination has to be also indexed. Only indexes from 1 to minimal 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 System.DateTime value in 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. Returns string value of this property. When type of property is MultiLangString then only specified language is returned. In case of off-line PropertyValue object, stored value is returned without any cast. When property can not be read, default_value is returned instead of throwing EmptyPropertyException .  
    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