MDPropertyValue Class

In This Topic

Class holding value of P8 Master Data property.

Inheritance Hierarchy

System.Object
Eplan.EplApi.MasterData.MDPropertyValue

Syntax

C#
C++/CLI

[DefaultMember("Item")]
public sealed class MDPropertyValue

[DefaultMember("Item")]
public ref class MDPropertyValue sealed

Remarks

An MDPropertyValue object can be in one of three states:
• 1 Transient – created by the user. This object is not connected with any property list or object stored in the master data database. It is a transient property (also called "offline").
• 2 Persistent – collected from a property list. It is a persistent property (also called "online").
• 3 Persistent – collected from any master data object. It is a persistent property (also called "online").

In the two last cases (persistent properties), the overloads of the MDPropertyValue.Set method set the values in the original locations.

An MDPropertyValue object can hold values of the following types:
• int
• string
• double
• bool
• DateTime
• MultiLangString
• PointD

The class implements conversion operators that will simplify the access to P8 property values stored inside of an MDPropertyList class object.
The user does not have to use this class explicitly, it allows to assign P8 property values in a simple way (see example).
Value of the property can be changed using overloads of the MDPropertyValue.Set method:
• Set(Double)
• Set(Boolean)
• Set(String)
• etc.

Example

Creating transient properties: Creating persistent properties:

MDPropertyValue oPv = oPart.Properties[Properties.MDPartsDatabaseItem.ARTICLE_DESCR1];
oPv = oPv + " additional comment";
// Creates a new transient property value object and assigns it to the variable oPv.

MDPart oPart = m_MDPartsDatabase.Parts[0]; // A valid master data part object

// Here, the MDPropertyValue object is implicitly created from an int constant ('5') and is assigned to the property list.
oPart.Properties[Eplan.EplApi.MasterData.Properties.MDPartsDatabaseItem.ARTICLE_HEIGHT] = 5;

// Here, the MDPropertyValue object is implicitly created from a string constant ("7") and is assigned to the property list.
oPart.Properties[Eplan.EplApi.MasterData.Properties.MDPartsDatabaseItem.ARTICLE_HEIGHT] = "7";

// Here, the MDPropertyValue object is read form a property list and implicitly converted to string.
string s = oPart.Properties[Eplan.EplApi.MasterData.Properties.MDPartsDatabaseItem.ARTICLE_HEIGHT];

// Here, the MDPropertyValue object is read form a property list and implicitly converted to int.
int i = oPart.Properties[Eplan.EplApi.MasterData.Properties.MDPartsDatabaseItem.ARTICLE_HEIGHT];

Public Constructors

	Name	Description
	MDPropertyValue Constructor	Default constructor. Creates a MDPropertyValue object.

Top

Public Properties

	Name	Description
	Definition	Returns an object that provides information about the property and its definition. The information includes: name of the property, it's data type, whether it is indexed or not, whether it is read-only, upper/lower bounds of values for numerical properties.
	Id	Returns P8-Property descriptor (id and index) of the object. Offline MDPropertyValue objects don't have descriptors because they point to value directly. An offline MDPropertyValue is created by operators that take base types values.
	Indexes	Returns array of indexes for which property value is not empty. It can be used with MDPropertyValue::operator [];
	IsEmpty	Checks if property value is empty. If it's not it can be read. IMPORTANT: If property is indexed you have to specify index.
	Item	Returns MDPropertyValue object at specified index.
	LastUsedIndex	Returns number of highest used index. Index value starts from 1. If it is a not indexed-property or if their index is not used, LastUsedIndex is 0. An object of MDPropertyValue has to point to online property.
	Parent	Property list to which this property value is connected.

Top

Public Methods

	Name	Description
	Dispose	Destructor for deterministic finalization of MDPropertyValue object.
	GetDisplayString	Display value of property as Eplan.EplApi.Base.MultiLangString.
	Set	Overloaded. Sets System.DateTime value in MDPropertyValue object.
	ToBool	Converts this MDPropertyValue object to `System::Boolean`.
	ToDouble	Converts this MDPropertyValue object to `doule`.
	ToInt	Converts this MDPropertyValue object to `long`.
	ToMultiLangString	Converts this MDPropertyValue object to Eplan.EplApi.Base.MultiLangString.
	ToPointD	Conversion this MDPropertyValue 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 offline MDPropertyValue object, stored value is returned without any cast. When property can not be read, `default_value` is returned instead of throwing `MDEmptyPropertyException` .
	ToTime	Converts this MDPropertyValue object to `System::DateTime`.

Top

Public Operators

Implicit Type Conversion Overloaded. Converts MDPropertyValue object to long.

Top

Reference

MDPropertyValue Members
Eplan.EplApi.MasterData Namespace
PropertiesAndHandleObjectPropertyList Class
MDPartsDatabaseItemPropertyList Class

Use the Eplan Global Support Portal for feedback and support