SymbolReferencePropertyList Class

In This Topic

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

Inheritance Hierarchy

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class SymbolReferencePropertyList : PlacementPropertyList

[DefaultMember("Property")]
public ref class SymbolReferencePropertyList : public PlacementPropertyList

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
	SymbolReferencePropertyList 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)
	FUNC_SYMB_DESC	Symbol description (function) # 20114.
	FUNC_SYMB_NAME	Symbol name # 20112.
	FUNC_SYMB_NUMBER	Symbol number # 20168.
	FUNC_SYMB_VARIANT	Symbol variant # 20113.
	FUNC_SYMBLIB_NAME	Symbol library # 20111.
	FUNC_SYMBOL	Symbol # 20575.
	INSTANCE_ACTIVE_PROPERTYSET	Property arrangement # 19307.
	INSTANCE_FULLPLACEMENTLOCATION	Placement # 19007.
	INSTANCE_PAGEFULLNAME	Page name (full) # 19023.
	INSTANCE_PAGENAME	Page name # 19022.
	INSTANCE_PAGETYPE	Page type # 19020.
	INSTANCE_PATHID	Column number # 19005.
	INSTANCE_POSID	Row number # 19006.
	INSTANCE_REVISION_LOG_DATE	Overloaded. Modification date (change tracking) # 19032. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_MARKER	Overloaded. Revision marker (change tracking) # 19030. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_MARKER_FORMAT	Overloaded. Revision marker format (change tracking) # 19031. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_TIME	Overloaded. Modification time (change tracking) # 19034. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_USER	Overloaded. Creator (change tracking) # 19033. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISIONID	Overloaded. Revision change marker (from property comparison) # 10153. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISIONMARKER	Overloaded. Revision marker (from property comparison) # 10152. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_TYPE	Representation type / report type # 19021.
	INSTANCE_USER_DEFINED_PROPERTYSET	User-defined property arrangement: Name # 19008.
	INSTANCE_XCOORD	X coordinate # 19002.
	INSTANCE_YCOORD	Y coordinate # 19003.
	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_AUTOMATIC	Overloaded. Change protection (hierarchical) # 3015. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)

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

SymbolReferencePropertyList Members
Eplan.EplApi.DataModel Namespace
SymbolReference Class
PlacementPropertyList Class

Send Feedback