SegmentTemplatePropertyList Class

In This Topic

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

Inheritance Hierarchy

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

Syntax

C#
C++/CLI

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

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

Top

Public Properties

	Name	Description
	DESIGNATION_DOCTYPE_PART	Overloaded. Document type (single component) # 1528. This property isn't indexed.
	DESIGNATION_FUNCTIONALASSIGNMENT_PART	Overloaded. Functional assignment (single component) # 1328. This property isn't indexed.
	DESIGNATION_INSTALLATIONNUMBER_PART	Overloaded. Higher-level function number (single component) # 1728. This property isn't indexed.
	DESIGNATION_LOCATION_PART	Overloaded. Mounting location (single component) # 1228. This property isn't indexed.
	DESIGNATION_PLACEOFINSTALLATION_PART	Overloaded. Installation site (single component) # 1428. This property isn't indexed.
	DESIGNATION_PLANT_PART	Overloaded. Higher-level function (single component) # 1128. This property isn't indexed.
	DESIGNATION_PRODUCT_PART	Overloaded. Product aspect (single component) # 1828. This property isn't indexed.
	DESIGNATION_USERDEFINED_PART	Overloaded. User-defined structure (single component) # 1628. This property isn't indexed.
	DMPLAOBJECT_BASEDEFINITIONDISPLAYNAME	Overloaded. Basic segment definition: Displayed name # 44042. This property isn't indexed, and is read-only.
	DMPLAOBJECT_BASEDEFINITIONNAME	Overloaded. Basic segment definition: Name (identifying) # 44039. This property isn't indexed, and is read-only.
	DMPLAOBJECT_BUILDINGTIME	Overloaded. Expenditure construction # 44014. This property isn't indexed.
	DMPLAOBJECT_DEFINITIONDISPLAYNAME	Overloaded. Segment definition: Displayed name # 44041. This property isn't indexed, and is read-only.
	DMPLAOBJECT_DEFINITIONNAME	Overloaded. Segment definition: Name (identifying) # 44001. This property isn't indexed, and is read-only.
	DMPLAOBJECT_DESCRIPTION	Overloaded. Description (Segment) # 44005. This property isn't indexed.
	DMPLAOBJECT_DESIGNATION	Overloaded. Designation # 44004. This property isn't indexed.
	DMPLAOBJECT_DOCUMENTS	Overloaded. Documents # 44007.
	DMPLAOBJECT_DOCUMENTS_DESIGNATION	Overloaded. Documents: Designation # 44069.
	DMPLAOBJECT_DOCUMENTS_URL	Overloaded. Documents: File / hyperlink # 44068.
	DMPLAOBJECT_FULLDESIGNATION	Overloaded. Designation (full) # 44009. This property isn't indexed, and is read-only.
	DMPLAOBJECT_GMP_RELEVANT	Overloaded. GMP-relevant # 44061. This property isn't indexed.
	DMPLAOBJECT_HOOKUP	Overloaded. Hook-up # 44056. This property isn't indexed, and is read-only.
	DMPLAOBJECT_MACRO	Overloaded. Macro # 44008. This property isn't indexed.
	DMPLAOBJECT_PCT_FUNCTION	Overloaded. Processing function # 44037. This property isn't indexed.
	DMPLAOBJECT_PCT_IDENTIFIER	Overloaded. Technical facility # 44035. This property isn't indexed.
	DMPLAOBJECT_PCT_IMPLEMENTATION	Overloaded. Implementation # 44043. This property isn't indexed, and is read-only.
	DMPLAOBJECT_PCT_LOCATION	Overloaded. Activation site # 44044. This property isn't indexed, and is read-only.
	DMPLAOBJECT_PCT_MEASURAND	Overloaded. Measurand # 44036. This property isn't indexed.
	DMPLAOBJECT_PCT_NUMBER	Overloaded. Number # 44038. This property isn't indexed.
	DMPLAOBJECT_PIPECLASS	Overloaded. Pipe class # 44072. This property isn't indexed.
	DMPLAOBJECT_PLANNING_COMPLETE	Overloaded. Pre-planning finished # 44040. This property isn't indexed.
	DMPLAOBJECT_PLANNINGTIME	Overloaded. Expenditure planning # 44012. This property isn't indexed.
	DMPLAOBJECT_PLCADDRESS_ADDRESS	Overloaded. PLC address: Address # 44023.
	DMPLAOBJECT_PLCADDRESS_CONFIGURATIONPROJECT	Overloaded. PLC address: Configuration project # 44048.
	DMPLAOBJECT_PLCADDRESS_COUNTER	Overloaded. PLC address: Counter # 44064.
	DMPLAOBJECT_PLCADDRESS_CPU	Overloaded. PLC address: CPU # 44022.
	DMPLAOBJECT_PLCADDRESS_DATATYPE	Overloaded. PLC address: Data type # 44021.
	DMPLAOBJECT_PLCADDRESS_DIRECTION	Overloaded. PLC address: Direction # 44020.
	DMPLAOBJECT_PLCADDRESS_FUNCTIONTEXT	Overloaded. PLC address: Function text # 44025.
	DMPLAOBJECT_PLCADDRESS_STATION	Overloaded. PLC address: Workstation # 44047.
	DMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS	Overloaded. PLC address: Symbolic address # 44024.
	DMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_PART	Overloaded. PLC address: Symbolic address (single component) # 44052.
	DMPLAOBJECT_POWER_REQUIREMENT	Overloaded. Power consumption # 44010. This property isn't indexed.
	DMPLAOBJECT_PRICE	Overloaded. Calculation value # 44018. This property isn't indexed.
	DMPLAOBJECT_PROGRAMMINGTIME	Overloaded. Expenditure software # 44016. This property isn't indexed.
	DMPLAOBJECT_QUALITY_RELEVANT	Overloaded. Quality-relevant # 44062. This property isn't indexed.
	DMPLAOBJECT_SAFETY_RELEVANT	Overloaded. Relevant to safety # 44060. This property isn't indexed.
	DMPLAOBJECT_SYMBOLICADDRESS_PART	Overloaded. Symbolic address (single component) # 44053. This property isn't indexed.
	DMPLAOBJECT_TECHNICAL_DESCRIPTION	Overloaded. Technical description # 44006. This property isn't indexed.
	DMPLAOBJECT_USERPROPERTY_NAME	Overloaded. User-defined property: Name # 44054.
	DMPLAOBJECT_USERPROPERTY_VALUE	Overloaded. User-defined property: Value # 44055.
	DMPLASPECIFICATION_DESCRIPTION	Overloaded. Segment template: Description # 44049. This property isn't indexed.
	DMPLASPECIFICATION_NAME	Overloaded. Segment template: Name (identifying) # 44050. This property isn't indexed, and is read-only.
	DMPLASPECIFICATION_OBJECT_COUNT	Overloaded. Usage count # 44057. This property isn't indexed, and is read-only.
	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_ARTICLE_ADDITIONAL_BOOLFIELD	Overloaded. Suppl. field: Yes / No # 20916.
	FUNC_ARTICLE_ADDITIONAL_TEXTFIELD	Overloaded. Suppl. field: Text # 20915.
	FUNC_ARTICLE_ASSEMBLY	Overloaded. Assembly # 20905.
	FUNC_ARTICLE_ASSEMBLY_STRUCTURE	Overloaded. Assembly structure # 20922.
	FUNC_ARTICLE_ASSEMBLYVARIANT	Overloaded. Assembly variant # 20923.
	FUNC_ARTICLE_ASSIGNMENT	Overloaded. Part allocation # 20904.
	FUNC_ARTICLE_CONSTRUCTION	Overloaded. Used drilling pattern # 20284.
	FUNC_ARTICLE_COUNT	Overloaded. Number of units / quantity # 20102.
	FUNC_ARTICLE_DESCR1	Overloaded. Part: Designation 1 # 20193.
	FUNC_ARTICLE_DESCR2	Overloaded. Part: Designation 2 # 20194.
	FUNC_ARTICLE_DESCR3	Overloaded. Part: Designation 3 # 20203.
	FUNC_ARTICLE_ERPNR	Overloaded. ERP number # 31117.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_1	Overloaded. Part: External document 1 # 20190.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_10	Overloaded. Part: External document 10 # 20269.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_11	Overloaded. Part: External document 11 # 20270.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_12	Overloaded. Part: External document 12 # 20271.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_13	Overloaded. Part: External document 13 # 20272.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_14	Overloaded. Part: External document 14 # 20273.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_15	Overloaded. Part: External document 15 # 20274.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_16	Overloaded. Part: External document 16 # 20275.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_17	Overloaded. Part: External document 17 # 20276.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_18	Overloaded. Part: External document 18 # 20277.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_19	Overloaded. Part: External document 19 # 20278.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_2	Overloaded. Part: External document 2 # 20191.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_20	Overloaded. Part: External document 20 # 20279.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_3	Overloaded. Part: External document 3 # 20192.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_4	Overloaded. Part: External document 4 # 20263.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_5	Overloaded. Part: External document 5 # 20264.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_6	Overloaded. Part: External document 6 # 20265.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_7	Overloaded. Part: External document 7 # 20266.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_8	Overloaded. Part: External document 8 # 20267.
	FUNC_ARTICLE_EXTERNAL_DOCUMENT_9	Overloaded. Part: External document 9 # 20268.
	FUNC_ARTICLE_EXTERNAL_PLACEMENT	Overloaded. External placement # 20917.
	FUNC_ARTICLE_FUNCTIONGROUP	Overloaded. Function group # 20902.
	FUNC_ARTICLE_LIFETIME	Overloaded. Service time # 20909.
	FUNC_ARTICLE_MAINTENANCE	Overloaded. Lubrication / maintenance # 20912.
	FUNC_ARTICLE_MANUFACTURER	Overloaded. Manufacturer # 20921.
	FUNC_ARTICLE_MOUNTINGSITE	Overloaded. Part: Mounting surface # 20918.
	FUNC_ARTICLE_NOTE	Overloaded. Part description # 31014.
	FUNC_ARTICLE_ORDERNR	Overloaded. Order number # 20919.
	FUNC_ARTICLE_PARTIAL_LENGTH	Overloaded. Subset / length # 31008.
	FUNC_ARTICLE_PARTIAL_LENGTH_FULL	Overloaded. Subset / length (full) # 31091.
	FUNC_ARTICLE_PARTIAL_LENGTH_IN_PROJECT_UNIT	Overloaded. Subset / length in unit of project # 31040.
	FUNC_ARTICLE_PARTIAL_LENGTH_UNIT	Overloaded. Unit for subset / length # 31012.
	FUNC_ARTICLE_PARTIAL_LENGTH_VALUE	Overloaded. Subset / length: Value # 31010.
	FUNC_ARTICLE_PARTIAL_LENGTH_WITH_PROJECT_UNIT	Overloaded. Subset / length with unit of project # 31043.
	FUNC_ARTICLE_PARTNR	Overloaded. Part number # 20100.
	FUNC_ARTICLE_PARTTYPE	Overloaded. Record type # 20103.
	FUNC_ARTICLE_PIECETYPE	Overloaded. Part group # 20903.
	FUNC_ARTICLE_POSNR	Overloaded. Item number # 20464.
	FUNC_ARTICLE_QUANTITY_IN_PROJECT_UNIT	Overloaded. Quantity / subset in unit of project # 31044.
	FUNC_ARTICLE_SPARE	Overloaded. Spare part # 20907.
	FUNC_ARTICLE_STRESS	Overloaded. Stress # 20910.
	FUNC_ARTICLE_SUPPLIER	Overloaded. Supplier # 20920.
	FUNC_ARTICLE_SUPPRESSINPARTSLIST	Overloaded. Suppress in bill of materials (if filtered) # 20105.
	FUNC_ARTICLE_USAGE	Overloaded. Procurement # 20911.
	FUNC_ARTICLE_USED_SAFETYRELATEDVALUE	Overloaded. Safety-related values: Use case in use # 20307.
	FUNC_ARTICLE_VARIANT	Overloaded. Part variant # 20101.
	FUNC_ARTICLE_WEAR	Overloaded. Wearing part # 20908.
	FUNC_ARTICLEREF_PARTSLISTGROUP	Overloaded. Bill of materials group # 20924.
	FUNC_BLOCK_FORMAT	Overloaded. Block property: Format # 20202.
	FUNC_COMMENT	Overloaded. Remark # 20045. This property isn't indexed.
	FUNC_CRAFT	Overloaded. Trade # 20466. This property isn't indexed.
	FUNC_OUTPUTASSEMBLY	Overloaded. Output group # 20033. This property isn't indexed.
	FUNC_SUBCRAFT	Overloaded. Subtrade # 20467. This property isn't indexed.
	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)
	SYMB_PLTTYPE	Overloaded. PCT type # 16016. This property isn't indexed.
	WRITEPROTECTED	Overloaded. Change protection # 3014. This property isn't indexed, and is read-only.
	WRITEPROTECTED_AUTOMATIC	Overloaded. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only.

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

SegmentTemplatePropertyList Members
Eplan.EplApi.DataModel.Planning Namespace
SegmentTemplate Class
StorableObjectPropertyList Class

Send Feedback