PlaceHolder3D Class

In This Topic

TODO

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.E3D.PlaceHolder3D

Syntax

C#
C++/CLI

public class PlaceHolder3D : Eplan.EplApi.DataModel.StorableObject, Eplan.EplApi.DataModel.IPlaceHolder

public ref class PlaceHolder3D : public Eplan.EplApi.DataModel.StorableObject, Eplan.EplApi.DataModel.IPlaceHolder

Public Constructors

	Name	Description
	PlaceHolder3D Constructor	Default constructor.

Top

Public Properties

	Name	Description
	AssignedObjects	Gets/Sets a list of StorableObject references to a PlaceHolder3D object. The originally assigned references are replaced.
	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)
	InstallationSpace	Returns InstallationSpace in which this object exists or `null`.
	IsDocumentReferenceActive	Activates the properties of the installation space for the place holder object.
	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)
	Name	Gets/Sets the name of the Placeholder3D.
	NameOfRecord	Gets/Sets the name of a record, specified by its index.
	NumberOfRecords	Count of records.
	NumberOfReferences	Count of objects referenced by the Placeholder3D.
	NumberOfVariables	Count of Variables.
	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 EPLAN properties of the PlaceHolder3D object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Value	Gets/Sets the value of a variable for a record.
	VariableNames	Names of all variables in the Placeholder3D.

Top

Public Methods

	Name	Description
	AddRecord	Adds a new record with the specified name to the Placeholder3D object.
	AddReference	Adds the reference of a Placement3D object to the Placeholder3D.
	AddVariable	Adds a new variable to the Placeholder3D object.
	ApplyRecord	Overloaded. Applies a record of values on a PlaceHolder3D object.
	Create	Creates a new PlaceHolder3D object on the specified InstallationSpace.
	CreateTransient	Creates transient and not placed PlaceHolder3D object.
	DeleteRecord	Overloaded. Deletes a record.
	DeleteUnusedVariables	Deletes all unused variables.
	DeleteVariable	Deletes a variable.
	Dispose()	Destructor for deterministic finalization of PlaceHolder3D 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)
	FindRecord	Finds a record by name.
	FindReference	Finds an object in the list of object referenced by a Placeholder3D.
	FindVariable	Finds a variable, specified by its name.
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetPropertyEntry	Gets a value or variable on a property of an object referenced by a Placeholder3D.
	GetRecordNames	\Returns the names of all records in the nIndex-th PlaceHolder3D of a Macro.
	GetValue	Gets the value of a variable for a record.
	GetValues	\Returns the values of all variables in the nIndex-th PlaceHolder3D of a Macro variant for a given record.
	GetVariableNames	\Returns the names of all variables in the nIndex-th PlaceHolder3D of a Macro variant.
	IsVariableValid	Verifies the correctness if a variable name of a placeholder. If a variable name contains invalid characters, this method \returns false.
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	RemoveInvalidObjectReferences	Removes invalid (e.g. deleted) object references from a PlaceHolder3D.
	RemoveObjectReferences	Removes object references from a PlaceHolder3D.
	SetPropertyEntry	Sets a value or variable on a property of an object referenced by a Placeholder3D. The reference of the object will be added to the Placeholder3D if necessary.
	SetValue	Sets the value of a variable for a record.
	SmartLock	Tries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; 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

PlaceHolder3D Members
Eplan.EplApi.DataModel.E3D Namespace

Send Feedback