SegmentDefinitionPropertyList Class

In This Topic

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

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.Planning.SegmentDefinitionPropertyList

Syntax

C#
C++/CLI

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

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

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

Top

Public Properties

	Name	Description
	DMPLAOBJECTDEFINITION_BEGINWITHPREFIX	Segment definition: Preceding sign also at the beginning # 44046.
	DMPLAOBJECTDEFINITION_DISPLAYNAME_FORMAT	Display format: Segment name # 44002.
	DMPLAOBJECTDEFINITION_NAME	Segment definition: Displayed name # 44003.
	DMPLAOBJECTDEFINITION_NO_STRUCTUREDELIMITER	Structure identifiers without separators # 44033.
	DMPLAOBJECTDEFINITION_NUMBER_NO_SPACE	Segment definition: No blank space before the number # 44091.
	DMPLAOBJECTDEFINITION_PREFIX	Segment definition: Preceding sign # 44045.
	DMPLAOBJECTDEFINITION_PREFIX_SA	Segment definition: Separator symbolic address # 44090.
	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_CRAFT	Trade # 20466.
	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	Change protection # 3014.
	WRITEPROTECTED_AUTOMATIC	Change protection (hierarchical) # 3015.

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

SegmentDefinitionPropertyList Members
Eplan.EplApi.DataModel.Planning Namespace
SegmentDefinition Class
StorableObjectPropertyList Class

Use the Eplan Global Support Portal for feedback and support