SymbolPropertyList Class

In This Topic

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

Inheritance Hierarchy

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

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class SymbolPropertyList : Eplan.EplApi.DataModel.StorableObjectPropertyList

[DefaultMember("Property")]
public ref class SymbolPropertyList : public Eplan.EplApi.DataModel.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
	SymbolPropertyList Constructor	Overloaded.

Top

Public Properties

	Name	Description
	CABLINGSEGMENT_DIRECTION_OF_HEIGHT_DIFF	Overloaded. Topology: Direction for height difference # 20348. This property isn't indexed.
	CONNECTION_ACL_COLOR	Overloaded. Autoconnecting line: Color # 31005. This property isn't indexed.
	CONNECTION_ACL_FACTOR	Overloaded. Autoconnecting line: Pattern length # 31018. This property isn't indexed.
	CONNECTION_ACL_LAYER	Overloaded. Autoconnecting line: Layer # 31017. This property isn't indexed.
	CONNECTION_ACL_STYLE	Overloaded. Autoconnecting line: Line type # 31015. This property isn't indexed.
	CONNECTION_ACL_WIDTH	Overloaded. Autoconnecting line: Line thickness # 31016. This property isn't indexed.
	CONNECTION_DESIGNATION	Overloaded. Connection designation # 31011. 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)
	FUNC_BLOCK_FORMAT	Overloaded. Block property: Format # 20202.
	FUNC_CATEGORY	Overloaded. Function definition: Category # 20115. This property isn't indexed, and is read-only.
	FUNC_CATEGORY_GROUP_ID	Overloaded. Function definition: Category / Group / Definition # 20188. This property isn't indexed.
	FUNC_CATEGORY_REGION	Overloaded. Function definition: Area # 20088. This property isn't indexed, and is read-only.
	FUNC_COMPONENTTYPE	Overloaded. Function definition # 20026. This property isn't indexed, and is read-only.
	FUNC_DESC	Overloaded. Function definition: Description # 20117. This property isn't indexed, and is read-only.
	FUNC_GROUP	Overloaded. Function definition: Group # 20116. 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)
	PROPUSER_LAST_USERCODE	Overloaded. Last editor: ID # 3010. This property isn't indexed, and is read-only.
	PROPUSER_LAST_USEREMAIL	Overloaded. Last editor: E-mail # 3013. This property isn't indexed, and is read-only.
	PROPUSER_LAST_USERNAME	Overloaded. Last editor: Name # 3011. This property isn't indexed, and is read-only.
	PROPUSER_LAST_USERPHONE	Overloaded. Last editor: Phone # 3012. This property isn't indexed, and is read-only.
	SYMB_CABLE_RELATED_VDP_SYMBOL_ID_USE_1ST_VARIANT_ONLY	Overloaded. Use first variant of connection definition point symbol # 16030. This property isn't indexed.
	SYMB_CONNECTIONNUMBER	Overloaded. Connection point number # 16001.
	SYMB_CRAFT	Overloaded. Trade (function definition) # 16017. This property isn't indexed, and is read-only.
	SYMB_CREATIONDATE	Overloaded. Creation date # 16021. This property isn't indexed.
	SYMB_CREATOR	Overloaded. Creator # 16020. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_A	Overloaded. Default property arrangement for variant A (alternative) # 16033. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_B	Overloaded. Default property arrangement for variant B (alternative) # 16034. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_C	Overloaded. Default property arrangement for variant C (alternative) # 16035. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_D	Overloaded. Default property arrangement for variant D (alternative) # 16036. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_E	Overloaded. Default property arrangement for variant E (alternative) # 16037. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_F	Overloaded. Default property arrangement for variant F (alternative) # 16038. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_G	Overloaded. Default property arrangement for variant G (alternative) # 16039. This property isn't indexed.
	SYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_H	Overloaded. Default property arrangement for variant H (alternative) # 16041. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_A	Overloaded. Default property arrangement for variant A # 16004. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_B	Overloaded. Default property arrangement for variant B # 16005. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_C	Overloaded. Default property arrangement for variant C # 16006. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_D	Overloaded. Default property arrangement for variant D # 16007. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_E	Overloaded. Default property arrangement for variant E # 16008. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_F	Overloaded. Default property arrangement for variant F # 16009. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_G	Overloaded. Default property arrangement for variant G # 16014. This property isn't indexed.
	SYMB_DEFAULT_PROPERTYSET_H	Overloaded. Default property arrangement for variant H # 16015. This property isn't indexed.
	SYMB_DEFAULT_VARIANT	Overloaded. Default variant # 16003. This property isn't indexed.
	SYMB_DESC	Overloaded. Symbol description # 16011. This property isn't indexed.
	SYMB_DXF_BLOCKNAME	Overloaded. DXF export: Name of block # 16040. This property isn't indexed.
	SYMB_IMPORTEDVARIANTMAPPING	Overloaded. Symbol variant assignment (internal) # 16031.
	SYMB_INTRINSICALLYSAFE	Overloaded. Intrinsically safe # 16019. This property isn't indexed.
	SYMB_LASTAUTOMODIFICATIONDATE	Overloaded. Modification date (automatic) # 16023. This property isn't indexed.
	SYMB_LASTMANUMODIFICATIONDATE	Overloaded. Modification date (manual) # 16025. This property isn't indexed.
	SYMB_LASTMODIFICATOR	Overloaded. Last editor: Logon name # 16022. This property isn't indexed.
	SYMB_LOGICMODEL	Overloaded. Target tracking # 16010. This property isn't indexed.
	SYMB_MAINFUNCTION	Overloaded. Main function # 16018. This property isn't indexed.
	SYMB_MODIFICATIONCOMMENT	Overloaded. Modification note # 16024. This property isn't indexed.
	SYMB_MOTOR_CONTACT_IMAGE	Overloaded. Symbol for contact image of motor overload switch # 16032. This property isn't indexed.
	SYMB_NAME	Overloaded. Name # 16000. This property isn't indexed, and is read-only.
	SYMB_NETCONNECTING	Overloaded. Net-connecting # 16043. This property isn't indexed.
	SYMB_NR	Overloaded. Number # 16002. This property isn't indexed, and is read-only.
	SYMB_PLTTYPE	Overloaded. PCT type # 16016. This property isn't indexed.
	SYMB_POTENTIALSEPARATED	Overloaded. With signal isolation # 16042. This property isn't indexed.
	SYMB_PREVENTPLACEMENT	Overloaded. Prevent new placement # 16012. This property isn't indexed.
	SYMB_PROPERTYINSTANCESET	Overloaded. Property arrangements # 16050.
	SYMB_SAFETYRELEVANT	Overloaded. Safety function # 16044. This property isn't indexed.
	SYMB_SUPPLEMENTARYFIELD	Overloaded. Supplementary field # 16013.
	SYMB_SYBMOLFUNCTIONTYPE	Overloaded. Symbol representation type (encoded) # 16027. This property isn't indexed.
	SYMB_SYBMOLFUNCTIONTYPE_NAME	Overloaded. Symbol representation type # 16028. This property isn't indexed, and is read-only.
	SYMB_VERSION	Overloaded. Version # 16026. This property isn't indexed.
	SYMBLIB_NAME	Overloaded. Symbol library # 15000. This property isn't indexed, and is read-only.
	SYMBOL_TRANSFORMATION_POINT	Overloaded. Transformation point # 16045.

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

SymbolPropertyList Members
Eplan.EplApi.DataModel.MasterData Namespace
Symbol Class
StorableObjectPropertyList Class

Send Feedback