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

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

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

    Syntax
    [DefaultMember("Property")]
    public class ArticlePropertyList : StorableObjectPropertyList 
    [DefaultMember("Property")]
    public ref class ArticlePropertyList : 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 PropertyAccessory code # 22025.  
    Public PropertyAddress range (SIEMENS STEP 7 Classic) # 22106.  
    Public PropertyAddress range 2 (SIEMENS STEP 7 Classic) # 22261.  
    Public PropertyControl range # 22125.  
    Public PropertyControl range (full) # 22231.  
    Public PropertyPlugs: Leading pins # 22102.  
    Public PropertyPlugs: Clearance # 22096.  
    Public PropertyDistributed placement of assembly # 22040.  
    Public PropertyAttributes # 22051.  
    Public PropertyTerminals: AWG from # 22086.  
    Public PropertyTerminals: AWG to # 22087.  
    Public PropertyBusbars: Number of rails # 22201.  
    Public PropertyBusbars: Rail spacing # 22202.  
    Public PropertyBusbars: Profile geometry D x H (only EPLAN Cabinet) # 22200.  
    Public PropertyBusbars: Distance between rails and mounting panel # 22203.  
    Public PropertyMin. bending radius # 22063.  
    Public PropertyBending radius # 22257.  
    Public PropertyBase: Depth # 22186.  
    Public PropertyDistance base # 22185.  
    Public PropertyOverhang: Base back # 22184.  
    Public PropertyOverhang: Base front # 22183.  
    Public PropertyOverhang: Base left # 22181.  
    Public PropertyOverhang: Base right # 22182.  
    Public PropertyMaximum bundle diameter # 22259.  
    Public PropertyMinimum bundle diameter # 22260.  
    Public PropertyBusbar support: Part number # 22204.  
    Public PropertyBusbar support: Part variant # 22205.  
    Public PropertyBusbars: Part number # 22252.  
    Public PropertyBusbars: Part variant # 22253.  
    Public PropertyCable / Conduit: Designation in graphic # 22064.  
    Public PropertyCable assignment diagram form # 22034.  
    Public PropertyLength (prefabricated) # 22055.  
    Public PropertyCable type / Type designation # 22030.  
    Public PropertyWeight / length # 22067.  
    Public PropertyNumber of connections # 22031.  
    Public PropertyConnection: Cross-section / diameter # 22032.  
    Public PropertyAlignable # 22229.  
    Public PropertyCertification: General # 22048.  
    Public PropertyCertification: ATEX identifier # 22270.  
    Public PropertyCertification: CE # 22113.  
    Public PropertyCertification: UL File Number # 22049.  
    Public PropertyCertification: UL Category Control Number # 22368.  
    Public PropertyCertification: VDE # 22050.  
    Public PropertyTechnical characteristics # 22017.  
    Public PropertyPlugs: Coding # 22103.  
    Public PropertyCoil: Voltage # 22218.  
    Public PropertyColor # 22080.  
    Public PropertyConductivity (at +20 °C) # 22273.  
    Public PropertyConnection point # 22130.  
    Public PropertyConnection: Unit for connection cross-section / diameter # 22255.  
    Public PropertyConnection point cross-section # 22036.  
    Public PropertyPlugs: Connecting technique # 22101.  
    Public PropertyPlugs: Pin arrangement # 22095.  
    Public PropertyPlugs: Pin type # 22099.  
    Public PropertyCopper weight # 22066.  
    Public PropertyUnique external part ID # 22984.  
    Public PropertyTrade 'Cooling' # 22137.  
    Public PropertyTrade 'Cooling lubricant' # 22262.  
    Public PropertyTrade 'Electrical engineering' # 22131.  
    Public PropertyTrade 'Fluid power' # 22132.  
    Public PropertyTrade 'Fluid power (undefined)' # 22264.  
    Public PropertyTrade 'Gas engineering' # 22263.  
    Public PropertyTrade 'Hydraulics' # 22134.  
    Public PropertyTrade 'Lubrication' # 22136.  
    Public PropertyTrade 'Mechanics' # 22133.  
    Public PropertyTrade 'Pneumatics' # 22135.  
    Public PropertyTrade 'Process engineering' # 22000.  
    Public PropertyPlugs: Creepage distance # 22097.  
    Public PropertyTerminals: Cross-section from # 22084.  
    Public PropertyTerminals: Cross-section to # 22085.  
    Public PropertyTerminals: Current CSA # 22092.  
    Public PropertyTerminals: Current IEC # 22088.  
    Public PropertyTerminals: Current UL # 22090.  
    Public PropertyAPI Parts Management Extension: Name of add-in # 22212.  
    Public PropertyAPI Parts Management Extension: Value from add-in # 22213.  
    Public PropertyTerminals: Degree of protection # 22082.  
    Public PropertyDelivery length # 22058.  
    Public PropertyDepth # 22014.  
    Public PropertyPart: Designation 1 # 22004.  
    Public PropertyPart: Designation 2 # 22005.  
    Public PropertyPart: Designation 3 # 22006.  
    Public PropertyPlugs: Type of construction # 22100.  
    Public PropertyBreak up in summarized parts list # 22292.  
    Public PropertyDiscontinued part # 22258.  
    Public PropertyDiscount # 22221.  
    Public PropertyDistance of the pinch point # 22287.  
    Public PropertyDoor opening: Offset right # 22162.  
    Public PropertyDoor opening: Offset top # 22161.  
    Public PropertyDoor fold # 22160.  
    Public PropertyDoor: Max. mounting depth # 22121.  
    Public PropertyDoor: Usable height # 22119.  
    Public PropertyDoor: Mounting space # 22079.  
    Public PropertyDoor: Wall thickness # 22194.  
    Public PropertyDoor: Type # 22192.  
    Public PropertyDoor: Usable width # 22120.  
    Public PropertyTexture # 22219.  
    Public PropertyCurrent # 22071.  
    Public PropertySwitching capacity # 22072.  
    Public PropertyERP number # 22056.  
    Public PropertyExternal document # 22210.  
    Public PropertyExternal document 1 # 22149.  
    Public PropertyExternal document 10 # 22241.  
    Public PropertyExternal document 11 # 22242.  
    Public PropertyExternal document 12 # 22243.  
    Public PropertyExternal document 13 # 22244.  
    Public PropertyExternal document 14 # 22245.  
    Public PropertyExternal document 15 # 22246.  
    Public PropertyExternal document 16 # 22247.  
    Public PropertyExternal document 17 # 22248.  
    Public PropertyExternal document 18 # 22249.  
    Public PropertyExternal document 19 # 22250.  
    Public PropertyExternal document 2 # 22150.  
    Public PropertyExternal document 20 # 22251.  
    Public PropertyExternal document 3 # 22151.  
    Public PropertyExternal document 4 # 22235.  
    Public PropertyExternal document 5 # 22236.  
    Public PropertyExternal document 6 # 22237.  
    Public PropertyExternal document 7 # 22238.  
    Public PropertyExternal document 8 # 22239.  
    Public PropertyExternal document 9 # 22240.  
    Public PropertyExternal document: Designation # 22279.  
    Public PropertyExternal document: File / hyperlink # 22280.  
    Public PropertyExternal placement # 22220.  
    Public PropertyVersion # 22104.  
    Public PropertyFlow # 22126.  
    Public PropertyFlow (full) # 22232.  
    Public PropertyFluid / process engineering Wall thickness of the connection # 22275.  
    Public PropertyFree properties: Displayed name # 22146.  
    Public PropertyFree properties: Value and unit (full) # 22234.  
    Public PropertyUser-defined properties: Identifying name # 22336.  
    Public PropertyUser-defined properties: Value # 22337.  
    Public PropertyFree properties: Unit # 22148.  
    Public PropertyFree properties: Value # 22147.  
    Public PropertyFunction group # 22026.  
    Public PropertyGroup number # 22044.  
    Public PropertySchematic macro # 22145.  
    Public PropertyHeight # 22012.  
    Public PropertyDoor: Hinge # 22193.  
    Public PropertyHolding power # 22073.  
    Public PropertyBarcode number # 22208.  
    Public PropertyBarcode type # 22209.  
    Public PropertyInner diameter # 22128.  
    Public PropertyBusbar support: Vertical offset # 22207.  
    Public PropertyMounting depth # 22268.  
    Public PropertyIntrinsically safe # 22114.  
    Public PropertyPart is accessory # 22054.  
    Public PropertyService time # 22142.  
    Public PropertyGraphical macro # 22010.  
    Public PropertyGraphical macro (without macro directory name) # 22018.  
    Public PropertyLubrication / maintenance # 22141.  
    Public PropertyManufacturer # 22007.  
    Public PropertyManufacturer name # 22222.  
    Public PropertyMaterial # 22081.  
    Public PropertyCenter mismatch # 22215.  
    Public PropertyDistributed placement of module # 22288.  
    Public PropertyMounting surface # 22022.  
    Public PropertySpace requirement # 22047.  
    Public PropertyStandard # 22227.  
    Public PropertyDescription # 22009.  
    Public PropertyOrder number # 22003.  
    Public PropertyExternal diameter # 22065.  
    Public PropertyPurchase price/packaging Currency 1 # 22111.  
    Public PropertyPurchase price/packaging Currency 2 # 22112.  
    Public PropertyQuantity/packaging # 22122.  
    Public PropertyMounting panel: Max. mounting depth # 22118.  
    Public PropertyMounting panel: Usable height # 22116.  
    Public PropertyMounting panel: Mounting space # 22078.  
    Public PropertyMounting panel: Usable width # 22117.  
    Public PropertyPart number # 22001.  
    Public PropertyRecord type # 22023.  
    Public PropertyNumber of PE conductors # 22123.  
    Public PropertyImage file # 22045.  
    Public PropertyPart group # 22027.  
    Public PropertyPlugs: Number of pins # 22035.  
    Public PropertyPipe class # 22224.  
    Public PropertyDrive: Device type # 22340.  
    Public PropertyDevice description: File name # 22037.  
    Public PropertyDevice description: Index in file # 22283.  
    Public PropertyPLC subdevice 1: Name # 22293.  
    Public PropertyPLC subdevice 10: Name # 22302.  
    Public PropertyPLC subdevice 11: Name # 22303.  
    Public PropertyPLC subdevice 12: Name # 22304.  
    Public PropertyPLC subdevice 2: Name # 22294.  
    Public PropertyPLC subdevice 3: Name # 22295.  
    Public PropertyPLC subdevice 4: Name # 22296.  
    Public PropertyPLC subdevice 5: Name # 22297.  
    Public PropertyPLC subdevice 6: Name # 22298.  
    Public PropertyPLC subdevice 7: Name # 22299.  
    Public PropertyPLC subdevice 8: Name # 22300.  
    Public PropertyPLC subdevice 9: Name # 22301.  
    Public PropertyPLC subdevice 1: Position (slot / module) # 22305.  
    Public PropertyPLC subdevice 10: Position (slot / module) # 22314.  
    Public PropertyPLC subdevice 11: Position (slot / module) # 22315.  
    Public PropertyPLC subdevice 12: Position (slot / module) # 22316.  
    Public PropertyPLC subdevice 2: Position (slot / module) # 22306.  
    Public PropertyPLC subdevice 3: Position (slot / module) # 22307.  
    Public PropertyPLC subdevice 4: Position (slot / module) # 22308.  
    Public PropertyPLC subdevice 5: Position (slot / module) # 22309.  
    Public PropertyPLC subdevice 6: Position (slot / module) # 22310.  
    Public PropertyPLC subdevice 7: Position (slot / module) # 22311.  
    Public PropertyPLC subdevice 8: Position (slot / module) # 22312.  
    Public PropertyPLC subdevice 9: Position (slot / module) # 22313.  
    Public PropertyPLC device: Data length (inputs) # 20571.  
    Public PropertyPLC subdevice 1: Data length (inputs) # 22363.  
    Public PropertyPLC subdevice 10: Data length (inputs) # 22323.  
    Public PropertyPLC subdevice 11: Data length (inputs) # 22324.  
    Public PropertyPLC subdevice 12: Data length (inputs) # 22325.  
    Public PropertyPLC subdevice 2: Data length (inputs) # 20572.  
    Public PropertyPLC subdevice 3: Data length (inputs) # 22291.  
    Public PropertyPLC subdevice 4: Data length (inputs) # 22317.  
    Public PropertyPLC subdevice 5: Data length (inputs) # 22318.  
    Public PropertyPLC subdevice 6: Data length (inputs) # 22319.  
    Public PropertyPLC subdevice 7: Data length (inputs) # 22320.  
    Public PropertyPLC subdevice 8: Data length (inputs) # 22321.  
    Public PropertyPLC subdevice 9: Data length (inputs) # 22322.  
    Public PropertyPLC device: Data length (outputs) # 20573.  
    Public PropertyPLC subdevice 1: Data length (outputs) # 22364.  
    Public PropertyPLC subdevice 10: Data length (outputs) # 22333.  
    Public PropertyPLC subdevice 11: Data length (outputs) # 22334.  
    Public PropertyPLC subdevice 12: Data length (outputs) # 22335.  
    Public PropertyPLC subdevice 2: Data length (outputs) # 20574.  
    Public PropertyPLC subdevice 3: Data length (outputs) # 22326.  
    Public PropertyPLC subdevice 4: Data length (outputs) # 22327.  
    Public PropertyPLC subdevice 5: Data length (outputs) # 22328.  
    Public PropertyPLC subdevice 6: Data length (outputs) # 22329.  
    Public PropertyPLC subdevice 7: Data length (outputs) # 22330.  
    Public PropertyPLC subdevice 8: Data length (outputs) # 22331.  
    Public PropertyPLC subdevice 9: Data length (outputs) # 22332.  
    Public PropertyPLC subdevice 1: Device description: Index in file # 22366.  
    Public PropertyPLC subdevice 10: Device description: Index in file # 22360.  
    Public PropertyPLC subdevice 11: Device description: Index in file # 22361.  
    Public PropertyPLC subdevice 12: Device description: Index in file # 22362.  
    Public PropertyPLC subdevice 2: Device description: Index in file # 22352.  
    Public PropertyPLC subdevice 3: Device description: Index in file # 22353.  
    Public PropertyPLC subdevice 4: Device description: Index in file # 22354.  
    Public PropertyPLC subdevice 5: Device description: Index in file # 22355.  
    Public PropertyPLC subdevice 6: Device description: Index in file # 22356.  
    Public PropertyPLC subdevice 7: Device description: Index in file # 22357.  
    Public PropertyPLC subdevice 8: Device description: Index in file # 22358.  
    Public PropertyPLC subdevice 9: Device description: Index in file # 22359.  
    Public PropertyPLC subdevice 1: PLC type designation # 22365.  
    Public PropertyPLC subdevice 10: PLC type designation # 22349.  
    Public PropertyPLC subdevice 11: PLC type designation # 22350.  
    Public PropertyPLC subdevice 12: PLC type designation # 22351.  
    Public PropertyPLC subdevice 2: PLC type designation # 22341.  
    Public PropertyPLC subdevice 3: PLC type designation # 22342.  
    Public PropertyPLC subdevice 4: PLC type designation # 22343.  
    Public PropertyPLC subdevice 5: PLC type designation # 22344.  
    Public PropertyPLC subdevice 6: PLC type designation # 22345.  
    Public PropertyPLC subdevice 7: PLC type designation # 22346.  
    Public PropertyPLC subdevice 8: PLC type designation # 22347.  
    Public PropertyPLC subdevice 9: PLC type designation # 22348.  
    Public PropertyBus coupler / head station # 22019.  
    Public PropertyBus distribution device # 22053.  
    Public PropertyCPU # 22020.  
    Public PropertyPLC card is placed on head station # 22290.  
    Public PropertyPower supply # 22052.  
    Public PropertyObject description # 22038.  
    Public PropertyPLC station: Type # 22269.  
    Public Property# 22338.  
    Public PropertyPLC type designation # 22105.  
    Public PropertyMax. power dissipation # 22074.  
    Public PropertyMax. working pressure # 22124.  
    Public PropertyMax. working pressure (full) # 22230.  
    Public PropertyNominal pressure level # 22226.  
    Public PropertyPrice unit # 22043.  
    Public PropertyProduct group # 22041.  
    Public PropertyProduct grouping # 22367.  
    Public PropertyProduct subgroup # 22028.  
    Public PropertyGeneric product group # 22138.  
    Public PropertyProfile horizontal: Depth # 22188.  
    Public PropertyAdjoining distance # 22191.  
    Public PropertyProfile horizontal: Height # 22187.  
    Public PropertyPurchase price/price unit Currency 1 # 22109.  
    Public PropertyPurchase price/price unit Currency 2 # 22110.  
    Public PropertyQuantity unit # 22042.  
    Public PropertyRail cross-section # 22271.  
    Public PropertyRail material # 22272.  
    Public PropertyDistance rear panel # 22173.  
    Public PropertyRear panel: Depth # 22174.  
    Public PropertyOverhang: Rear panel bottom # 22172.  
    Public PropertyOverhang: Rear panel left # 22169.  
    Public PropertyOverhang: Rear panel right # 22170.  
    Public PropertyOverhang: Rear panel top # 22171.  
    Public PropertyDrilling pattern # 22217.  
    Public PropertyConnection point pattern # 22941.  
    Public PropertyConnection point pattern: Offset X-direction # 22277.  
    Public PropertyConnection point pattern: Offset Y-direction # 22278.  
    Public PropertyIdentifier for reports # 22214.  
    Public PropertySymbol for reports # 22228.  
    Public PropertySales price Currency 1 # 22107.  
    Public PropertySales price Currency 2 # 22108.  
    Public PropertyShort-circuit proof # 22115.  
    Public PropertySide panel: Depth # 22168.  
    Public PropertyDistance side panel # 22167.  
    Public PropertyOverhang: Side panel back # 22164.  
    Public PropertyOverhang: Side panel bottom # 22166.  
    Public PropertyOverhang: Side panel front # 22163.  
    Public PropertyOverhang: Side panel top # 22165.  
    Public PropertySlot width # 22286.  
    Public PropertyClip-on height # 22211.  
    Public PropertyMounting clearance Height: Above # 22154.  
    Public PropertyMounting clearance Height: Below # 22155.  
    Public PropertyMounting clearance Depth: Front # 22156.  
    Public PropertyMounting clearance Width: Left # 22152.  
    Public PropertyMounting clearance Depth: Rear # 22157.  
    Public PropertyMounting clearance Width: Right # 22153.  
    Public PropertySpare part # 22140.  
    Public PropertyPlugs: Standard / inverse # 22098.  
    Public PropertyStress # 22143.  
    Public PropertyLength of stroke # 22129.  
    Public PropertySubtrade 'Cooling' # 22196.  
    Public PropertySubtrade 'Cooling lubricant' # 22265.  
    Public PropertySubtrade 'Electrical engineering' # 22077.  
    Public PropertySubtrade 'Fluid power (undefined)' # 22267.  
    Public PropertySubtrade 'Gas engineering' # 22266.  
    Public PropertySubtrade 'Hydraulics' # 22158.  
    Public PropertySubtrade 'Lubrication' # 22195.  
    Public PropertySubtrade 'Mechanics' # 22094.  
    Public PropertySubtrade 'Pneumatics' # 22159.  
    Public PropertySubtrade 'Process engineering' # 22197.  
    Public PropertySupplier # 22008.  
    Public PropertySupplier name # 22223.  
    Public PropertyFinger width # 22285.  
    Public PropertyTemperature coefficient # 22274.  
    Public PropertyConnection dimension target # 22282.  
    Public PropertyConnection dimension source # 22281.  
    Public PropertyThread # 22127.  
    Public PropertyDistance cover # 22179.  
    Public PropertyCover: Depth # 22180.  
    Public PropertyOverhang: Cover back # 22178.  
    Public PropertyOverhang: Cover front # 22177.  
    Public PropertyOverhang: Cover left # 22175.  
    Public PropertyOverhang: Cover right # 22176.  
    Public PropertyTripping current # 22075.  
    Public PropertyType number # 22002.  
    Public PropertyUnique part ID # 22060.  
    Public PropertyProcurement # 22144.  
    Public PropertyVariant # 22024.  
    Public PropertyVoltage # 22033.  
    Public PropertyTerminals: Voltage CSA # 22093.  
    Public PropertyTerminals: Voltage IEC # 22089.  
    Public PropertyVoltage type # 22070.  
    Public PropertyTerminals: Voltage UL # 22091.  
    Public PropertyProfile vertical: Depth # 22190.  
    Public PropertyProfile vertical: Width # 22189.  
    Public PropertyWall thickness # 22216.  
    Public PropertyWearing part # 22139.  
    Public PropertyWeight # 22046.  
    Public PropertyWeight in displayed unit # 22059.  
    Public PropertyWeight (full) # 22233.  
    Public PropertyWidth # 22013.  
    Public PropertyWidth bottom # 22199.  
    Public PropertyNominal width # 22225.  
    Public PropertyWidth top # 22198.  
    Public PropertyNo. of connections and cross-section / diameter # 22069.  
    Public PropertyUnit for connection cross-section / diameter # 22068.  
    Public PropertyConnection type # 22254.  
    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 PropertyMessages in message management # 20930.  
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyCreator / Creation date # 22902.  
    Public PropertyLast editor / Modification date # 22901.  
    Public PropertyPart number in accessory # 22963.  
    Public PropertyPart number in assembly # 22967.  
    Public PropertyPart number in module # 22966.  
    Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDestructor for deterministic finalization of ArticlePropertyList 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