LocationPropertyList Class

In This Topic

This class represents collection of properties of Location class. Please check also base classes for other properties which 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 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
	LocationPropertyList Constructor	Overloaded.

Top

Public Properties

	Name	Description
	AUTOMATIONML_OBJECTID	Overloaded. # 25030. This property isn't indexed.
	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	Overloaded. Structure description # 1002. This property isn't indexed.
	LOCATION_DESCRIPTION_2	Overloaded. Structure description 2 # 1007. This property isn't indexed.
	LOCATION_DESCRIPTION_3	Overloaded. Structure description 3 # 1008. This property isn't indexed.
	LOCATION_DESCRIPTION_SUPPLEMENTARYFIELD	Overloaded. Structure description Supplementary field # 1009.
	LOCATION_FULLNAME	Overloaded. Complete structure identifier # 1001. This property isn't indexed, and is read-only.
	LOCATION_FULLNAME_WITHPREFIX	Overloaded. Complete structure identifier with preceding sign # 1003. This property isn't indexed, and is read-only.
	LOCATION_NAME	Overloaded. Structure identifier # 1000. This property isn't indexed, and is read-only.
	LOCATION_NAMEPART	Overloaded. Structure identifier: superior name component # 1010.
	LOCATION_TYPENAME	Overloaded. Identifier block # 1004. This property isn't indexed, and is read-only.
	LOCATION_TYPENAME_NR	Overloaded. Identifier block (ID) # 1006. This property isn't indexed, and is read-only.
	LOCATION_UPPERLOCATION	Overloaded. Structure identifier superior # 1011.
	LOCATION_UPPERLOCATION_DESCRIPTION	Overloaded. Structure identifier superior: Description # 1012.
	LOCATION_USE	Overloaded. Usage count # 1005. This property isn't indexed, and is read-only.
	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. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
	WRITEPROTECTED	Overloaded. Change protection # 3014. This property isn't indexed, and is read-only.
	WRITEPROTECTED_AUTOMATIC	Overloaded. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only.

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

Send Feedback