OptionBase Class

In This Topic

OptionBase is a base class for P8 project's Option classes. It defines properties common for it's descendants.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.OptionBase
         Eplan.EplApi.DataModel.Option
         Eplan.EplApi.DataModel.OptionFragment
         Eplan.EplApi.DataModel.OptionGroup

Syntax

C#
C++/CLI

public class OptionBase : StorableObject

public ref class OptionBase : public 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) (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)
	Description	Description of the option object i.e. OptionGroup or Option.
	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	Name of the option object i.e. OptionGroup or Option.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	.NET Property enabling access to P8 properties of the OptionBase object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	Dispose()	Destructor for deterministic finalization of OptionBase 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)
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	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)

Top

Reference

OptionBase Members
Eplan.EplApi.DataModel Namespace

Send Feedback