System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.Placement
Eplan.EplApi.DataModel.Group
Eplan.EplApi.DataModel.DocumentBase
Eplan.EplApi.DataModel.MasterData.PlotFrame
Eplan.EplApi.DataModel.Page
public class DocumentBase : Group, IPlacementsContainer
public ref class DocumentBase : public Group, IPlacementsContainer
| Name | Description | |
|---|---|---|
 | DocumentBase Constructor | Default constructor. Creates the DocumentBase object. |
| 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) |
| 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 Page and it was not assigned a Project, it is a Placement or any class derived from it and was not assigned a 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) |
| Location | Overridden. Get or set the placement's location. |
| 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 DocumentBase object. |
| SubPlacements | Returns all grouped Placements. (Inherited from Eplan.EplApi.DataModel.Group) |
| TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Name | Description | |
|---|---|---|
 | 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 Group object. It is placed on the page of first placement given as parameter. (Inherited from Eplan.EplApi.DataModel.Group) |
| DeepUnGroup | Overloaded. Remove all Placements only from a group and it's sub groups. If true method will remove also SubGroups. (Inherited from Eplan.EplApi.DataModel.Group) |
| Dispose() | Destructor (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) |
| 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.Group) |
| GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| InsertSubPlacement | Insert Placement to a group. (Inherited from Eplan.EplApi.DataModel.Group) |
| InsertSubPlacements | Insert Placements to a group. (Inherited from Eplan.EplApi.DataModel.Group) |
| IsEditable | Check if the Group is editable. (Inherited from Eplan.EplApi.DataModel.Group) |
| IsGroupValid | Returns true, if group is valid if not, the group should be dissolved (Inherited from Eplan.EplApi.DataModel.Group) |
| LockObject | Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Move | Moves the group (Inherited from Eplan.EplApi.DataModel.Group) |
| Remove | Removes placement. (Inherited from Eplan.EplApi.DataModel.Group) |
| RemoveSubPlacement | Overloaded. Remove Placement from the group and from the project. The Placement object passed into this method is no longer valid. (Inherited from Eplan.EplApi.DataModel.Group) |
| RemoveSubPlacements | Overloaded. Remove Placements from the group and from the project. The Placement objects passed into this method are no longer valid. (Inherited from Eplan.EplApi.DataModel.Group) |
| 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. (Inherited from Eplan.EplApi.DataModel.Placement) |
| SmartLock | Tries 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) |
| ToStringIdentifier | Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| UnGroup | Overloaded. Remove Placements only from a group. (Inherited from Eplan.EplApi.DataModel.Group) |
