StorableObject Class

In This Topic

The parent of all API classes representing P8 project and its structure.

Inheritance Hierarchy

Syntax

public class StorableObject

public ref class StorableObject

Public Properties

	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)
	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.
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked.
	IsReadOnly	Determines if StorableObject is read-only
	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.
	IsValid	Determines if StorableObject is correct database object and is not deleted.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type.
	Project	Returns the project the StorableObject belongs to.
	Properties	.NET Property enabling access to P8 properties of the StorableObject object.
	TypeIdentifier	Returns the type of the object as number.

Public Methods

	Name	Description
	Dispose	Destructor for deterministic finalization of StorableObject object.
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project.
	FromStringIdentifier	Overloaded. Returns this object created from the string identifier
	GetHashCode	Serves as the default hash function.
	GetTypeName	Returns object type name.
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure.
	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.
	ToStringIdentifier	Returns this object as string identifier.
	TryParseIdentifier	Overloaded. Returns this object created from the string identifier for the databaseid newDbId.

Public Operators

Equality	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project.
Inequality	Operator of comparison implementation. Checks if two StorableObjects refer to different object in the project.

Send Feedback