| Name | Description | |
|---|---|---|
 | PlaceHolder Constructor | Default constructor |
The following tables list the members exposed by PlaceHolder.
| Name | Description | |
|---|---|---|
| PlaceHolder Constructor | Default constructor |
| Name | Description | |
|---|---|---|
 | Values | Represents values table of a placeholder |
| ValueSets | Represents value sets of a placeholder |
| Variables | Represents variables of a placeholder |
| Name | Description | |
|---|---|---|
 | ArePagePropertiesDisplayed | Activates the properties of the page for the place holder object. |
| AssignedObjects | Gets/Sets a list of StorableObject references to a PlaceHolder 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) |
| DrawingOrder | Sets display sequence. The drawing order flag will be used to sort elements according to drawing order within a group. If elements chare the same value the drawing order will result from order of the data model. Default value is 67. (Inherited from Eplan.EplApi.DataModel.Placement) |
| Group | Returns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Placement) |
| 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) |
| IsPlaced | Returns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement) |
| IsReadOnly | Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsSetAsVisible | Gets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement) |
| 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) |
| IsVisible | Gets/Sets the actual visibility state of the object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement) |
| LayerId | Gets layer id of layer assigned to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement) |
| Location | Overridden. Get or set the placement's location. |
| Name | Gets/Sets the name of the placeholder. |
| NameOfRecord | Gets/Sets the name of a record, specified by its index. |
| NumberOfRecords | Count of records. |
| NumberOfReferences | Count of objects referenced by the PlaceHolder. |
| 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) |
| Page | Returns the page the Placement is on, or assigns a Page object to the placement. If the placement was previously assigned to another page, it is removed from old one and assigned to the page given as an argument. (Inherited from Eplan.EplApi.DataModel.Placement) |
| Project | Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Properties | .NET Property enabling access to P8 properties of the PlaceHolder object. |
| PropertyPlacements | Returns PropertyPlacements assigned to the PlaceHolder. |
| SymbolVariant | Specifies Eplan.EplApi.DataModel.MasterData.SymbolVariant assigned to this PlaceHolder. |
| 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 PlaceHolder. |
| Name | Description | |
|---|---|---|
 | AddRecord | Adds a new record with the specified name to the PlaceHolder object. |
| AddReference | Adds the reference of a Placement object to the placeholder. |
| AddVariable | Adds a new variable to the PlaceHolder object. |
| ApplyRecord | Overloaded. Applies a record of values on a PlaceHolder object. |
| CopyTo | Overloaded. Copy Placement and insert the Copy into destination group. Copied placement will be inserted into desired project of destination group. If this placement is temporary, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted. Defines whether a layer should be matched by name. (Inherited from Eplan.EplApi.DataModel.Placement) |
| Create | Creates a new PlaceHolder object on the specified Page. |
| CreateTransient | Overridden. Creates transient and not placed PlaceHolder object. |
| DeleteRecord | Overloaded. Deletes a record. |
| DeleteUnusedVariables | Deletes all unused variables. |
| DeleteVariable | Deletes a variable. |
| Dispose() | Destructor for deterministic finalization of PlaceHolder 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 PlaceHolder. |
| FindVariable | Finds a variable, specified by its name. |
| GetBoundingBox | Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. (Inherited from Eplan.EplApi.DataModel.Placement) |
| 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 PlaceHolder. |
| GetRecordNames | \Returns the names of all records in the nIndex-th PlaceHolder of a Macro. |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetValue | Gets the value of a variable for a record. |
| GetValues | Returns the values of all variables in the nIndex-th PlaceHolder of a Macro variant for a given record. |
| GetVariableNames | \Returns the names of all variables in the nIndex-th PlaceHolder 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) |
| Remove | Removes placement. (Inherited from Eplan.EplApi.DataModel.Placement) |
| RemoveInvalidObjectReferences | Removes invalid (e.g. deleted) object references from a PlaceHolder. |
| RemoveObjectReferences | Removes object references from a PlaceHolder. |
| Scale | Overloaded. Scales the placement (or group of placements) by the specified factors in X and Y axis with scaling origin point specified by the ptOrigin parameter X axis factor. E.g. value of 2 makes the width two times bigger.Y axis factor. E.g. value of 0.5 makes the height two times smaller.Scaling origin point. (Inherited from Eplan.EplApi.DataModel.Placement) |
| SetPropertyEntry | Sets a value or variable on a property of an object referenced by a PlaceHolder. The reference of the object will be added to the PlaceHolder if necessary. |
| SetValue | Sets the value of a variable for a record. |
| SetVisibilityDependingOnLayer | This method sets the visibility of the graphical instance to depend on the layer setting (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement) |
| 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) |