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

In This Topic
    FunctionBasePropertyList Class
    In This Topic
    This class represents a collection of properties of FunctionBase class. Please also check the base classes for other properties that are available for FunctionBase 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.FunctionBasePropertyList
                      Eplan.EplApi.DataModel.FunctionPropertyList
                      Eplan.EplApi.DataModel.InterruptionPointPropertyList
                      Eplan.EplApi.DataModel.LocationBoxPropertyList

    Syntax
    [DefaultMember("Property")]
    public class FunctionBasePropertyList : SymbolReferencePropertyList 
    [DefaultMember("Property")]
    public ref class FunctionBasePropertyList : public SymbolReferencePropertyList 
    Remarks

    It uses the [] operator in order to access its elements (stored properties).

    Property list is a container for property values and just like them can be persistent (also called online) or transient (also called offline). If a property list is persistent, this means that it is associated with the properties of some StorableObject or other property list. If any property is added, changed or removed from the property list in this case, the result is also visible in the related objects. Whether a property list is persistent or transient is determined at the time of its creation and cannot be changed.

    Example
    This example shows the different usage of persistent property lists and transient property lists:
    // Creation of a persistent property list
    FunctionPropertyList oPersistentPropertyList1 = oFunction.Properties;
    oPersistentPropertyList1.FUNC_COMMENT = "Comment";
    // Now, oFunction.Properties.FUNC_COMMENT is equals "Comment"
    
    FunctionPropertyList oPersistentPropertyList2 = new FunctionPropertyList(oFunction);
    oPersistentPropertyList2.FUNC_COMMENT = "Test";
    // Now, oFunction.Properties.FUNC_COMMENT equals "Test"
    
    // Creation of a transient property list
    FunctionPropertyList oTransientPropertyList = new FunctionPropertyList();
    oTransientPropertyList.FUNC_COMMENT = "Test comment";
    oFunction.Properties.FUNC_COMMENT = oTransientPropertyList.FUNC_COMMENT;
    oTransientPropertyList.FUNC_COMMENT = "Transient comment";
    // Now, oTransientPropertyList.FUNC_COMMENT equals "Test comment"
    
    
    Public Constructors
     NameDescription
    Public ConstructorConstructor  
    Top
    Public Properties
     NameDescription
    Public PropertyFunctional assignment # 1320.  
    Public PropertyFunctional assignment: Description # 1350.  
    Public PropertyFunctional assignment with preceding sign # 1340.  
    Public PropertyHigher-level function number # 1720.  
    Public PropertyHigher-level function number: Description # 1750.  
    Public PropertyHigher-level function number with preceding sign # 1740.  
    Public PropertyLocation designation # 1220.  
    Public PropertyLocation designation: Description # 1250.  
    Public PropertyLocation designation with preceding sign # 1240.  
    Public PropertyInstallation site # 1420.  
    Public PropertyInstallation site: Description # 1450.  
    Public PropertyInstallation site with preceding sign # 1440.  
    Public PropertyFunction designation # 1120.  
    Public PropertyFunction designation: Description # 1150.  
    Public PropertyFunction designation with preceding sign # 1140.  
    Public PropertyProduct # 1820.  
    Public PropertyProduct: Description # 1850.  
    Public PropertyProduct with preceding sign # 1840.  
    Public PropertyFunctional assignment (sub-identifier, complete) # 1321.  
    Public PropertyHigher-level function number (sub-identifier, complete) # 1721.  
    Public PropertyLocation designation (sub-identifier, complete) # 1221.  
    Public PropertyInstallation site (sub-identifier, complete) # 1421.  
    Public PropertyFunction designation (sub-identifier, complete) # 1121.  
    Public PropertyProduct (sub-identifier, complete) # 1821.  
    Public PropertyUser-defined structure (sub-identifier, complete) # 1621.  
    Public PropertyUser-defined structure # 1620.  
    Public PropertyUser-defined structure: Description # 1650.  
    Public PropertyUser-defined structure with preceding sign # 1640.  
    Public PropertyFunctional assignment (main identifier) # 1300.  
    Public PropertyFunctional assignment (main identifier): Description # 1330.  
    Public PropertyFunctional assignment (leading identifiers) # 1322.  
    Public PropertyFunctional assignment (visible) # 1329.  
    Public PropertyHigher-level function number (main identifier) # 1700.  
    Public PropertyHigher-level function number (main identifier): Description # 1730.  
    Public PropertyHigher-level function number (leading identifiers) # 1722.  
    Public PropertyHigher-level function number (visible) # 1729.  
    Public PropertyLocation designation (main identifier) # 1200.  
    Public PropertyLocation designation (main identifier): Description # 1230.  
    Public PropertyLocation designation (leading identifiers) # 1222.  
    Public PropertyLocation designation (visible) # 1229.  
    Public PropertyInstallation site (main identifier) # 1400.  
    Public PropertyInstallation site (main identifier): Description # 1430.  
    Public PropertyInstallation site (leading identifiers) # 1422.  
    Public PropertyInstallation site (visible) # 1429.  
    Public PropertyFunction designation (main identifier) # 1100.  
    Public PropertyFunction designation (main identifier): Description # 1130.  
    Public PropertyFunction designation (leading identifiers) # 1122.  
    Public PropertyFunction designation (visible) # 1129.  
    Public PropertyProduct (main identifier) # 1800.  
    Public PropertyProduct (main identifier): Description # 1830.  
    Public PropertyProduct (leading identifiers) # 1822.  
    Public PropertyProduct (visible) # 1829.  
    Public PropertyFunctional assignment (sub-identifier 1) # 1301.  
    Public PropertyFunctional assignment (sub-identifier 1): Description # 1331.  
    Public PropertyFunctional assignment (sub-identifier 2) # 1302.  
    Public PropertyFunctional assignment (sub-identifier 2): Description # 1332.  
    Public PropertyFunctional assignment (sub-identifier 3) # 1303.  
    Public PropertyFunctional assignment (sub-identifier 3): Description # 1333.  
    Public PropertyFunctional assignment (sub-identifier 4) # 1304.  
    Public PropertyFunctional assignment (sub-identifier 4): Description # 1334.  
    Public PropertyFunctional assignment (sub-identifier 5) # 1305.  
    Public PropertyFunctional assignment (sub-identifier 5): Description # 1335.  
    Public PropertyFunctional assignment (sub-identifier 6) # 1306.  
    Public PropertyFunctional assignment (sub-identifier 6): Description # 1336.  
    Public PropertyFunctional assignment (sub-identifier 7) # 1307.  
    Public PropertyFunctional assignment (sub-identifier 7): Description # 1337.  
    Public PropertyFunctional assignment (sub-identifier 8) # 1308.  
    Public PropertyFunctional assignment (sub-identifier 8): Description # 1338.  
    Public PropertyFunctional assignment (sub-identifier 9) # 1309.  
    Public PropertyFunctional assignment (sub-identifier 9): Description # 1339.  
    Public PropertyLocation designation (sub-identifier 1) # 1201.  
    Public PropertyLocation designation (sub-identifier 1): Description # 1231.  
    Public PropertyLocation designation (sub-identifier 2) # 1202.  
    Public PropertyLocation designation (sub-identifier 2): Description # 1232.  
    Public PropertyLocation designation (sub-identifier 3) # 1203.  
    Public PropertyLocation designation (sub-identifier 3): Description # 1233.  
    Public PropertyLocation designation (sub-identifier 4) # 1204.  
    Public PropertyLocation designation (sub-identifier 4): Description # 1234.  
    Public PropertyLocation designation (sub-identifier 5) # 1205.  
    Public PropertyLocation designation (sub-identifier 5): Description # 1235.  
    Public PropertyLocation designation (sub-identifier 6) # 1206.  
    Public PropertyLocation designation (sub-identifier 6): Description # 1236.  
    Public PropertyLocation designation (sub-identifier 7) # 1207.  
    Public PropertyLocation designation (sub-identifier 7): Description # 1237.  
    Public PropertyLocation designation (sub-identifier 8) # 1208.  
    Public PropertyLocation designation (sub-identifier 8): Description # 1238.  
    Public PropertyLocation designation (sub-identifier 9) # 1209.  
    Public PropertyLocation designation (sub-identifier 9): Description # 1239.  
    Public PropertyInstallation site (sub-identifier 1) # 1401.  
    Public PropertyInstallation site (sub-identifier 1): Description # 1431.  
    Public PropertyInstallation site (sub-identifier 2) # 1402.  
    Public PropertyInstallation site (sub-identifier 2): Description # 1432.  
    Public PropertyInstallation site (sub-identifier 3) # 1403.  
    Public PropertyInstallation site (sub-identifier 3): Description # 1433.  
    Public PropertyInstallation site (sub-identifier 4) # 1404.  
    Public PropertyInstallation site (sub-identifier 4): Description # 1434.  
    Public PropertyInstallation site (sub-identifier 5) # 1405.  
    Public PropertyInstallation site (sub-identifier 5): Description # 1435.  
    Public PropertyInstallation site (sub-identifier 6) # 1406.  
    Public PropertyInstallation site (sub-identifier 6): Description # 1436.  
    Public PropertyInstallation site (sub-identifier 7) # 1407.  
    Public PropertyInstallation site (sub-identifier 7): Description # 1437.  
    Public PropertyInstallation site (sub-identifier 8) # 1408.  
    Public PropertyInstallation site (sub-identifier 8): Description # 1438.  
    Public PropertyInstallation site (sub-identifier 9) # 1409.  
    Public PropertyInstallation site (sub-identifier 9): Description # 1439.  
    Public PropertyFunction designation (sub-identifier 1) # 1101.  
    Public PropertyFunction designation (sub-identifier 1): Description # 1131.  
    Public PropertyFunction designation (sub-identifier 2) # 1102.  
    Public PropertyFunction designation (sub-identifier 2): Description # 1132.  
    Public PropertyFunction designation (sub-identifier 3) # 1103.  
    Public PropertyFunction designation (sub-identifier 3): Description # 1133.  
    Public PropertyFunction designation (sub-identifier 4) # 1104.  
    Public PropertyFunction designation (sub-identifier 4): Description # 1134.  
    Public PropertyFunction designation (sub-identifier 5) # 1105.  
    Public PropertyFunction designation (sub-identifier 5): Description # 1135.  
    Public PropertyFunction designation (sub-identifier 6) # 1106.  
    Public PropertyFunction designation (sub-identifier 6): Description # 1136.  
    Public PropertyFunction designation (sub-identifier 7) # 1107.  
    Public PropertyFunction designation (sub-identifier 7): Description # 1137.  
    Public PropertyFunction designation (sub-identifier 8) # 1108.  
    Public PropertyFunction designation (sub-identifier 8): Description # 1138.  
    Public PropertyFunction designation (sub-identifier 9) # 1109.  
    Public PropertyFunction designation (sub-identifier 9): Description # 1139.  
    Public PropertyProduct (sub-identifier 1) # 1801.  
    Public PropertyProduct (sub-identifier 1): Description # 1831.  
    Public PropertyProduct (sub-identifier 2) # 1802.  
    Public PropertyProduct (sub-identifier 2): Description # 1832.  
    Public PropertyProduct (sub-identifier 3) # 1803.  
    Public PropertyProduct (sub-identifier 3): Description # 1833.  
    Public PropertyProduct (sub-identifier 4) # 1804.  
    Public PropertyProduct (sub-identifier 4): Description # 1834.  
    Public PropertyProduct (sub-identifier 5) # 1805.  
    Public PropertyProduct (sub-identifier 5): Description # 1835.  
    Public PropertyProduct (sub-identifier 6) # 1806.  
    Public PropertyProduct (sub-identifier 6): Description # 1836.  
    Public PropertyProduct (sub-identifier 7) # 1807.  
    Public PropertyProduct (sub-identifier 7): Description # 1837.  
    Public PropertyProduct (sub-identifier 8) # 1808.  
    Public PropertyProduct (sub-identifier 8): Description # 1838.  
    Public PropertyProduct (sub-identifier 9) # 1809.  
    Public PropertyProduct (sub-identifier 9): Description # 1839.  
    Public PropertyUser-defined structure (main identifier) # 1600.  
    Public PropertyUser-defined structure (main identifier): Description # 1630.  
    Public PropertyUser-defined structure (leading identifiers) # 1622.  
    Public PropertyUser-defined structure (sub-identifier 1) # 1601.  
    Public PropertyUser-defined structure (sub-identifier 1): Description # 1631.  
    Public PropertyUser-defined structure (sub-identifier 2) # 1602.  
    Public PropertyUser-defined structure (sub-identifier 2): Description # 1632.  
    Public PropertyUser-defined structure (sub-identifier 3) # 1603.  
    Public PropertyUser-defined structure (sub-identifier 3): Description # 1633.  
    Public PropertyUser-defined structure (sub-identifier 4) # 1604.  
    Public PropertyUser-defined structure (sub-identifier 4): Description # 1634.  
    Public PropertyUser-defined structure (sub-identifier 5) # 1605.  
    Public PropertyUser-defined structure (sub-identifier 5): Description # 1635.  
    Public PropertyUser-defined structure (sub-identifier 6) # 1606.  
    Public PropertyUser-defined structure (sub-identifier 6): Description # 1636.  
    Public PropertyUser-defined structure (sub-identifier 7) # 1607.  
    Public PropertyUser-defined structure (sub-identifier 7): Description # 1637.  
    Public PropertyUser-defined structure (sub-identifier 8) # 1608.  
    Public PropertyUser-defined structure (sub-identifier 8): Description # 1638.  
    Public PropertyUser-defined structure (sub-identifier 9) # 1609.  
    Public PropertyUser-defined structure (sub-identifier 9): Description # 1639.  
    Public PropertyUser-defined structure (visible) # 1629.  
    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 PropertyCircuit number # 20317.  
    Public PropertyDT: Identifier # 20013.  
    Public PropertyItem number # 20318.  
    Public PropertyDT: Counter # 20014.  
    Public PropertyMedia code # 20316.  
    Public PropertyDT (full, without project structures) # 20009.  
    Public PropertyDT (full, without project structures, with preceding sign) # 20213.  
    Public PropertyDT (superior, without project structures) # 20003.  
    Public PropertyDT (superior, without project structures, with preceding sign) # 20211.  
    Public PropertyDT (subordinate, without project structures) # 20004.  
    Public PropertyDT (subordinate, without project structures, with preceding sign) # 20212.  
    Public PropertyDT (project structures only) # 20020.  
    Public PropertyUse displayed DT as full DT # 20051.  
    Public PropertyDT: Column # 20152.  
    Public PropertyDT: Application # 20155.  
    Public PropertyDT: Page # 20150.  
    Public PropertyDT: Subpage # 20151.  
    Public PropertyDT: Row # 20153.  
    Public PropertyDT: Section # 20154.  
    Public PropertyDT: Supplementary field 1 # 20156.  
    Public PropertyDT: Supplementary field 2 # 20157.  
    Public PropertyDT: Supplementary field 3 # 20158.  
    Public PropertyDT: Supplementary field 4 # 20159.  
    Public PropertyDT: Supplementary field 5 # 20160.  
    Public PropertyDT (subordinate): Column # 20172.  
    Public PropertyDT (subordinate): Application # 20175.  
    Public PropertyDT (subordinate): Page # 20170.  
    Public PropertyDT (subordinate): Subpage # 20171.  
    Public PropertyDT (subordinate): Row # 20173.  
    Public PropertyDT (subordinate): Section # 20174.  
    Public PropertyDT (subordinate): Supplementary field 1 # 20176.  
    Public PropertyDT (subordinate): Supplementary field 2 # 20177.  
    Public PropertyDT (subordinate): Supplementary field 3 # 20178.  
    Public PropertyDT (subordinate): Supplementary field 4 # 20179.  
    Public PropertyDT (subordinate): Supplementary field 5 # 20180.  
    Public PropertyDT (full) # 20006.  
    Public PropertyName (full) # 20001.  
    Public PropertyDT (identifying) # 20005.  
    Public PropertyIdentifying DT elements # 20096.  
    Public PropertyDT (identifying, without subordinate DT) # 20007.  
    Public PropertyDT (identifying, without project structures) # 20008.  
    Public PropertyDT (identifying, without project structures, with preceding sign) # 20215.  
    Public PropertyName (identifying) # 20000.  
    Public PropertyIdentifying name elements # 20095.  
    Public PropertyDT (subordinate): Identifier # 20017.  
    Public PropertyDT (subordinate):Counter # 20018.  
    Public PropertyDT (subordinate): Prefix # 20016.  
    Public PropertyDT (subordinate): Subcounter # 20019.  
    Public PropertyDT: Prefix # 20012.  
    Public PropertyDT: Subcounter # 20015.  
    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 PropertyRepresentation type # 20121.  
    Public PropertyDT (displayed) # 20010.  
    Public PropertyName (visible) # 20002.  
    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 PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertySubproject number # 25101.  
    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 FunctionBasePropertyList 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