SymbolLibrary Class

In This Topic

This class is a interface to symbols library of project.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.MasterData.SymbolLibrary

Syntax

C#
C++/CLI

[DefaultMember("Item")]
public class SymbolLibrary : Eplan.EplApi.DataModel.StorableObject

[DefaultMember("Item")]
public ref class SymbolLibrary : public Eplan.EplApi.DataModel.StorableObject

Public Constructors

	Name	Description
	SymbolLibrary Constructor	Overloaded.

Top

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)
	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 Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project, it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.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)
	Item	Index operator to searching Symbol from given name.
	Name	Project's name.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Project	Overridden. Returns the project the StorableObject belongs to.
	Properties	Internal properties list.
	Symbols	Array of all symbols .
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	Close	Closes the library. Note: Should be used only if this object was initialized with Initialize(System::String^) method and that method returned TRUE.
	Dispose()	Destructor for deterministic finalization of SymbolLibrary 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)
	Initialize	Overloaded. Opens a symbol library from system masterdata pool. Note: if this method returns true, it means that the library was actually open during the initialization and it is the client responsibility to close it.
	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 Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.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

SymbolLibrary Members
Eplan.EplApi.DataModel.MasterData Namespace
Symbol Class

Send Feedback