OptionPropertyList Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Example
Public Constructors
Public Properties
Public Methods
See Also

This class represents collection of properties of Option class. Please check also base classes for other properties which are available for Option objects: StorableObjectPropertyList

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.OptionBasePropertyList
            Eplan.EplApi.DataModel.OptionPropertyList

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class OptionPropertyList : OptionBasePropertyList

[DefaultMember("Property")]
public ref class OptionPropertyList : public OptionBasePropertyList

Remarks

It uses operator[] in order to access its elements (stored properties).

Property list is a container for property values and just like them can be online or offline. If property list is online it means that is associated with properties of some StorableObject or other property list. In this case if any property is added, changed or removed from property list the result is also visible in related objects. Whether property list is online or offline is being determine in time of it's creation and can not be changed.

Example

Example shows usage of online an offline property list:

//creation of online property list
FunctionPropertyList oPropertyListOnline1 = oFunction.Properties;
oPropertyListOnline1.FUNC_COMMENT = "Comment";
//now oFunction.Properties.FUNC_COMMENT is equal "Comment"

FunctionPropertyList oPropertyLineOnline2 = new FunctionPropertyList(oFunction);
oPropertyLineOnline2.FUNC_COMMENT = "Test";
//now oFunction.Properties.FUNC_COMMENT is equal "Test"

//creation of offline property list
FunctionPropertyList oPropertyLineOffline = new FunctionPropertyList();
oPropertyLineOffline.FUNC_COMMENT = "Test comment";
oFunction.Properties.FUNC_COMMENT = oPropertyLineOffline.FUNC_COMMENT;
oPropertyLineOffline.FUNC_COMMENT = "Offline comment";
//now oPropertyLineOffline.FUNC_COMMENT is equal "Test comment"

Public Constructors

	Name	Description
	OptionPropertyList Constructor	Overloaded.

Top

Public Properties

	Name	Description
	ExistingIds	Returns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	ExistingValues	Returns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	INSTANCE_REVISION_LOG_DATE	Modification date (change tracking) # 19032.
	INSTANCE_REVISION_LOG_MARKER	Revision marker (change tracking) # 19030.
	INSTANCE_REVISION_LOG_MARKER_FORMAT	Revision marker format (change tracking) # 19031.
	INSTANCE_REVISION_LOG_TIME	Modification time (change tracking) # 19034.
	INSTANCE_REVISION_LOG_USER	Creator (change tracking) # 19033.
	OPTION_DESCR	Project option: Description # 23106.
	OPTION_ISACTIVE	Project option active # 23103.
	OPTION_NAME	Project option: Name # 23101.
	OPTIONGROUP_DESCR	Project option group: Description # 23104.
	OPTIONGROUP_NAME	Project option group: Name # 23100.
	Parent	StorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Property	Overloaded. Method used by operator[] in order to access indexed properties.
	PROPUSER_DBOBJECTID	Overloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)

Top

Public Methods

	Name	Description
	CopyTo	Overloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Dispose()	Destructor for deterministic finalization of OptionPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Exists	Overloaded. Checks property existence for used obiect.
	getPropList	Internal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)

Top

Reference

OptionPropertyList Members
Eplan.EplApi.DataModel Namespace
Option Class
OptionBasePropertyList Class

Send Feedback