Eplan Platform API
Eplan.EplApi.DataModel Namespace / Location Class
Properties Methods

In This Topic
    Location Class Members
    In This Topic

    The following tables list the members exposed by Location.

    Public Constructors
     NameDescription
    Public ConstructorLocation ConstructorOverloaded.   
    Top
    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) (Inherited from Eplan.EplApi.DataModel.StorableObject)
    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. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyHierarchyIdGets hierarchy level of location.  
    Public PropertyIsLocked

    Determines if the the StorableObject is locked.

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

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    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.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsUsedGets if the location is currently used  
    Public PropertyIsValidDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyNameGets name of location.  
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyParentNodeGets parent of location in the same hierarchy(e.g. for +A.A.A.A it is +A.A.A)  
    Public PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProperties.NET Property enabling access to P8 properties of the Location object.  
    Public PropertySortIdGets the sorting identifier relative to Location.ParentNode.  
    Public PropertySubNodesGets all child locations in the same hierarchy (e.g. for +A.A.A it may be: +A.A.A.A, +A.A.A.B, +A.A.A.C, or other)  
    Public PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyWriteProtectedCheck if object is currently write protected or sets Manual write protection  
    Top
    Public Methods
     NameDescription
    Public MethodCreateCreates location in the given hierarchy with a given sort order.  
    Public MethodDispose()Destructor for deterministic finalization of Location object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetWriteProtectionFlagSetChecks if a specific write protection kind was set.  
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodPauseWriteProtectionTemporarily disables write protection. Note that current write protection flags are not cleared.  
    Public MethodRemoveRemoves unused location from Project.  
    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. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodToStringIdentifierReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also

    Reference

    Location Class
    Eplan.EplApi.DataModel Namespace

     

     

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

    Send Feedback