SegmentPlacementPropertyList Class

In This Topic

This class represents a collection of properties of SegmentPlacement class. Please also check the base classes for other properties that are available for SegmentPlacement objects: Eplan.EplApi.DataModel.SymbolReferencePropertyList, Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.StorableObjectPropertyList

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.PlacementPropertyList
            Eplan.EplApi.DataModel.SymbolReferencePropertyList
               Eplan.EplApi.DataModel.Planning.SegmentPlacementPropertyList

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class SegmentPlacementPropertyList : Eplan.EplApi.DataModel.SymbolReferencePropertyList

[DefaultMember("Property")]
public ref class SegmentPlacementPropertyList : public Eplan.EplApi.DataModel.SymbolReferencePropertyList

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

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_CROSSREFERENCE	Cross-reference (main / aux. function) # 20300.
	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)
	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)
	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 SegmentPlacementPropertyList 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

SegmentPlacementPropertyList Members
Eplan.EplApi.DataModel.Planning Namespace
SegmentPlacement Class
SymbolReferencePropertyList Class

Use the Eplan Global Support Portal for feedback and support