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

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

    System.Object
       Eplan.EplApi.DataModel.UniversalPropertyList
          Eplan.EplApi.DataModel.StorableObjectPropertyList
             Eplan.EplApi.DataModel.ProjectPropertyList

    Syntax
    [DefaultMember("Property")]
    public class ProjectPropertyList : StorableObjectPropertyList 
    [DefaultMember("Property")]
    public ref class ProjectPropertyList : public StorableObjectPropertyList 
    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 Property# 25030.  
    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 PropertySuppl. field: Yes / No # 20916.  
    Public PropertySuppl. field: Text # 20915.  
    Public PropertyAssembly # 20905.  
    Public PropertyAssembly structure # 20922.  
    Public PropertyAssembly variant # 20923.  
    Public PropertyPart allocation # 20904.  
    Public PropertyUsed drilling pattern # 20284.  
    Public PropertyNumber of units / quantity # 20102.  
    Public PropertyPart: Designation 1 # 20193.  
    Public PropertyPart: Designation 2 # 20194.  
    Public PropertyPart: Designation 3 # 20203.  
    Public PropertyERP number # 31117.  
    Public PropertyPart: External document 1 # 20190.  
    Public PropertyPart: External document 10 # 20269.  
    Public PropertyPart: External document 11 # 20270.  
    Public PropertyPart: External document 12 # 20271.  
    Public PropertyPart: External document 13 # 20272.  
    Public PropertyPart: External document 14 # 20273.  
    Public PropertyPart: External document 15 # 20274.  
    Public PropertyPart: External document 16 # 20275.  
    Public PropertyPart: External document 17 # 20276.  
    Public PropertyPart: External document 18 # 20277.  
    Public PropertyPart: External document 19 # 20278.  
    Public PropertyPart: External document 2 # 20191.  
    Public PropertyPart: External document 20 # 20279.  
    Public PropertyPart: External document 3 # 20192.  
    Public PropertyPart: External document 4 # 20263.  
    Public PropertyPart: External document 5 # 20264.  
    Public PropertyPart: External document 6 # 20265.  
    Public PropertyPart: External document 7 # 20266.  
    Public PropertyPart: External document 8 # 20267.  
    Public PropertyPart: External document 9 # 20268.  
    Public PropertyExternal placement # 20917.  
    Public PropertyFunction group # 20902.  
    Public PropertyService time # 20909.  
    Public PropertyLubrication / maintenance # 20912.  
    Public PropertyManufacturer # 20921.  
    Public PropertyPart: Mounting surface # 20918.  
    Public PropertyPart description # 31014.  
    Public PropertyOrder number # 20919.  
    Public PropertySubset / length # 31008.  
    Public PropertySubset / length (full) # 31091.  
    Public PropertySubset / length in unit of project # 31040.  
    Public PropertyUnit for subset / length # 31012.  
    Public PropertySubset / length: Value # 31010.  
    Public PropertySubset / length with unit of project # 31043.  
    Public PropertyPart number # 20100.  
    Public PropertyRecord type # 20103.  
    Public PropertyPart group # 20903.  
    Public PropertyItem number # 20464.  
    Public PropertyQuantity / subset in unit of project # 31044.  
    Public PropertySpare part # 20907.  
    Public PropertyStress # 20910.  
    Public PropertySupplier # 20920.  
    Public PropertySuppress in bill of materials (if filtered) # 20105.  
    Public PropertyProcurement # 20911.  
    Public PropertySafety-related values: Use case in use # 20307.  
    Public PropertyPart variant # 20101.  
    Public PropertyWearing part # 20908.  
    Public PropertyBill of materials group # 20924.  
    Public PropertyDT (full, without project structures) # 20009.  
    Public PropertyDT (full, without project structures, with preceding sign) # 20213.  
    Public PropertyRevision marker format (change tracking) # 19031.  
    Public PropertyRevision change marker (from property comparison) # 10153.  
    Public PropertyRevision marker (from property comparison) # 10152.  
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyDate # 10027.  
    Public PropertyTime of the day # 10058.  
    Public PropertyStart page name with document type # 10450.  
    Public PropertyTrade of part reference # 20913.  
    Public PropertySubtrade of part reference # 20914.  
    Public PropertyData backup: Backup directory # 10517.  
    Public PropertyData backup: Reorganize project # 10513.  
    Public PropertyData backup: Description # 10518.  
    Public PropertyData backup: Back up external documents # 10511.  
    Public PropertyData backup: Complete backup # 10510.  
    Public PropertyData backup: Back up image files # 10512.  
    Public PropertyData backup: Backup medium # 10515.  
    Public PropertyData backup: Method # 10514.  
    Public PropertyData backup: E-mail message split size in MB # 10516.  
    Public PropertyBlock property: Format (black box) # 10610.  
    Public PropertyBlock property: Format (busbar) # 10612.  
    Public PropertyBlock property: Format (cable / shield) # 10607.  
    Public PropertyBlock property: Format (connection) # 10608.  
    Public PropertyBlock property: Format (plug definition) # 10603.  
    Public PropertyBlock property: Format (device connection point) # 10611.  
    Public PropertyBlock property: Format (fluid connection splicer / line connector) # 10614.  
    Public PropertyBlock property: Format (fluid device) # 10613.  
    Public PropertyBlock property: Format (general devices) # 10600.  
    Public PropertyBlock property: Format (interruption point) # 10609.  
    Public PropertyBlock property: Format (structure box) # 10662.  
    Public PropertyBlock property: Format (mechanical) # 10619.  
    Public PropertyBlock property: Format (page) # 10618.  
    Public PropertyBlock property: Format (pre-planning) # 10661.  
    Public PropertyBlock property: Format (PLC connection point) # 10606.  
    Public PropertyBlock property: Format (PLC box) # 10605.  
    Public PropertyBlock property: Format (PCT loop) # 10615.  
    Public PropertyBlock property: Format (PCT loop function) # 10616.  
    Public PropertyBlock property: Format (pin) # 10604.  
    Public PropertyBlock property: Format (potential definition) # 10096.  
    Public PropertyBlock property: Format (process engineering) # 10617.  
    Public PropertyBlock property: Format (piping definition) # 10097.  
    Public PropertyBlock property: Format (terminal) # 10602.  
    Public PropertyBlock property: Format (terminal strip definition) # 10601.  
    Public PropertyBlock property: Replacement text # 10660.  
    Public PropertyProcessing mode for the cloud # 10122.  
    Public PropertyUnique project ID for the Cloud # 10120.  
    Public PropertyCommission # 10014.  
    Public PropertyCompany address 1 # 10016.  
    Public PropertyCompany address 2 # 10017.  
    Public PropertyCompany name # 10015.  
    Public PropertyControl voltage # 10041.  
    Public PropertyNumber of pages per page type # 10200.  
    Public PropertyCreation date # 10021.  
    Public PropertyCreation time # 10046.  
    Public PropertyCreator # 10020.  
    Public PropertyCreator: City # 10238.  
    Public PropertyCreator: Country # 10239.  
    Public PropertyCreator: E-mail # 10242.  
    Public PropertyCreator: Fax # 10241.  
    Public PropertyCreator: Short name # 10230.  
    Public PropertyCreator: Full name # 10245.  
    Public PropertyCreator: Name 1 # 10232.  
    Public PropertyCreator: Name 2 # 10233.  
    Public PropertyCreator: Name 3 # 10234.  
    Public PropertyCreator: Description # 10247.  
    Public PropertyCreator: Customer number # 10246.  
    Public PropertyCreator: P.O. box # 10236.  
    Public PropertyCreator: State / Region # 10244.  
    Public PropertyCreator: Street # 10235.  
    Public PropertyCreator: Phone # 10240.  
    Public PropertyCreator: Title # 10231.  
    Public PropertyCreator: Zip code (City) # 10237.  
    Public PropertyCreator: Zip code (P.O. box) # 10243.  
    Public PropertyCustomer # 10370.  
    Public PropertyCustomer: City # 10108.  
    Public PropertyCustomer: Country # 10109.  
    Public PropertyCustomer: E-mail # 10112.  
    Public PropertyCustomer: Fax # 10111.  
    Public PropertyCustomer: Short name # 10100.  
    Public PropertyCustomer: Full name # 10115.  
    Public PropertyCustomer: Name 1 # 10102.  
    Public PropertyCustomer: Name 2 # 10103.  
    Public PropertyCustomer: Name 3 # 10104.  
    Public PropertyCustomer: Description # 10117.  
    Public PropertyCustomer: Customer number # 10116.  
    Public PropertyCustomer: P.O. box # 10106.  
    Public PropertyCustomer: State / Region # 10114.  
    Public PropertyCustomer: Street # 10105.  
    Public PropertyCustomer: Phone # 10110.  
    Public PropertyCustomer: Title # 10101.  
    Public PropertyCustomer: Zip code (City) # 10107.  
    Public PropertyCustomer: Zip code (P.O. box) # 10113.  
    Public PropertyCustomer code # 10180.  
    Public PropertyLast modification date per page type # 10250.  
    Public PropertyDegree of protection # 10037.  
    Public PropertySequence of individual DT properties # 10091.  
    Public PropertyEdit DT in individual fields # 10090.  
    Public PropertyJob number # 10013.  
    Public PropertyFormat of displayed DT: Black box # 10630.  
    Public PropertyFormat of displayed DT: Busbar # 10632.  
    Public PropertyFormat of displayed DT: Cable / shield # 10627.  
    Public PropertyFormat of displayed DT: Cable connection # 10635.  
    Public PropertyFormat of displayed DT: Plug definition # 10623.  
    Public PropertyFormat of displayed DT: Device connection point # 10631.  
    Public PropertyFormat of displayed DT: Fluid connection splicer / line connector # 10634.  
    Public PropertyFormat of displayed DT: Fluid device # 10633.  
    Public PropertyFormat of displayed DT: General devices # 10620.  
    Public PropertyFormat of displayed DT: Interruption point # 10629.  
    Public PropertyFormat of displayed DT: PLC connection point # 10626.  
    Public PropertyFormat of displayed DT: PLC box # 10625.  
    Public PropertyFormat of displayed DT: Pin # 10624.  
    Public PropertyFormat of displayed DT: Terminal # 10622.  
    Public PropertyFormat of displayed DT: Terminal strip definition # 10621.  
    Public PropertyCreated pages # 10301.  
    Public PropertyEnclosures # 10038.  
    Public PropertyEnd customer: Full name # 10145.  
    Public PropertyEnd customer: Description # 10147.  
    Public PropertyEnd customer: Customer number # 10146.  
    Public PropertyEnd customer: State / Region # 10144.  
    Public PropertyEnd customer: City # 10138.  
    Public PropertyEnd customer: Country # 10139.  
    Public PropertyEnd customer: E-mail # 10142.  
    Public PropertyEnd customer: Fax # 10141.  
    Public PropertyEnd customer: Short name # 10130.  
    Public PropertyEnd customer: Name 1 # 10132.  
    Public PropertyEnd customer: Name 2 # 10133.  
    Public PropertyEnd customer: Name 3 # 10134.  
    Public PropertyEnd customer: P.O. box # 10136.  
    Public PropertyEnd customer: Street # 10135.  
    Public PropertyEnd customer: Phone # 10140.  
    Public PropertyEnd customer: Title # 10131.  
    Public PropertyEnd customer: Zip code (City) # 10137.  
    Public PropertyEnd customer: Zip code (P.O. box) # 10143.  
    Public PropertyEnvironmental consideration # 10034.  
    Public PropertyNumber of frozen pages per page type # 10065.  
    Public PropertyProject name (full) # 10009.  
    Public PropertyProject path (full) # 10045.  
    Public PropertyFormat of full DT: Black box # 10650.  
    Public PropertyFormat of full DT: Busbar # 10652.  
    Public PropertyFormat of full DT: Cable / shield # 10647.  
    Public PropertyFormat of full DT: Cable connection # 10655.  
    Public PropertyFormat of full DT: Plug definition # 10643.  
    Public PropertyFormat of full DT: Device connection point # 10651.  
    Public PropertyFormat of full DT: Fluid connection splicer / line connector # 10654.  
    Public PropertyFormat of full DT: Fluid device # 10653.  
    Public PropertyFormat of full DT: General devices # 10640.  
    Public PropertyFormat of full DT: Interruption point # 10649.  
    Public PropertyFormat of full DT: PLC connection point # 10646.  
    Public PropertyFormat of full DT: PLC box # 10645.  
    Public PropertyFormat of full DT: Pin # 10644.  
    Public PropertyFormat of full DT: Terminal # 10642.  
    Public PropertyFormat of full DT: Terminal strip definition # 10641.  
    Public PropertyGenerated report pages # 10302.  
    Public PropertyUnique project ID # 10184.  
    Public PropertyStructure format for busbars # 10053.  
    Public PropertyStructure format for cables # 10061.  
    Public PropertyNested device tags # 10019.  
    Public PropertySeparator for structures # 10018.  
    Public PropertyStructure format for black boxes # 10056.  
    Public PropertyStructure format for fluid connection splicer / line connector # 10064.  
    Public PropertyProject structure: Document type # 10006.  
    Public PropertyStructure format for fluid devices # 10063.  
    Public PropertyProject structure: Functional assignment # 10001.  
    Public PropertyProject structure: Higher-level function number # 10005.  
    Public PropertyStructure format for interruption points # 10051.  
    Public PropertyProject structure: Location designation # 10004.  
    Public PropertyStructure format for structure boxes # 10062.  
    Public PropertySuperior structure format for all devices # 10054.  
    Public PropertyStructure format for mechanical devices # 10085.  
    Public PropertyStructure format for pages # 10050.  
    Public PropertyProject structure: Installation site # 10003.  
    Public PropertyProject structure: Function designation # 10002.  
    Public PropertyStructure format for PLC / bus technology # 10057.  
    Public PropertyStructure format for plugs # 10060.  
    Public PropertyProject structure: Product # 10099.  
    Public PropertySuperior structure formats # 10029.  
    Public PropertyStructure format for general devices # 10055.  
    Public PropertyUse page name in DT # 10012.  
    Public PropertyStructure format for terminal strips # 10059.  
    Public PropertyProject structure: User-defined structure # 10007.  
    Public PropertyUser # 10181.  
    Public PropertyProject description # 10011.  
    Public PropertyModification date # 10023.  
    Public PropertyModification time # 10047.  
    Public PropertyLast editor: Sign-in name # 10022.  
    Public PropertyLast translation: Date # 10024.  
    Public PropertyLast translation: Time # 10048.  
    Public PropertyEPLAN build number of the last modification or update # 10044.  
    Public PropertyEPLAN version of the last modification or update # 10043.  
    Public PropertyInput lead # 10040.  
    Public PropertyLocation # 10035.  
    Public PropertyPlace of installation # 10032.  
    Public PropertyMake # 10030.  
    Public PropertyManufacturing date # 10042.  
    Public PropertyProject name # 10000.  
    Public PropertyNaming format for busbars # 10073.  
    Public PropertyNaming format for cables # 10081.  
    Public PropertyNaming format for devices # 10075.  
    Public PropertyNaming format for black boxes # 10076.  
    Public PropertyNaming format for fluid connection splicer / line connector # 10084.  
    Public PropertyNaming format for fluid devices # 10083.  
    Public PropertyNaming format for interruption points # 10071.  
    Public PropertyNaming format for structure boxes # 10082.  
    Public PropertySuperior naming format for all devices # 10074.  
    Public PropertyNaming format for mechanical devices # 10086.  
    Public PropertyNaming format for pages # 10070.  
    Public PropertyNaming format for PLC / bus technology # 10077.  
    Public PropertyNaming format for plugs # 10080.  
    Public PropertyNaming format for terminal strips # 10079.  
    Public PropertyType of project # 10902.  
    Public PropertyProject: Template # 10069.  
    Public PropertyTotal no. of pages # 10300.  
    Public PropertyPart features # 10033.  
    Public PropertyStructure of the tree structure in the device navigators # 10094.  
    Public PropertyShow descriptive identifiers in device navigators # 10095.  
    Public PropertyStructure of tree structure in page tree # 10092.  
    Public PropertyShow descriptive identifiers in page tree # 10093.  
    Public PropertyPower supply # 10039.  
    Public PropertyProject start # 10028.  
    Public PropertyProject end # 10026.  
    Public PropertyProject path # 10010.  
    Public PropertyProject status # 10303.  
    Public PropertyRegulation # 10036.  
    Public PropertyResponsible for project # 10025.  
    Public PropertyApproved by # 10160.  
    Public PropertyApproved date # 10161.  
    Public PropertyChecked by # 10162.  
    Public PropertyChecked date # 10163.  
    Public PropertyRevision date (change tracking) # 10158.  
    Public PropertyRevision comment (change tracking) # 10156.  
    Public PropertyDefined working section (from change tracking) # 10195.  
    Public PropertyRevision name (change tracking) # 10155.  
    Public PropertyRevision: Change tracking started # 10154.  
    Public PropertyRevision time (change tracking) # 10159.  
    Public PropertyRevision created by (change tracking) # 10157.  
    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 PropertyRevision: Temporary reference project # 10164.  
    Public PropertyRevisions # 10150.  
    Public PropertyRevision: Original project name (complete) # 10151.  
    Public PropertyRevision: Original project name # 10149.  
    Public PropertyLicense number of dongle # 10185.  
    Public PropertyShow tab for DT structures # 10008.  
    Public PropertySource language # 10500.  
    Public PropertyWorkstation # 10182.  
    Public PropertySequence of the project structures in the page name # 10089.  
    Public PropertySupplementary field # 10901.  
    Public PropertyLast modification time per page type # 10251.  
    Public PropertyProject: Type # 10031.  
    Public PropertyAutomationML: Building # 10952.  
    Public PropertyAutomationML: Company # 10950.  
    Public PropertyHighest revision index (change tracking) # 10098.  
    Public PropertyNumber of layout spaces # 10304.  
    Public PropertyThermal design: Frequency # 10311.  
    Public PropertyThermal design: Total power dissipation for air-conditioning field # 10313.  
    Public PropertyThermal design: Simultaneity factor # 10312.  
    Public PropertyThermal design: Voltage # 10310.  
    Public PropertyAutomationML: Plant # 10953.  
    Public PropertyAutomationML: Works # 10951.  
    Public PropertySubproject of # 25100.  
    Public PropertyAutomationML: Area # 10954.  
    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.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDestructor for deterministic finalization of ProjectPropertyList 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