API Help
Eplan.EplApi.DataModel.Planning Namespace / SegmentTemplatePropertyList Class
Members Example

In This Topic
    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
    [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
     NameDescription
    Public ConstructorSegmentTemplatePropertyList ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyDESIGNATION_DOCTYPE_PARTOverloaded. Document type (single component) # 1528. This property isn't indexed.  
    Public PropertyDESIGNATION_FUNCTIONALASSIGNMENT_PARTOverloaded. Functional assignment (single component) # 1328. This property isn't indexed.  
    Public PropertyDESIGNATION_INSTALLATIONNUMBER_PARTOverloaded. Higher-level function number (single component) # 1728. This property isn't indexed.  
    Public PropertyDESIGNATION_LOCATION_PARTOverloaded. Mounting location (single component) # 1228. This property isn't indexed.  
    Public PropertyDESIGNATION_PLACEOFINSTALLATION_PARTOverloaded. Installation site (single component) # 1428. This property isn't indexed.  
    Public PropertyDESIGNATION_PLANT_PARTOverloaded. Higher-level function (single component) # 1128. This property isn't indexed.  
    Public PropertyDESIGNATION_PRODUCT_PARTOverloaded. Product aspect (single component) # 1828. This property isn't indexed.  
    Public PropertyDESIGNATION_USERDEFINED_PARTOverloaded. User-defined structure (single component) # 1628. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_BASEDEFINITIONDISPLAYNAMEOverloaded. Basic segment definition: Displayed name # 44042. This property isn't indexed, and is read-only.  
    Public PropertyDMPLAOBJECT_BASEDEFINITIONNAMEOverloaded. Basic segment definition: Name (identifying) # 44039. This property isn't indexed, and is read-only.  
    Public PropertyDMPLAOBJECT_BUILDINGTIMEOverloaded. Expenditure construction # 44014. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_DEFINITIONDISPLAYNAMEOverloaded. Segment definition: Displayed name # 44041. This property isn't indexed, and is read-only.  
    Public PropertyDMPLAOBJECT_DEFINITIONNAMEOverloaded. Segment definition: Name (identifying) # 44001. This property isn't indexed, and is read-only.  
    Public PropertyDMPLAOBJECT_DESCRIPTIONOverloaded. Description (Segment) # 44005. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_DESIGNATIONOverloaded. Designation # 44004. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_DOCUMENTSOverloaded. Documents # 44007.  
    Public PropertyDMPLAOBJECT_DOCUMENTS_DESIGNATIONOverloaded. Documents: Designation # 44069.  
    Public PropertyDMPLAOBJECT_DOCUMENTS_URLOverloaded. Documents: File / hyperlink # 44068.  
    Public PropertyDMPLAOBJECT_FULLDESIGNATIONOverloaded. Designation (full) # 44009. This property isn't indexed, and is read-only.  
    Public PropertyDMPLAOBJECT_GMP_RELEVANTOverloaded. GMP-relevant # 44061. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_HOOKUPOverloaded. Hook-up # 44056. This property isn't indexed, and is read-only.  
    Public PropertyDMPLAOBJECT_MACROOverloaded. Macro # 44008. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PCT_FUNCTIONOverloaded. Processing function # 44037. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PCT_IDENTIFIEROverloaded. Technical facility # 44035. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PCT_IMPLEMENTATIONOverloaded. Implementation # 44043. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PCT_LOCATIONOverloaded. Activation site # 44044. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PCT_MEASURANDOverloaded. Measurand # 44036. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PCT_NUMBEROverloaded. Number # 44038. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PIPECLASSOverloaded. Pipe class # 44072. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PLAMACROOverloaded. Macro for pre-planning and P&I diagram # 44084. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PLANNING_COMPLETEOverloaded. Pre-planning finished # 44040. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PLANNINGTIMEOverloaded. Expenditure planning # 44012. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_ADDRESSOverloaded. PLC address: Address # 44023.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_CONFIGURATIONPROJECTOverloaded. PLC address: Configuration project # 44048.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_COUNTEROverloaded. PLC address: Counter # 44064.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_CPUOverloaded. PLC address: CPU # 44022.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_DATATYPEOverloaded. PLC address: Data type # 44021.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_DIRECTIONOverloaded. PLC address: Direction # 44020.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_FUNCTIONTEXTOverloaded. PLC address: Function text # 44025.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_STATIONOverloaded. PLC address: Workstation # 44047.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESSOverloaded. PLC address: Symbolic address # 44024.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_GROUPOverloaded. PLC address: Symbolic address: Group # 44087.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_PARTOverloaded. PLC address: Symbolic address (single component) # 44052.  
    Public PropertyDMPLAOBJECT_POWER_REQUIREMENTOverloaded. Power consumption # 44010. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PRICEOverloaded. Calculation value # 44018. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_PROGRAMMINGTIMEOverloaded. Expenditure software # 44016. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_QUALITY_RELEVANTOverloaded. Quality-relevant # 44062. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_SAFETY_RELEVANTOverloaded. Relevant to safety # 44060. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_SYMBOLICADDRESS_PARTOverloaded. Symbolic address (single component) # 44053. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_TECHNICAL_DESCRIPTIONOverloaded. Technical description # 44006. This property isn't indexed.  
    Public PropertyDMPLAOBJECT_USERPROPERTY_NAMEOverloaded. User-defined property: Name # 44054.  
    Public PropertyDMPLAOBJECT_USERPROPERTY_VALUEOverloaded. User-defined property: Value # 44055.  
    Public PropertyDMPLASPECIFICATION_DESCRIPTIONOverloaded. Segment template: Description # 44049. This property isn't indexed.  
    Public PropertyDMPLASPECIFICATION_NAMEOverloaded. Segment template: Name (identifying) # 44050. This property isn't indexed, and is read-only.  
    Public PropertyDMPLASPECIFICATION_OBJECT_COUNTOverloaded. Usage count # 44057. This property isn't indexed, and is read-only.  
    Public PropertyExistingIdsReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyExistingValuesReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyFUNC_ARTICLE_ADDITIONAL_BOOLFIELDOverloaded. Suppl. field: Yes / No # 20916.  
    Public PropertyFUNC_ARTICLE_ADDITIONAL_TEXTFIELDOverloaded. Suppl. field: Text # 20915.  
    Public PropertyFUNC_ARTICLE_ASSEMBLYOverloaded. Assembly # 20905.  
    Public PropertyFUNC_ARTICLE_ASSEMBLY_STRUCTUREOverloaded. Assembly structure # 20922.  
    Public PropertyFUNC_ARTICLE_ASSEMBLYVARIANTOverloaded. Assembly variant # 20923.  
    Public PropertyFUNC_ARTICLE_ASSIGNMENTOverloaded. Part allocation # 20904.  
    Public PropertyFUNC_ARTICLE_CONSTRUCTIONOverloaded. Used drilling pattern # 20284.  
    Public PropertyFUNC_ARTICLE_COUNTOverloaded. Number of units / quantity # 20102.  
    Public PropertyFUNC_ARTICLE_DESCR1Overloaded. Part: Designation 1 # 20193.  
    Public PropertyFUNC_ARTICLE_DESCR2Overloaded. Part: Designation 2 # 20194.  
    Public PropertyFUNC_ARTICLE_DESCR3Overloaded. Part: Designation 3 # 20203.  
    Public PropertyFUNC_ARTICLE_ERPNROverloaded. ERP number # 31117.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_1Overloaded. Part: External document 1 # 20190.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_10Overloaded. Part: External document 10 # 20269.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_11Overloaded. Part: External document 11 # 20270.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_12Overloaded. Part: External document 12 # 20271.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_13Overloaded. Part: External document 13 # 20272.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_14Overloaded. Part: External document 14 # 20273.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_15Overloaded. Part: External document 15 # 20274.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_16Overloaded. Part: External document 16 # 20275.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_17Overloaded. Part: External document 17 # 20276.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_18Overloaded. Part: External document 18 # 20277.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_19Overloaded. Part: External document 19 # 20278.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_2Overloaded. Part: External document 2 # 20191.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_20Overloaded. Part: External document 20 # 20279.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_3Overloaded. Part: External document 3 # 20192.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_4Overloaded. Part: External document 4 # 20263.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_5Overloaded. Part: External document 5 # 20264.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_6Overloaded. Part: External document 6 # 20265.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_7Overloaded. Part: External document 7 # 20266.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_8Overloaded. Part: External document 8 # 20267.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_9Overloaded. Part: External document 9 # 20268.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_PLACEMENTOverloaded. External placement # 20917.  
    Public PropertyFUNC_ARTICLE_FUNCTIONGROUPOverloaded. Function group # 20902.  
    Public PropertyFUNC_ARTICLE_LIFETIMEOverloaded. Service time # 20909.  
    Public PropertyFUNC_ARTICLE_MAINTENANCEOverloaded. Lubrication / maintenance # 20912.  
    Public PropertyFUNC_ARTICLE_MANUFACTUREROverloaded. Manufacturer # 20921.  
    Public PropertyFUNC_ARTICLE_MOUNTINGSITEOverloaded. Part: Mounting surface # 20918.  
    Public PropertyFUNC_ARTICLE_NOTEOverloaded. Part description # 31014.  
    Public PropertyFUNC_ARTICLE_ORDERNROverloaded. Order number # 20919.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTHOverloaded. Subset / length # 31008.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_FULLOverloaded. Subset / length (full) # 31091.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_IN_PROJECT_UNITOverloaded. Subset / length in unit of project # 31040.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_UNITOverloaded. Unit for subset / length # 31012.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_VALUEOverloaded. Subset / length: Value # 31010.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_WITH_PROJECT_UNITOverloaded. Subset / length with unit of project # 31043.  
    Public PropertyFUNC_ARTICLE_PARTNROverloaded. Part number # 20100.  
    Public PropertyFUNC_ARTICLE_PARTTYPEOverloaded. Record type # 20103.  
    Public PropertyFUNC_ARTICLE_PIECETYPEOverloaded. Part group # 20903.  
    Public PropertyFUNC_ARTICLE_POSNROverloaded. Item number # 20464.  
    Public PropertyFUNC_ARTICLE_QUANTITY_IN_PROJECT_UNITOverloaded. Quantity / subset in unit of project # 31044.  
    Public PropertyFUNC_ARTICLE_SPAREOverloaded. Spare part # 20907.  
    Public PropertyFUNC_ARTICLE_STRESSOverloaded. Stress # 20910.  
    Public PropertyFUNC_ARTICLE_SUPPLIEROverloaded. Supplier # 20920.  
    Public PropertyFUNC_ARTICLE_SUPPRESSINPARTSLISTOverloaded. Suppress in bill of materials (if filtered) # 20105.  
    Public PropertyFUNC_ARTICLE_USAGEOverloaded. Procurement # 20911.  
    Public PropertyFUNC_ARTICLE_USED_SAFETYRELATEDVALUEOverloaded. Safety-related values: Use case in use # 20307.  
    Public PropertyFUNC_ARTICLE_VARIANTOverloaded. Part variant # 20101.  
    Public PropertyFUNC_ARTICLE_WEAROverloaded. Wearing part # 20908.  
    Public PropertyFUNC_ARTICLEREF_PARTSLISTGROUPOverloaded. Bill of materials group # 20924.  
    Public PropertyFUNC_BLOCK_FORMATOverloaded. Block property: Format # 20202.  
    Public PropertyFUNC_COMMENTOverloaded. Remark # 20045. This property isn't indexed.  
    Public PropertyFUNC_CRAFTOverloaded. Trade # 20466. This property isn't indexed.  
    Public PropertyFUNC_OUTPUTASSEMBLYOverloaded. Output group # 20033. This property isn't indexed.  
    Public PropertyFUNC_SUBCRAFTOverloaded. Subtrade # 20467. This property isn't indexed.  
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertySYMB_PLTTYPEOverloaded. PCT type # 16016. This property isn't indexed.  
    Public PropertyWRITEPROTECTEDOverloaded. Change protection # 3014. This property isn't indexed, and is read-only.  
    Public PropertyWRITEPROTECTED_AUTOMATICOverloaded. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only.  
    Top
    Public Methods
     NameDescription
    Public MethodCopyToOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDispose()Destructor for deterministic finalization of SegmentTemplatePropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodExistsOverloaded. Checks property existence for used obiect.  
    Public MethodgetPropListInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Top
    See Also

    Reference

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

     

     

    EPLAN API , 21.05.2020, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

    Send Feedback