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

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

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.ArticlePropertyList
         Eplan.EplApi.DataModel.ArticleReferencePropertyList
         Eplan.EplApi.DataModel.ConnectionPointsInfoPropertyList
         Eplan.EplApi.DataModel.ConnectionPropertyList
         Eplan.EplApi.DataModel.DeviceListEntryPropertyList
         Eplan.EplApi.DataModel.E3D.PlaceHolder3DPropertyList
         Eplan.EplApi.DataModel.E3D.Placement3DPropertyList
         Eplan.EplApi.DataModel.FunctionDefinitionPropertyList
         Eplan.EplApi.DataModel.LocationPropertyList
         Eplan.EplApi.DataModel.MasterData.FunctionDefinitionLibraryPropertyList
         Eplan.EplApi.DataModel.MasterData.SymbolLibraryPropertyList
         Eplan.EplApi.DataModel.MasterData.SymbolPropertyList
         Eplan.EplApi.DataModel.MergedArticleReferencePropertyList
         Eplan.EplApi.DataModel.MergedConnectionPropertyList
         Eplan.EplApi.DataModel.MergedFunctionPropertyList
         Eplan.EplApi.DataModel.OptionBasePropertyList
         Eplan.EplApi.DataModel.PlacementPropertyList
         Eplan.EplApi.DataModel.Planning.PlanningSegmentPropertyList
         Eplan.EplApi.DataModel.Planning.SegmentDefinitionPropertyList
         Eplan.EplApi.DataModel.Planning.SegmentTemplatePropertyList
         Eplan.EplApi.DataModel.PlcIOPropertyList
         Eplan.EplApi.DataModel.ProjectPropertyList

Syntax
[DefaultMember("Property")]
public class StorableObjectPropertyList : UniversalPropertyList 
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 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 PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
Public PropertyObject identification # 2000.  
Top
Public Methods
 NameDescription
Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public MethodDestructor for deterministic finalization of StorableObjectPropertyList 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