Eplan Platform API
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 PropertyAutoconnecting line: Color # 31005.  
    Public PropertyAutoconnecting line: Pattern length # 31018.  
    Public PropertyAutoconnecting line: Layer # 31017.  
    Public PropertyAutoconnecting line: Line type # 31015.  
    Public PropertyAutoconnecting line: Line thickness # 31016.  
    Public PropertyAlternative connection cross-section / diameter # 31025.  
    Public PropertyUnit for alternative connection cross-section / diameter # 31065.  
    Public PropertyConnection description # 31009.  
    Public PropertyConnection designation # 31011.  
    Public PropertyGrouping # 31069.  
    Public PropertyConnection: Color (multilingual) # 31061.  
    Public PropertyTarget: Sleeve cross-section # 31054.  
    Public PropertySource: Sleeve cross-section # 31053.  
    Public PropertyTarget: Stripping length # 31056.  
    Public PropertySource: Stripping length # 31055.  
    Public PropertyWire termination processing target # 31052.  
    Public PropertyWire termination processing source # 31051.  
    Public PropertyConnection: Cross-section / diameter # 31002.  
    Public PropertyUnit for connection cross-section / diameter # 31059.  
    Public PropertyConnection: Cross-section / diameter with unit # 31007.  
    Public PropertyConnection: Length with unit # 31003.  
    Public PropertyConnection: Length (full) # 31090.  
    Public PropertyConnection: Unit of length # 31001.  
    Public PropertyConnection: Length # 31000.  
    Public PropertyConnection color / number # 31004.  
    Public PropertyConnection: Type designation # 31048.  
    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 PropertyBlock property: Format # 20202.  
    Public PropertyBlock property # 20201.  
    Public PropertyRemark # 20045.  
    Public PropertyEngraving text # 20025.  
    Public PropertySupplementary field # 20901.  
    Public PropertyOverloaded. Symbol description (function) # 20114. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol name # 20112. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol number # 20168. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol variant # 20113. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol library # 20111. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol # 20575. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyID for net-based connections # 20218.  
    Public PropertyIDs for net-based connections # 20219.  
    Public PropertyOverloaded. Property arrangement # 19307. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Modification date (change tracking) # 19032. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (change tracking) # 19030. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker format (change tracking) # 19031. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Modification time (change tracking) # 19034. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Creator (change tracking) # 19033. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision change marker (from property comparison) # 10153. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (from property comparison) # 10152. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Representation type / report type # 19021. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. User-defined property arrangement: Name # 19008. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Y coordinate # 19003. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyFrequency # 33004.  
    Public PropertyName of potential # 33000.  
    Public PropertyNet name # 33007.  
    Public PropertySuperior potential # 33001.  
    Public PropertySignal name # 33006.  
    Public PropertyPotential type # 31006.  
    Public PropertyPossible counter potentials # 33005.  
    Public PropertyPotential value # 33003.  
    Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyOverloaded. Change protection (hierarchical) # 3015. (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