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

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

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

    Syntax
    [DefaultMember("Property")]
public class LocationPropertyList : StorableObjectPropertyList 
    [DefaultMember("Property")]
public ref class LocationPropertyList : 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 ConstructorLocationPropertyList ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAUTOMATIONML_OBJECTIDAutomationML GUID # 25030.  
    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 PropertyLOCATION_DESCRIPTIONStructure description # 1002.  
    Public PropertyLOCATION_DESCRIPTION_2Structure description 2 # 1007.  
    Public PropertyLOCATION_DESCRIPTION_3Structure description 3 # 1008.  
    Public PropertyLOCATION_DESCRIPTION_SUPPLEMENTARYFIELDStructure description Supplementary field # 1009.  
    Public PropertyLOCATION_FULLNAMEComplete structure identifier # 1001.  
    Public PropertyLOCATION_FULLNAME_WITHPREFIXComplete structure identifier with preceding sign # 1003.  
    Public PropertyLOCATION_NAMEStructure identifier # 1000.  
    Public PropertyLOCATION_NAMEPARTStructure identifier: superior name component # 1010.  
    Public PropertyLOCATION_TYPENAMEIdentifier block # 1004.  
    Public PropertyLOCATION_TYPENAME_NRIdentifier block (ID) # 1006.  
    Public PropertyLOCATION_UPPERLOCATIONStructure identifier superior # 1011.  
    Public PropertyLOCATION_UPPERLOCATION_DESCRIPTIONStructure identifier superior: Description # 1012.  
    Public PropertyLOCATION_USEUsage count # 1005.  
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyWRITEPROTECTEDChange protection # 3014.  
    Public PropertyWRITEPROTECTED_AUTOMATICChange protection (hierarchical) # 3015.  
    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 LocationPropertyList 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

    LocationPropertyList Members
    Eplan.EplApi.DataModel Namespace
    Location Class
    StorableObjectPropertyList Class

     

     

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

    Use the Eplan Global Support Portal for feedback and support