System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.Location
System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.Location
public class Location : StorableObject, IWriteProtection
public ref class Location : public StorableObject, IWriteProtection
| Name | Description | |
|---|---|---|
 | Location Constructor | Overloaded. |
| Name | Description | |
|---|---|---|
 | CrossReferencedObjectsAll | Returns 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) |
| DatabaseIdentifier | Returns 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) |
| HierarchyId | Gets hierarchy level of location. |
| IsLocked | Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsReadOnly | Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsTransient | 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) |
| IsValid | Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Name | Gets name of location. |
| ObjectIdentifier | Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| ParentNode | Gets parent of location in the same hierarchy(e.g. for +A.A.A.A it is +A.A.A) |
| Project | Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Properties | .NET Property enabling access to P8 properties of the Location object. |
| SortId | Gets the sorting identifier relative to Location.ParentNode. |
| SubNodes | Gets 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) |
| TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| WriteProtected | Check if object is currently write protected or sets Manual write protection |
| Name | Description | |
|---|---|---|
 | Create | Creates location in the given hierarchy with a given sort order. |
| Dispose() | Destructor for deterministic finalization of Location object. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Equals | Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetWriteProtectionFlagSet | Checks if a specific write protection kind was set. |
| LockObject | Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| PauseWriteProtection | Temporarily disables write protection. Note that current write protection |
| SmartLock | Tries 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) |
| ToStringIdentifier | Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject) |