PotentialDefinitionPropertyList Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Example
Public Constructors
Public Properties
Public Methods
See Also

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

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.PlacementPropertyList
            Eplan.EplApi.DataModel.SymbolReferencePropertyList
               Eplan.EplApi.DataModel.PotentialDefinitionPropertyList
                  Eplan.EplApi.DataModel.NetDefinitionPointPropertyList
                  Eplan.EplApi.DataModel.PipingDefinitionPropertyList

Syntax

C#
C++/CLI

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

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

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
	PotentialDefinitionPropertyList Constructor	Overloaded.

Top

Public Properties

	Name	Description
	CONNECTION_ACL_COLOR	Autoconnecting line: Color # 31005.
	CONNECTION_ACL_FACTOR	Autoconnecting line: Pattern length # 31018.
	CONNECTION_ACL_LAYER	Autoconnecting line: Layer # 31017.
	CONNECTION_ACL_STYLE	Autoconnecting line: Line type # 31015.
	CONNECTION_ACL_WIDTH	Autoconnecting line: Line thickness # 31016.
	CONNECTION_ALTERNATE_WIRECROSSSECTION	Alternative connection cross-section / diameter # 31025.
	CONNECTION_ALTERNATE_WIRECROSSSECTION_UNIT	Unit for alternative connection cross-section / diameter # 31065.
	CONNECTION_DESCRIPTION	Connection description # 31009.
	CONNECTION_DESIGNATION	Connection designation # 31011.
	CONNECTION_GROUPING	Grouping # 31069.
	CONNECTION_MLWIRENUMBER	Connection: Color (multilingual) # 31061.
	CONNECTION_SLEEVECROSSSECTION_DESTINATION	Target: Sleeve cross-section # 31054.
	CONNECTION_SLEEVECROSSSECTION_SOURCE	Source: Sleeve cross-section # 31053.
	CONNECTION_STRIPPINGLENGTH_DESIGNATION	Target: Stripping length # 31056.
	CONNECTION_STRIPPINGLENGTH_SOURCE	Source: Stripping length # 31055.
	CONNECTION_TYPEOFENDSTOP_DESTINATION	Wire termination processing target # 31052.
	CONNECTION_TYPEOFENDSTOP_SOURCE	Wire termination processing source # 31051.
	CONNECTION_WIRECROSSSECTION	Connection: Cross-section / diameter # 31002.
	CONNECTION_WIRECROSSSECTION_UNIT	Unit for connection cross-section / diameter # 31059.
	CONNECTION_WIRECROSSSECTION_WITH_UNIT	Connection: Cross-section / diameter with unit # 31007.
	CONNECTION_WIRELENGTH	Connection: Length with unit # 31003.
	CONNECTION_WIRELENGTH_FULL	Connection: Length (full) # 31090.
	CONNECTION_WIRELENGTH_UNIT	Connection: Unit of length # 31001.
	CONNECTION_WIRELENGTH_VALUE	Connection: Length # 31000.
	CONNECTION_WIRENUMBER	Connection color / number # 31004.
	CONNECTION_WIRETYPE	Connection: Type designation # 31048.
	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	Block property: Format # 20202.
	FUNC_BLOCK_VALUE	Block property # 20201.
	FUNC_COMMENT	Remark # 20045.
	FUNC_GRAVINGTEXT	Engraving text # 20025.
	FUNC_SUPPLEMENTARYFIELD	Supplementary field # 20901.
	FUNC_SYMB_DESC	Overloaded. Symbol description (function) # 20114. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMB_NAME	Overloaded. Symbol name # 20112. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMB_NUMBER	Overloaded. Symbol number # 20168. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMB_VARIANT	Overloaded. Symbol variant # 20113. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMBLIB_NAME	Overloaded. Symbol library # 20111. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMBOL	Overloaded. Symbol # 20575. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNCTION_NETBASEDWIRING_ID	ID for net-based connections # 20218.
	FUNCTION_NETBASEDWIRING_IDS	IDs for net-based connections # 20219.
	INSTANCE_ACTIVE_PROPERTYSET	Overloaded. Property arrangement # 19307. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_FULLPLACEMENTLOCATION	Overloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGEFULLNAME	Overloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGENAME	Overloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGETYPE	Overloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PATHID	Overloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_POSID	Overloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	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	Overloaded. Representation type / report type # 19021. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_USER_DEFINED_PROPERTYSET	Overloaded. User-defined property arrangement: Name # 19008. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_XCOORD	Overloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_YCOORD	Overloaded. Y coordinate # 19003. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	Parent	StorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	POTENTIAL_FREQUENCE	Frequency # 33004.
	POTENTIAL_NAME	Name of potential # 33000.
	POTENTIAL_NETNAME	Net name # 33007.
	POTENTIAL_PARENT	Superior potential # 33001.
	POTENTIAL_SIGNAL	Signal name # 33006.
	POTENTIAL_TYPE	Potential type # 31006.
	POTENTIAL_VALID_POTENTIALS	Possible counter potentials # 33005.
	POTENTIAL_VALUE	Potential value # 33003.
	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 PotentialDefinitionPropertyList 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

PotentialDefinitionPropertyList Members
Eplan.EplApi.DataModel Namespace
PotentialDefinition Class
SymbolReferencePropertyList Class

Send Feedback