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

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

    System.Object
       Eplan.EplApi.DataModel.UniversalPropertyList
          Eplan.EplApi.DataModel.StorableObjectPropertyList
             Eplan.EplApi.DataModel.PlacementPropertyList
                Eplan.EplApi.DataModel.GroupPropertyList
                   Eplan.EplApi.DataModel.DocumentBasePropertyList
                      Eplan.EplApi.DataModel.PagePropertyList

    Syntax
    [DefaultMember("Property")]
    public class PagePropertyList : DocumentBasePropertyList 
    [DefaultMember("Property")]
    public ref class PagePropertyList : public DocumentBasePropertyList 
    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 PropertyDocument type (main identifier) # 1500.  
    Public PropertyDocument type (main identifier): Description # 1530.  
    Public PropertyDocument type (leading identifiers) # 1522.  
    Public PropertyDocument type # 1520.  
    Public PropertyDocument type: Description # 1550.  
    Public PropertyDocument type with preceding sign # 1540.  
    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 PropertyDocument type (sub-identifier, complete) # 1521.  
    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 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 PropertyLocation designation (main identifier) # 1200.  
    Public PropertyLocation designation (main identifier): Description # 1230.  
    Public PropertyLocation designation (leading identifiers) # 1222.  
    Public PropertyInstallation site (main identifier) # 1400.  
    Public PropertyInstallation site (main identifier): Description # 1430.  
    Public PropertyInstallation site (leading identifiers) # 1422.  
    Public PropertyFunction designation (main identifier) # 1100.  
    Public PropertyFunction designation (main identifier): Description # 1130.  
    Public PropertyFunction designation (leading identifiers) # 1122.  
    Public PropertyProduct (main identifier) # 1800.  
    Public PropertyProduct (main identifier): Description # 1830.  
    Public PropertyProduct (leading identifiers) # 1822.  
    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 PropertyTrade (Defined working sections) # 25000.  
    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 PropertyProperty arrangement: Automatic X coordinate (path) # 12063.  
    Public PropertyProperty arrangement: Automatic Y coordinate (path) # 12062.  
    Public PropertyContact image margin (in path) # 12060.  
    Public PropertyContact image offset # 12061.  
    Public PropertyContact image margin (on component) # 12059.  
    Public PropertyString for column designation # 12027.  
    Public PropertyStart value (column) # 12025.  
    Public PropertyNumber of characters for column / row # 12029.  
    Public PropertyString for row designation # 12028.  
    Public PropertyStart value (row) # 12026.  
    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 PropertyMacro: Inserted by # 23006.  
    Public PropertySuppl. field: Group # 11032.  
    Public PropertySuppl. field: Page # 11031.  
    Public PropertySuppl. field: Sheet no. # 11033.  
    Public PropertySpecial remarks of creator # 11059.  
    Public PropertyAutomatically generated # 11006.  
    Public PropertyAutomatic page modified # 11050.  
    Public PropertyBlock property: Format # 11091.  
    Public PropertyBlock property # 11090.  
    Public PropertyPage counter # 11012.  
    Public PropertyCounter page number # 25020.  
    Public PropertyTrade # 11037.  
    Public PropertyCreation date # 11021.  
    Public PropertyCreation time # 11002.  
    Public PropertyCreator # 11020.  
    Public PropertyChange of standard: Do not rotate and flip # 11060.  
    Public PropertyDrawing number # 11030.  
    Public PropertyExternal document # 11058.  
    Public PropertyPlot frame name # 11016.  
    Public PropertyForm name # 11015.  
    Public PropertyFrozen report page # 11049.  
    Public PropertyPage name (full) # 11009.  
    Public PropertyContains results in the search results list # 11045.  
    Public PropertyPage name (identifying) # 11010.  
    Public PropertyAt least one object or page with revision marker (from property comparison) # 11007.  
    Public PropertyAt least one object with revision marker (from property comparison) # 11005.  
    Public PropertyKeep parts at placement # 11035.  
    Public PropertyModification date (automatic) # 11024.  
    Public PropertyModification time (automatic) # 11001.  
    Public PropertyModification date (manual) # 11023.  
    Public PropertyLast editor: Sign-in name # 11022.  
    Public PropertyMacro: Name # 11910.  
    Public PropertyMacro: Description # 11014.  
    Public PropertyMacro: Name # 11008.  
    Public PropertyMacro: Version # 11911.  
    Public PropertyMacro: Description # 11057.  
    Public PropertyMacro: Source project # 11056.  
    Public PropertyMacro: Source / reference # 11034.  
    Public PropertyHighest page number per structure # 11043.  
    Public PropertyPage name # 11000.  
    Public PropertyNext page # 11040.  
    Public PropertyPage description # 11011.  
    Public PropertyPage number # 11042.  
    Public PropertyNumber of pages per structure # 11004.  
    Public PropertyNumber of pages per property # 11062.  
    Public PropertyObject identifier # 11036.  
    Public PropertyPart of the structure identifier without separators stored in the object identifier # 11039.  
    Public PropertyStructure identifier with separators stored in the object identifier # 11038.  
    Public PropertyPage names per property # 11063.  
    Public PropertyPage counter per property # 11064.  
    Public PropertyPrevious page # 11041.  
    Public PropertyApproved by # 11080.  
    Public PropertyApproved date # 11081.  
    Public PropertyChecked by # 11082.  
    Public PropertyChecked date # 11083.  
    Public PropertyRevision: Approved by (change tracking) # 11087.  
    Public PropertyRevision: Approved date (change tracking) # 11088.  
    Public PropertyReason for revision change (change tracking) # 11073.  
    Public PropertyRevision date (change tracking) # 11074.  
    Public PropertyRevision description (change tracking) # 11072.  
    Public PropertyPage in draft mode # 11076.  
    Public PropertyDefined working section (from change tracking) # 11079.  
    Public PropertyRevision index (change tracking) # 11071.  
    Public PropertyAssociated project revision (change tracking) # 11075.  
    Public PropertyAssociated revision name (change tracking) # 11077.  
    Public PropertyRevision time (change tracking) # 11078.  
    Public PropertyRevision created by (change tracking) # 11070.  
    Public PropertyReplaced by # 11086.  
    Public PropertyOrigin # 11084.  
    Public PropertyReplacement of # 11085.  
    Public PropertyWatermark (revision) # 11003.  
    Public PropertyScale # 11048.  
    Public PropertyScale (ratio) # 11044.  
    Public PropertyGrid # 11051.  
    Public PropertySource # 11066.  
    Public PropertyReport: Source project # 11067.  
    Public PropertyPage subcounter # 11013.  
    Public PropertySupplementary field # 11901.  
    Public PropertyPage type # 11017.  
    Public PropertyPage type (ID) # 11029.  
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyUser code (change tracking) # 10190.  
    Public PropertyUser: E-mail address (change tracking) # 10193.  
    Public PropertyUser name (change tracking) # 10191.  
    Public PropertyUser: Phone number (change tracking) # 10192.  
    Public PropertyLicense number of dongle # 10185.  
    Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyLast editor: ID # 3010.  
    Public PropertyLast editor: E-mail # 3013.  
    Public PropertyLast editor: Name # 3011.  
    Public PropertyLast editor: Phone # 3012.  
    Public PropertySubproject number # 25101.  
    Public PropertyChange protection # 3014.  
    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 PagePropertyList 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