PropertyValue Class Members
In This Topic
The following tables list the members exposed by PropertyValue.
Public Constructors
Public Properties
| | Name | Description |
 | Definition | Returns 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. 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). |
 | Id | Returns 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. |
 | Indexes | Returns 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). |
 | IsEmpty | 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. |
 | Item | Returns or sets the object of a persistent PropertyValue which 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). |
 | LastUsedIndex | Returns 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). |
 | Parent | Property list to which this property value is connected. |
Top
Public Methods
| | Name | Description |
 | CopyTo | Copies property value to destination including all indexes. If source property is indexed destination has to be also indexed. Only indexes from 1 to minimum of both MaxIndex are copied. |
 | Dispose | Destructor for deterministic finalization of PropertyValue object. |
 | Equals | Overloaded. Determines whether two PropertyValues objects have the same value. |
 | GetDisplayString | Display value of property as Eplan.EplApi.Base.MultiLangString. |
 | GetHashCode | Serves as the default hash function. |
 | Set | Overloaded. Sets System.DateTime value in PropertyValue object. |
 | ToBool | Used in conversion of the PropertyValue object to bool. |
 | ToDouble | Used in conversion of the PropertyValue object to double. |
 | ToInt | Used in conversion of the PropertyValue object to int. |
 | ToMultiLangString | Used in conversion of the PropertyValue object to Eplan.EplApi.Base.MultiLangString. |
 | ToPointD | Used in conversion of the PropertyValue object to Eplan.EplApi.Base.PointD. |
 | ToString | Overloaded. Returns string value of this property. When type of property is MultiLangString then only the specified language is returned. In case of a transient PropertyValue object, the stored value is returned without any cast. When property can not be read, default_value is returned instead of throwing an EmptyPropertyException . |
 | ToTime | Used in conversion of the PropertyValue object to time. |
Top
Public Operators
See Also