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

Location Class
This class represents location in the Project.
Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.Location

Syntax
public class Location : StorableObject, IWriteProtection  
Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
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) (Inherited from Eplan.EplApi.DataModel.StorableObject)
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. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyGets hierarchy level of location.  
Public Property

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

(Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyGets if the location is currently used  
Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyGets name of location.  
Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyGets parent of location in the same hierarchy(e.g. for +A.A.A.A it is +A.A.A)  
Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public Property.NET Property enabling access to P8 properties of the Location object.  
Public PropertyGets the sorting identifier relative to Location.ParentNode.  
Public PropertyGets 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 PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyCheck if object is currently write protected or sets Manual write protection  
Top
Public Methods
 NameDescription
Public MethodCreates location in the given hierarchy with a given sort order.  
Public MethodDestructor for deterministic finalization of Location object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodChecks if a specific write protection kind was set.  
Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodTemporarily disables write protection. Note that current write protection flags are not cleared.  
Public MethodRemoves unused location from Project.  
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. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Top
See Also