LocationPropertyList Class

In This Topic

This class represents a collection of properties of Location class. Please also check the base classes for other properties that are available for Location objects: StorableObjectPropertyList

Inheritance Hierarchy

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

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class LocationPropertyList : StorableObjectPropertyList

[DefaultMember("Property")]
public ref class LocationPropertyList : public StorableObjectPropertyList

Remarks

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

Property list is a container for property values and just like them can be persistent (also called online) or transient (also called offline). If a property list is persistent, this means that it is associated with the 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 objects. Whether a property list is persistent or transient is determined at the time of its creation and cannot be changed.

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
	LocationPropertyList Constructor	Constructor

Top

Public Properties

	Name	Description
	AUTOMATIONML_OBJECTID	AutomationML GUID # 25030.
	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)
	LOCATION_DESCRIPTION	Structure description # 1002.
	LOCATION_DESCRIPTION_2	Structure description 2 # 1007.
	LOCATION_DESCRIPTION_3	Structure description 3 # 1008.
	LOCATION_DESCRIPTION_SUPPLEMENTARYFIELD	Structure description Supplementary field # 1009.
	LOCATION_FULLNAME	Complete structure identifier # 1001.
	LOCATION_FULLNAME_WITHPREFIX	Complete structure identifier with preceding sign # 1003.
	LOCATION_NAME	Structure identifier # 1000.
	LOCATION_NAMEPART	Structure identifier: superior name component # 1010.
	LOCATION_TYPENAME	Identifier block # 1004.
	LOCATION_TYPENAME_NR	Identifier block (ID) # 1006.
	LOCATION_UPPERLOCATION	Structure identifier superior # 1011.
	LOCATION_UPPERLOCATION_DESCRIPTION	Structure identifier superior: Description # 1012.
	LOCATION_USE	Usage count # 1005.
	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)
	WRITEPROTECTED	Change protection # 3014.
	WRITEPROTECTED_AUTOMATIC	Change protection (hierarchical) # 3015.

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 LocationPropertyList 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

LocationPropertyList Members
Eplan.EplApi.DataModel Namespace
Location Class
StorableObjectPropertyList Class

Use the Eplan Global Support Portal for feedback and support