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 ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyOverloaded. Document type (single component) # 1528. This property isn't indexed.  
    Public PropertyOverloaded. Functional assignment (single component) # 1328. This property isn't indexed.  
    Public PropertyOverloaded. Higher-level function number (single component) # 1728. This property isn't indexed.  
    Public PropertyOverloaded. Mounting location (single component) # 1228. This property isn't indexed.  
    Public PropertyOverloaded. Installation site (single component) # 1428. This property isn't indexed.  
    Public PropertyOverloaded. Higher-level function (single component) # 1128. This property isn't indexed.  
    Public PropertyOverloaded. Product aspect (single component) # 1828. This property isn't indexed.  
    Public PropertyOverloaded. User-defined structure (single component) # 1628. This property isn't indexed.  
    Public PropertyOverloaded. Basic segment definition: Displayed name # 44042. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Basic segment definition: Name (identifying) # 44039. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Expenditure construction # 44014. This property isn't indexed.  
    Public PropertyOverloaded. Segment definition: Displayed name # 44041. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Segment definition: Name (identifying) # 44001. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Description (Segment) # 44005. This property isn't indexed.  
    Public PropertyOverloaded. Designation # 44004. This property isn't indexed.  
    Public PropertyOverloaded. Documents # 44007.  
    Public PropertyOverloaded. Documents: Designation # 44069.  
    Public PropertyOverloaded. Documents: File / hyperlink # 44068.  
    Public PropertyOverloaded. Designation (full) # 44009. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. GMP-relevant # 44061. This property isn't indexed.  
    Public PropertyOverloaded. Hook-up # 44056. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Macro # 44008. This property isn't indexed.  
    Public PropertyOverloaded. Processing function # 44037. This property isn't indexed.  
    Public PropertyOverloaded. Technical facility # 44035. This property isn't indexed.  
    Public PropertyOverloaded. Implementation # 44043. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Activation site # 44044. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Measurand # 44036. This property isn't indexed.  
    Public PropertyOverloaded. Number # 44038. This property isn't indexed.  
    Public PropertyOverloaded. Pipe class # 44072. This property isn't indexed.  
    Public PropertyOverloaded. Pre-planning finished # 44040. This property isn't indexed.  
    Public PropertyOverloaded. Expenditure planning # 44012. This property isn't indexed.  
    Public PropertyOverloaded. PLC address: Address # 44023.  
    Public PropertyOverloaded. PLC address: Configuration project # 44048.  
    Public PropertyOverloaded. PLC address: Counter # 44064.  
    Public PropertyOverloaded. PLC address: CPU # 44022.  
    Public PropertyOverloaded. PLC address: Data type # 44021.  
    Public PropertyOverloaded. PLC address: Direction # 44020.  
    Public PropertyOverloaded. PLC address: Function text # 44025.  
    Public PropertyOverloaded. PLC address: Workstation # 44047.  
    Public PropertyOverloaded. PLC address: Symbolic address # 44024.  
    Public PropertyOverloaded. PLC address: Symbolic address (single component) # 44052.  
    Public PropertyOverloaded. Power consumption # 44010. This property isn't indexed.  
    Public PropertyOverloaded. Calculation value # 44018. This property isn't indexed.  
    Public PropertyOverloaded. Expenditure software # 44016. This property isn't indexed.  
    Public PropertyOverloaded. Quality-relevant # 44062. This property isn't indexed.  
    Public PropertyOverloaded. Relevant to safety # 44060. This property isn't indexed.  
    Public PropertyOverloaded. Symbolic address (single component) # 44053. This property isn't indexed.  
    Public PropertyOverloaded. Technical description # 44006. This property isn't indexed.  
    Public PropertyOverloaded. User-defined property: Name # 44054.  
    Public PropertyOverloaded. User-defined property: Value # 44055.  
    Public PropertyOverloaded. Segment template: Description # 44049. This property isn't indexed.  
    Public PropertyOverloaded. Segment template: Name (identifying) # 44050. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Usage count # 44057. This property isn't indexed, and is read-only.  
    Public PropertyReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyOverloaded. Suppl. field: Yes / No # 20916.  
    Public PropertyOverloaded. Suppl. field: Text # 20915.  
    Public PropertyOverloaded. Assembly # 20905.  
    Public PropertyOverloaded. Assembly structure # 20922.  
    Public PropertyOverloaded. Assembly variant # 20923.  
    Public PropertyOverloaded. Part allocation # 20904.  
    Public PropertyOverloaded. Used drilling pattern # 20284.  
    Public PropertyOverloaded. Number of units / quantity # 20102.  
    Public PropertyOverloaded. Part: Designation 1 # 20193.  
    Public PropertyOverloaded. Part: Designation 2 # 20194.  
    Public PropertyOverloaded. Part: Designation 3 # 20203.  
    Public PropertyOverloaded. ERP number # 31117.  
    Public PropertyOverloaded. Part: External document 1 # 20190.  
    Public PropertyOverloaded. Part: External document 10 # 20269.  
    Public PropertyOverloaded. Part: External document 11 # 20270.  
    Public PropertyOverloaded. Part: External document 12 # 20271.  
    Public PropertyOverloaded. Part: External document 13 # 20272.  
    Public PropertyOverloaded. Part: External document 14 # 20273.  
    Public PropertyOverloaded. Part: External document 15 # 20274.  
    Public PropertyOverloaded. Part: External document 16 # 20275.  
    Public PropertyOverloaded. Part: External document 17 # 20276.  
    Public PropertyOverloaded. Part: External document 18 # 20277.  
    Public PropertyOverloaded. Part: External document 19 # 20278.  
    Public PropertyOverloaded. Part: External document 2 # 20191.  
    Public PropertyOverloaded. Part: External document 20 # 20279.  
    Public PropertyOverloaded. Part: External document 3 # 20192.  
    Public PropertyOverloaded. Part: External document 4 # 20263.  
    Public PropertyOverloaded. Part: External document 5 # 20264.  
    Public PropertyOverloaded. Part: External document 6 # 20265.  
    Public PropertyOverloaded. Part: External document 7 # 20266.  
    Public PropertyOverloaded. Part: External document 8 # 20267.  
    Public PropertyOverloaded. Part: External document 9 # 20268.  
    Public PropertyOverloaded. External placement # 20917.  
    Public PropertyOverloaded. Function group # 20902.  
    Public PropertyOverloaded. Service time # 20909.  
    Public PropertyOverloaded. Lubrication / maintenance # 20912.  
    Public PropertyOverloaded. Manufacturer # 20921.  
    Public PropertyOverloaded. Part: Mounting surface # 20918.  
    Public PropertyOverloaded. Part description # 31014.  
    Public PropertyOverloaded. Order number # 20919.  
    Public PropertyOverloaded. Subset / length # 31008.  
    Public PropertyOverloaded. Subset / length (full) # 31091.  
    Public PropertyOverloaded. Subset / length in unit of project # 31040.  
    Public PropertyOverloaded. Unit for subset / length # 31012.  
    Public PropertyOverloaded. Subset / length: Value # 31010.  
    Public PropertyOverloaded. Subset / length with unit of project # 31043.  
    Public PropertyOverloaded. Part number # 20100.  
    Public PropertyOverloaded. Record type # 20103.  
    Public PropertyOverloaded. Part group # 20903.  
    Public PropertyOverloaded. Item number # 20464.  
    Public PropertyOverloaded. Quantity / subset in unit of project # 31044.  
    Public PropertyOverloaded. Spare part # 20907.  
    Public PropertyOverloaded. Stress # 20910.  
    Public PropertyOverloaded. Supplier # 20920.  
    Public PropertyOverloaded. Suppress in bill of materials (if filtered) # 20105.  
    Public PropertyOverloaded. Procurement # 20911.  
    Public PropertyOverloaded. Safety-related values: Use case in use # 20307.  
    Public PropertyOverloaded. Part variant # 20101.  
    Public PropertyOverloaded. Wearing part # 20908.  
    Public PropertyOverloaded. Bill of materials group # 20924.  
    Public PropertyOverloaded. Block property: Format # 20202.  
    Public PropertyOverloaded. Remark # 20045. This property isn't indexed.  
    Public PropertyOverloaded. Trade # 20466. This property isn't indexed.  
    Public PropertyOverloaded. Output group # 20033. This property isn't indexed.  
    Public PropertyOverloaded. Subtrade # 20467. This property isn't indexed.  
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyOverloaded. PCT type # 16016. This property isn't indexed.  
    Public PropertyOverloaded. Change protection # 3014. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDestructor for deterministic finalization of SegmentTemplatePropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodOverloaded. Checks property existence for used obiect.  
    Public MethodInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Top
    See Also