API Help
Eplan.EplApi.DataModel Namespace / PotentialDefinitionPropertyList Class
Members Example

In This Topic
    PotentialDefinitionPropertyList Class
    In This Topic
    This class represents collection of properties of PotentialDefinition class. Please check also base classes for other properties which are available for PotentialDefinition objects: SymbolReferencePropertyList, PlacementPropertyList, StorableObjectPropertyList
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.UniversalPropertyList
          Eplan.EplApi.DataModel.StorableObjectPropertyList
             Eplan.EplApi.DataModel.PlacementPropertyList
                Eplan.EplApi.DataModel.SymbolReferencePropertyList
                   Eplan.EplApi.DataModel.PotentialDefinitionPropertyList
                      Eplan.EplApi.DataModel.NetDefinitionPointPropertyList
                      Eplan.EplApi.DataModel.PipingDefinitionPropertyList

    Syntax
    [DefaultMember("Property")]
    public class PotentialDefinitionPropertyList : SymbolReferencePropertyList 
    [DefaultMember("Property")]
    public ref class PotentialDefinitionPropertyList : public SymbolReferencePropertyList 
    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. Autoconnecting line: Color # 31005. This property isn't indexed.  
    Public PropertyOverloaded. Autoconnecting line: Pattern length # 31018. This property isn't indexed.  
    Public PropertyOverloaded. Autoconnecting line: Layer # 31017. This property isn't indexed.  
    Public PropertyOverloaded. Autoconnecting line: Line type # 31015. This property isn't indexed.  
    Public PropertyOverloaded. Autoconnecting line: Line thickness # 31016. This property isn't indexed.  
    Public PropertyOverloaded. Alternative connection cross-section / diameter # 31025. This property isn't indexed.  
    Public PropertyOverloaded. Unit for alternative connection cross-section / diameter # 31065. This property isn't indexed.  
    Public PropertyOverloaded. Connection description # 31009. This property isn't indexed.  
    Public PropertyOverloaded. Connection designation # 31011. This property isn't indexed.  
    Public PropertyOverloaded. Grouping # 31069. This property isn't indexed.  
    Public PropertyOverloaded. Connection: Color (multilingual) # 31061. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Target: Sleeve cross-section # 31054. This property isn't indexed.  
    Public PropertyOverloaded. Source: Sleeve cross-section # 31053. This property isn't indexed.  
    Public PropertyOverloaded. Target: Stripping length # 31056. This property isn't indexed.  
    Public PropertyOverloaded. Source: Stripping length # 31055. This property isn't indexed.  
    Public PropertyOverloaded. Wire termination processing target # 31052. This property isn't indexed.  
    Public PropertyOverloaded. Wire termination processing source # 31051. This property isn't indexed.  
    Public PropertyOverloaded. Connection: Cross-section / diameter # 31002. This property isn't indexed.  
    Public PropertyOverloaded. Unit for connection cross-section / diameter # 31059. This property isn't indexed.  
    Public PropertyOverloaded. Connection: Cross-section / diameter with unit # 31007. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Connection: Length with unit # 31003. This property isn't indexed.  
    Public PropertyOverloaded. Connection: Length (full) # 31090. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Connection: Unit of length # 31001. This property isn't indexed.  
    Public PropertyOverloaded. Connection: Length # 31000. This property isn't indexed.  
    Public PropertyOverloaded. Connection color / number # 31004. This property isn't indexed.  
    Public PropertyOverloaded. Connection: Type designation # 31048. This property isn't indexed.  
    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. Block property: Format # 20202.  
    Public PropertyOverloaded. Block property # 20201.  
    Public PropertyOverloaded. Remark # 20045. This property isn't indexed.  
    Public PropertyOverloaded. Engraving text # 20025. This property isn't indexed.  
    Public PropertyOverloaded. Supplementary field # 20901.  
    Public PropertyOverloaded. Symbol description (function) # 20114. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Symbol name # 20112. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Symbol number # 20168. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Symbol variant # 20113. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Symbol library # 20111. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. ID for net-based connections # 20218.  
    Public PropertyOverloaded. IDs for net-based connections # 20219. This property isn't indexed.  
    Public PropertyOverloaded. Property arrangement # 19307. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Placement # 19007. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name (full) # 19023. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name # 19022. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page type # 19020. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Column number # 19005. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Row number # 19006. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Modification date (change tracking) # 19032. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (change tracking) # 19030. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker format (change tracking) # 19031. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Modification time (change tracking) # 19034. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Creator (change tracking) # 19033. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision change marker (from property comparison) # 10153. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (from property comparison) # 10152. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Representation type / report type # 19021. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. User-defined property arrangement: Name # 19008. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. X coordinate # 19002. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Y coordinate # 19003. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyOverloaded. Frequency # 33004. This property isn't indexed.  
    Public PropertyOverloaded. Name of potential # 33000. This property isn't indexed.  
    Public PropertyOverloaded. Net name # 33007. This property isn't indexed.  
    Public PropertyOverloaded. Superior potential # 33001. This property isn't indexed.  
    Public PropertyOverloaded. Signal name # 33006. This property isn't indexed.  
    Public PropertyOverloaded. Potential type # 31006. This property isn't indexed.  
    Public PropertyOverloaded. Possible counter potentials # 33005. This property isn't indexed.  
    Public PropertyOverloaded. Potential value # 33003. This property isn't indexed.  
    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. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDestructor for deterministic finalization of PotentialDefinitionPropertyList 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