API Help
Eplan.EplApi.DataModel Namespace / Group Class

In This Topic
Group Class Methods
In This Topic

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

Public Methods
 NameDescription
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 Group object. It is placed on the page of first placement given as parameter.  
Public MethodOverloaded. Remove all Placements only from a group and it's sub groups. If true method will remove also SubGroups.  
Public MethodDestructor for deterministic finalization of Group 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 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 MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodInsert Placement to a group.  
Public MethodInsert Placements to a group.  
Public MethodCheck if the Group is editable.  
Public MethodReturns true, if group is valid if not, the group should be dissolved  
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 MethodMove all Placements in a group by a Eplan.EplApi.Base.PointD given as param.  
Public MethodOverridden. Removes placement.  
Public MethodOverloaded. Remove Placement from the group and from the project. The Placement object passed into this method is no longer valid.  
Public MethodOverloaded. Remove Placements from the group and from the project. The Placement objects passed into this method are no longer valid.  
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 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)
Public MethodTries 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)
Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodOverloaded. Remove Placements only from a group.  
Top
See Also