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

In This Topic
    PlcIOPropertyList Class
    In This Topic
    This class represents a collection of properties of PlcIO class. Please also check the base classes for other properties that are available for PlcIO objects: StorableObjectPropertyList
    Inheritance Hierarchy

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

    Syntax
    [DefaultMember("Property")]
public class PlcIOPropertyList : StorableObjectPropertyList 
    [DefaultMember("Property")]
public ref class PlcIOPropertyList : public StorableObjectPropertyList
    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 ConstructorPlcIOPropertyList ConstructorConstructor  
    Top
    Public Properties
     NameDescription
    Public PropertyAUTOMATIONML_OBJECTIDAutomationML GUID # 25030.  
    Public PropertyAUTOMATIONML_OBJECTID_2AutomationML GUID 2 # 25031.  
    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_PLC_SIGNALRANGESignal range # 20388.  
    Public PropertyFUNC_PLCCONFIGURATIONPROJECT_INDIRECTConfiguration project (indirect) # 20108.  
    Public PropertyFUNC_PLCCPU_INDIRECTCPU (indirect) # 20434.  
    Public PropertyFUNC_PLCSTATIONNAME_INDIRECTPLC station: ID (indirect) # 20420.  
    Public PropertyFUNC_PLCTERMINAL_INDEX_OF_STARTADDRESSPLC subdevice: Index # 20384.  
    Public PropertyFUNC_PLCTERMINAL_NO_ADRESSINGDo not include in addressing # 20380.  
    Public PropertyFUNCTION_PLCIMPORTCOMPARE_MARKEDTOBEDELETEDMarked for deletion # 20186.  
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPLCIOENTRY_COMMUNICATIONENTITY_NAMEName of the communication unit # 23400.  
    Public PropertyPLCIOENTRY_DIRECTIONDirection # 23403.  
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    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 PlcIOPropertyList 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

    PlcIOPropertyList Members
    Eplan.EplApi.DataModel Namespace
    PlcIO Class
    StorableObjectPropertyList Class

     

     

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

    Use the Eplan Global Support Portal for feedback and support