Eplan Platform API
Eplan.EplApi.DataModel Namespace / PipingDefinitionPropertyList Class
Members Example

In This Topic
    PipingDefinitionPropertyList Class
    In This Topic
    This class represents collection of properties of PipingDefinition class. Please check also base classes for other properties which are available for PipingDefinition objects: PotentialDefinitionPropertyList, 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.PipingDefinitionPropertyList

    Syntax
    [DefaultMember("Property")]
public class PipingDefinitionPropertyList : PotentialDefinitionPropertyList 
    [DefaultMember("Property")]
public ref class PipingDefinitionPropertyList : public PotentialDefinitionPropertyList
    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 ConstructorPipingDefinitionPropertyList ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyARTICLE_MATERIALMaterial # 22081.  
    Public PropertyARTICLE_NORMStandard # 22227.  
    Public PropertyARTICLE_PIPECLASSPipe class # 22224.  
    Public PropertyARTICLE_PRESSURELEVELNominal pressure level # 22226.  
    Public PropertyARTICLE_WIDTHRATINGNominal width # 22225.  
    Public PropertyCONNECTION_ACL_COLOROverloaded. Autoconnecting line: Color # 31005. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_ACL_FACTOROverloaded. Autoconnecting line: Pattern length # 31018. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_ACL_LAYEROverloaded. Autoconnecting line: Layer # 31017. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_ACL_STYLEOverloaded. Autoconnecting line: Line type # 31015. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_ACL_WIDTHOverloaded. Autoconnecting line: Line thickness # 31016. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_ALTERNATE_WIRECROSSSECTIONOverloaded. Alternative connection cross-section / diameter # 31025. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_ALTERNATE_WIRECROSSSECTION_UNITOverloaded. Unit for alternative connection cross-section / diameter # 31065. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_DESCRIPTIONOverloaded. Connection description # 31009. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_DESIGNATIONOverloaded. Connection designation # 31011. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_FLOWFlow # 31085.  
    Public PropertyCONNECTION_GROUPINGOverloaded. Grouping # 31069. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_MEDIUMSubstance # 31068.  
    Public PropertyCONNECTION_MLWIRENUMBEROverloaded. Connection: Color (multilingual) # 31061. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_PIPENAMEPiping name # 31157.  
    Public PropertyCONNECTION_PRESSUREPressure # 31082.  
    Public PropertyCONNECTION_SLEEVECROSSSECTION_DESTINATIONOverloaded. Target: Sleeve cross-section # 31054. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_SLEEVECROSSSECTION_SOURCEOverloaded. Source: Sleeve cross-section # 31053. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_STATEState (substance) # 31081.  
    Public PropertyCONNECTION_STRIPPINGLENGTH_DESIGNATIONOverloaded. Target: Stripping length # 31056. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_STRIPPINGLENGTH_SOURCEOverloaded. Source: Stripping length # 31055. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_TEMPERATURETemperature # 31084.  
    Public PropertyCONNECTION_TYPEOFENDSTOP_DESTINATIONOverloaded. Wire termination processing target # 31052. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_TYPEOFENDSTOP_SOURCEOverloaded. Wire termination processing source # 31051. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRECROSSSECTIONOverloaded. Connection: Cross-section / diameter # 31002. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRECROSSSECTION_UNITOverloaded. Unit for connection cross-section / diameter # 31059. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRECROSSSECTION_WITH_UNITOverloaded. Connection: Cross-section / diameter with unit # 31007. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRELENGTHOverloaded. Connection: Length with unit # 31003. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRELENGTH_FULLOverloaded. Connection: Length (full) # 31090. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRELENGTH_UNITOverloaded. Connection: Unit of length # 31001. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRELENGTH_VALUEOverloaded. Connection: Length # 31000. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRENUMBEROverloaded. Connection color / number # 31004. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyCONNECTION_WIRETYPEOverloaded. Connection: Type designation # 31048. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    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_BLOCK_FORMATOverloaded. Block property: Format # 20202. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyFUNC_BLOCK_VALUEOverloaded. Block property # 20201. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyFUNC_COMMENTOverloaded. Remark # 20045. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyFUNC_GRAVINGTEXTOverloaded. Engraving text # 20025. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyFUNC_SUPPLEMENTARYFIELDOverloaded. Supplementary field # 20901. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyFUNC_SYMB_DESCOverloaded. Symbol description (function) # 20114. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyFUNC_SYMB_NAMEOverloaded. Symbol name # 20112. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyFUNC_SYMB_NUMBEROverloaded. Symbol number # 20168. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyFUNC_SYMB_VARIANTOverloaded. Symbol variant # 20113. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyFUNC_SYMBLIB_NAMEOverloaded. Symbol library # 20111. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyFUNC_SYMBOLOverloaded. Symbol # 20575. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyFUNCTION_NETBASEDWIRING_IDOverloaded. ID for net-based connections # 20218. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyFUNCTION_NETBASEDWIRING_IDSOverloaded. IDs for net-based connections # 20219. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyINSTANCE_ACTIVE_PROPERTYSETOverloaded. Property arrangement # 19307. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_FULLPLACEMENTLOCATIONOverloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_PAGEFULLNAMEOverloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_PAGENAMEOverloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_PAGETYPEOverloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_PATHIDOverloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_POSIDOverloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_REVISION_LOG_DATEOverloaded. Modification date (change tracking) # 19032. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_MARKEROverloaded. Revision marker (change tracking) # 19030. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_MARKER_FORMATOverloaded. Revision marker format (change tracking) # 19031. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_TIMEOverloaded. Modification time (change tracking) # 19034. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISION_LOG_USEROverloaded. Creator (change tracking) # 19033. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISIONIDOverloaded. Revision change marker (from property comparison) # 10153. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_REVISIONMARKEROverloaded. Revision marker (from property comparison) # 10152. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyINSTANCE_TYPEOverloaded. Representation type / report type # 19021. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_USER_DEFINED_PROPERTYSETOverloaded. User-defined property arrangement: Name # 19008. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_XCOORDOverloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyINSTANCE_YCOORDOverloaded. Y coordinate # 19003. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPIPELINE_CHANGE_SOURCE_TARGETPiping: Exchange source and target # 33301.  
    Public PropertyPOTENTIAL_FREQUENCEOverloaded. Frequency # 33004. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_NAMEOverloaded. Name of potential # 33000. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_NETNAMEOverloaded. Net name # 33007. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_PARENTOverloaded. Superior potential # 33001. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_SIGNALOverloaded. Signal name # 33006. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_TYPEOverloaded. Potential type # 31006. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_VALID_POTENTIALSOverloaded. Possible counter potentials # 33005. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPOTENTIAL_VALUEOverloaded. Potential value # 33003. (Inherited from Eplan.EplApi.DataModel.PotentialDefinitionPropertyList)
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyWRITEPROTECTED_AUTOMATICOverloaded. Change protection (hierarchical) # 3015. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    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 PipingDefinitionPropertyList 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

    PipingDefinitionPropertyList Members
    Eplan.EplApi.DataModel Namespace
    PipingDefinition Class
    PotentialDefinitionPropertyList Class

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Send Feedback