API Help
Eplan.EplApi.DataModel Namespace / StorableObject Class
Properties Methods

In This Topic
    StorableObject Class Members
    In This Topic

    The following tables list the members exposed by StorableObject.

    Public Properties
     NameDescription
    Public PropertyCrossReferencedObjectsAllReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated)  
    Public PropertyDatabaseIdentifierReturns 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 PropertyIsLocked

    Determines if the the StorableObject is locked.

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

     
    Public PropertyIsReadOnlyDetermines if StorableObject is read-only  
    Public PropertyIsTransient

    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 PropertyIsValidDetermines if StorableObject is correct database object and is not deleted.  
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type.  
    Public PropertyProjectReturns the project the StorableObject belongs to.  
    Public PropertyProperties.NET Property enabling access to P8 properties of the StorableObject object.  
    Public PropertyTypeIdentifierReturns the type of the object as number.  
    Top
    Public Methods
     NameDescription
    Public MethodDisposeDestructor for deterministic finalization of StorableObject object.  
    Public MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project.  
    Public Methodstatic (Shared in Visual Basic)FromStringIdentifierOverloaded. Returns this object created from the string identifier  
    Public MethodGetHashCodeServes as the default hash function.  
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure.  
    Public MethodSmartLockTries 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 MethodToStringIdentifierReturns this object as string identifier.  
    Public Methodstatic (Shared in Visual Basic)TryParseIdentifierOverloaded. Returns this object created from the string identifier for the databaseid newDbId.  
    Top
    Public Operators
    public Operator Equality Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project.
    public Operator Inequality Operator of comparison implementation. Checks if two StorableObjects refer to different object in the project.
    Top
    See Also

    Reference

    StorableObject Class
    Eplan.EplApi.DataModel Namespace

     

     

    EPLAN API , 15.12.2018, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

    Send Feedback