Eplan Platform API
Eplan.EplApi.DataModel.Graphics Namespace / PlaceHolder Class

In This Topic
PlaceHolder Class Methods
In This Topic

For a list of all members of this type, see PlaceHolder members.

Public Methods
 NameDescription
Public MethodAdds a new record with the specified name to the PlaceHolder object.  
Public MethodAdds the reference of a Placement object to the placeholder.  
Public MethodAdds a new variable to the PlaceHolder object.  
Public MethodOverloaded. Applies a record of values on a PlaceHolder object.  
Public MethodOverloaded. 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)
Public MethodCreates a new PlaceHolder object on the specified Page.  
Public MethodOverridden. Creates transient and not placed PlaceHolder object.  
Public MethodOverloaded. Deletes a record.  
Public MethodDeletes all unused variables.  
Public MethodDeletes a variable.  
Public MethodDestructor for deterministic finalization of PlaceHolder object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodFinds a record by name.  
Public MethodFinds an object in the list of object referenced by a PlaceHolder.  
Public MethodFinds a variable, specified by its name.  
Public MethodGets a list of all current values in Placeholder.  
Public MethodPlacement 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)
Public MethodGets current value for given object, property and index.  
Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodGets a value or variable of Placeholder project property.  
Public MethodGets a value or variable on a property of an object referenced by a PlaceHolder.  
Public Method\Returns the names of all records in the nIndex-th PlaceHolder of a Macro.  
Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodGets the value of a variable for a record.  
Public MethodReturns the values of all variables in the nIndex-th PlaceHolder of a Macro variant for a given record.  
Public Method\Returns the names of all variables in the nIndex-th PlaceHolder of a Macro variant.  
Public MethodVerifies the correctness if a variable name of a placeholder. If a variable name contains invalid characters, this method \returns false.  
Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodRemoves placement. (Inherited from Eplan.EplApi.DataModel.Placement)
Public MethodRemoves invalid (e.g. deleted) object references from a PlaceHolder.  
Public MethodRemoves object references from a PlaceHolder.  
Public MethodOverloaded. 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. (Inherited from Eplan.EplApi.DataModel.Placement)
Public MethodSets a value or variable on Placeholder project property. The reference of the object will be added to the Placeholder if necessary.  
Public MethodSets 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.  
Public MethodSets the value of a variable for a record.  
Public MethodTries 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)
Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Top
See Also