Eplan Platform API
Eplan.EplApi.DataModel Namespace / StorableObject Class
Members

In This Topic
    StorableObject Class
    In This Topic
    The parent of all API classes representing P8 project and its structure.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.Article
          Eplan.EplApi.DataModel.ArticleReference
          Eplan.EplApi.DataModel.Connection
          Eplan.EplApi.DataModel.ConnectionPointsInfo
          Eplan.EplApi.DataModel.DaisyChain
          Eplan.EplApi.DataModel.DeviceListEntry
          Eplan.EplApi.DataModel.E3D.Group3D
          Eplan.EplApi.DataModel.E3D.PlaceHolder3D
          Eplan.EplApi.DataModel.E3D.Placement3D
          Eplan.EplApi.DataModel.FunctionDefinition
          Eplan.EplApi.DataModel.Location
          Eplan.EplApi.DataModel.MasterData.FunctionDefinitionLibrary
          Eplan.EplApi.DataModel.MasterData.Symbol
          Eplan.EplApi.DataModel.MasterData.SymbolLibrary
          Eplan.EplApi.DataModel.MergedArticleReference
          Eplan.EplApi.DataModel.MergedConnection
          Eplan.EplApi.DataModel.MergedFunction
          Eplan.EplApi.DataModel.OptionBase
          Eplan.EplApi.DataModel.Placement
          Eplan.EplApi.DataModel.Planning.PlanningSegment
          Eplan.EplApi.DataModel.Planning.SegmentDefinition
          Eplan.EplApi.DataModel.Planning.SegmentTemplate
          Eplan.EplApi.DataModel.PlcIO
          Eplan.EplApi.DataModel.Project
          Eplan.EplApi.DataModel.ReportBlock
          Eplan.EplApi.DataModel.Revisions.Comparison
          Eplan.EplApi.DataModel.Revisions.ComparisonEntry
          Eplan.EplApi.DataModel.Revisions.ComparisonEntryDetail

    Syntax
    public class StorableObject 
    public ref class StorableObject 
    Public Properties
     NameDescription
    Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated)  
    Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again.  
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

     
    Public PropertyDetermines if StorableObject is read-only  
    Public Property

    Determines if the the StorableObject is transient.

    The StorableObject is transient when it was created by default constructor and:

    it is a Page and it was not assigned a Project,

    it is a Placement or any class derived from it and was not assigned a Page.

     
    Public PropertyDetermines if StorableObject is correct database object and is not deleted.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type.  
    Public PropertyReturns the project the StorableObject belongs to.  
    Public Property.NET Property enabling access to P8 properties of the StorableObject object.  
    Public PropertyReturns the type of the object as number.  
    Top
    Public Methods
     NameDescription
    Public MethodDestructor for deterministic finalization of StorableObject object.  
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Returns this object created from the string identifier  
    Public MethodServes as the default hash function.  
    Public MethodReturns object type name.  
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure.  
    Public MethodTries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure.  
    Public MethodReturns this object as string identifier.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Returns this object created from the string identifier for the databaseid newDbId.  
    Top
    Public Operators
    Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project.
    Operator of comparison implementation. Checks if two StorableObjects refer to different object in the project.
    Top
    See Also