UniversalPropertyList Class

In This Topic

UniversalPropertyList is base interface for all property lists.

Inheritance Hierarchy

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

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class UniversalPropertyList

[DefaultMember("Property")]
public ref class UniversalPropertyList

Remarks

PropertyList is a container for property values and – just like the property value itself – the property list can have two different states:
It can either be persistent (also called "online") or transient (also called "offline").
For a property list to be persistent means that it is associated with properties of some StorableObject or other property list. If any property is added, changed or removed from the property list in this case, the result is also visible in the related / associated objects.
Whether a property list is persistent or transient is being determined during the time of its creation and can not be changed afterwards.

Example

This example shows the different usage of persistent property lists and transient property lists:

// Creation of a persistent property list
FunctionPropertyList oPersistentPropertyList1 = oFunction.Properties;
oPersistentPropertyList1.FUNC_COMMENT = "Comment";
// Now, oFunction.Properties.FUNC_COMMENT is equals "Comment"

FunctionPropertyList oPersistentPropertyList2 = new FunctionPropertyList(oFunction);
oPersistentPropertyList2.FUNC_COMMENT = "Test";
// Now, oFunction.Properties.FUNC_COMMENT equals "Test"

// Creation of a transient property list
FunctionPropertyList oTransientPropertyList = new FunctionPropertyList();
oTransientPropertyList.FUNC_COMMENT = "Test comment";
oFunction.Properties.FUNC_COMMENT = oTransientPropertyList.FUNC_COMMENT;
oTransientPropertyList.FUNC_COMMENT = "Transient comment";
// Now, oTransientPropertyList.FUNC_COMMENT equals "Test comment"

Public Constructors

	Name	Description
	UniversalPropertyList Constructor	This constructor creates local property list. Each function of UniversalPropertyList will work on local property list.

Top

Public Properties

	Name	Description
	ExistingIds	Returns array of property ids. Returns array of AnyPropertyId objects.
	ExistingValues	Returns array of PropertyValue objects.
	Parent	StorableObject to which this property list is connected.
	Property	Overloaded. Method used by operator[] in order to access indexed properties by identifying name.

Top

Public Methods

	Name	Description
	CopyTo	Overloaded. Copies properties to other property list.
	Dispose	Destructor for deterministic finalization of UniversalPropertyList object.
	Exists	Overloaded. Checks property existence for used object.
	getPropList	Internal method.

Top

Reference

UniversalPropertyList Members
Eplan.EplApi.DataModel Namespace

Use the Eplan Global Support Portal for feedback and support