System.Object
Eplan.EplApi.DataModel.PropertyValue
System.Object
Eplan.EplApi.DataModel.PropertyValue
[DefaultMember("Item")] public sealed class PropertyValue
[DefaultMember("Item")] public ref class PropertyValue sealed
StorableObject
. It is off-line property. * Collected from property list. It is on-line property. * Collected from any data model object. It is on-line property. In two last cases usage of Eplan::EplApi::DataModel::PropertyValue::Set updates vales in original locations.
PropertyValue oPV1 = oFunction.Properties[Properties.Function.FUNC_COMMENT];
oPV1 = oPV1 + " additional comment";
PropertyValue oOfflineProperty = new PropertyValue(); oOfflineProperty.Set("Setting value to offline PropertyValue.");
FunctionPropertyList oFunctionPropertyList = new FunctionPropertyList(); PropertyValue oOnlineProperty2 = oFunctionPropertyList["EPLAN.Project.UserSupplementaryField1"]; //oFunctionPropertyList["EPLAN.Project.UserSupplementaryField1"] contains empty string //oOnlineProperty2 contains empty string oFunctionPropertyList["EPLAN.Project.UserSupplementaryField1"] = "Test_1"; //oOnlineProperty2 == "Test_1 also oOnlineProperty2.Set("Test_2"); //oFunctionPropertyList["EPLAN.Project.UserSupplementaryField1"] == Test_2 also
PropertyValue oOnlineProperty = m_oTestProject.Properties["EPLAN.Project.UserSupplementaryField1"]; //oProject.Properties.PROJ_CUSTOM_SUPPLEMENTARYFIELD01 contains empty string m_oTestProject.Properties["EPLAN.Project.UserSupplementaryField1"] = "Test1"; //now oOnlinePropertyValue has value "Test1" also oOnlineProperty.Set("Test2"); //now oProject.Properties.PROJ_CUSTOM_SUPPLEMENTARYFIELD01 has value "Test2" also
Article article; //a valid article object //below here PropertyValue is implicit created from int '2' and its assigned to the property list. article.Properties[Properties.Article.ARTICLE_HEIGHT] = 2; //below here PropertyValue is implicit created from string "5" and its assigned to the property list. article.Properties[Properties.Article.ARTICLE_HEIGHT] = "5"; //below here PropertyValue is read form property list and implicit converted to string. string s = article.Properties[Properties.Article.ARTICLE_HEIGHT]; //below here PropertyValue is read form property list and implicit converted to int. int i = article.Properties[Properties.Article.ARTICLE_HEIGHT];
Name | Description | |
---|---|---|
PropertyValue Constructor | Default constructor. Creates the PropertyValue object. |
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. | |
Id | Returns 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. | |
Indexes | Returns valid indexes. It can be used with PropertyValue::operator []; | |
IsEmpty | Checks if property is empty. If it's not it could be read. IMPORTANT: If property is indexed you have to set index. | |
Item | Returns or set object of PropertyValue which points to specific index. | |
LastUsedIndex | Returns 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. | |
Parent | Property list to which this property value is connected. |
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 minimal 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 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 . | |
ToTime | Used in conversion of the PropertyValue object to time . |
Equality | Determines whether two PropertyValues objects have the same value. |
Implicit Type Conversion | Overloaded. Used in conversion of the PropertyValue object to int . |
Inequality |
PropertyValue Members
Eplan.EplApi.DataModel Namespace
ArticlePropertyList Class
ConnectionPropertyList Class
FunctionPropertyList Class
FunctionBasePropertyList Class
InterruptionPointPropertyList Class
LocationBoxPropertyList Class
PagePropertyList Class
PlacementPropertyList Class
SymbolVariantPropertyList Class
ProjectPropertyList Class
ConnectionDefinitionPointPropertyList Class
DocumentBasePropertyList Class