Name | Description | |
---|---|---|
Page Constructor | Overloaded. |
The following tables list the members exposed by Page.
Name | Description | |
---|---|---|
Page Constructor | Overloaded. |
Name | Description | |
---|---|---|
AllFirstLevelPlacements | All Placements including Groups placed on this page. They are not filtered. All returned Placements are placed directly on this page. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding). | |
AllGraphicalPlacements | All Eplan.EplApi.DataModel.Graphics.GraphicalPlacements placed on this page. They are not filtered. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding). | |
AllPlacements | All Placements, placed on this page. Groups are ungrouped and contained Placements are returned. They are not filtered. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding). This method does not return Eplan.EplApi.DataModel.Graphics.PropertyPlacement. | |
BoxedDevices | Returns all BoxedDevices placed on the page. If the filter was set up, returns BoxedDevices matching the filter. | |
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) | |
Filter | Page's property that allows to access current page's filter. It affects properties "Functions", "Terminals", "TerminalStrips", "Plugs", "PlugStrips" and "PLCs". | |
Functions | Returns all Functions placed on the page. If the filter was set up, returns Functions matching the filter. | |
GridSize | Gets/sets the size of the page's grid. | |
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) | |
IdentifyingName | Returns identifying name of the page. | |
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) | |
IsLogicalPage | Returns if the page is a logical page. | |
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 | Get or set the placement's location. (Inherited from Eplan.EplApi.DataModel.DocumentBase) | |
MacroRepresentationType | Page's property describing type of macro. This type is used to find a suitable variant of macro, which can be insert on this page. While inserting macro on page, inserting variant of macro is get from page's MacroRepresentationType and variant of macro defined by user. This property depends on property PageType. | |
Name | Get or set name of the page. When setting this property, it is not checked whether the given name already exists in project. | |
NameParts | Gets/Sets the name of a page. | |
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) | |
PageType | Gets/sets a page's property describing type of document | |
PageTypeName | Returns name of the page's type. | |
PlanningSegment | Get or set planning objects to which this page is assigned or null. | |
PLCs | Returns all Eplan.EplApi.DataModel.EObjects.PLCs placed on the page. If the filter was set up, returns BoxedDevices matching the filter. | |
PlotFrame | Returns the page PlotFrame. | |
PlugStrips | Returns all Eplan.EplApi.DataModel.EObjects.PlugStrips placed on the page. If the filter was set up, returns Eplan.EplApi.DataModel.EObjects.PlugStrips matching the filter. | |
Project | Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject) | |
Properties | Property enabling access to internal properties of the Page object. | |
ReportBlock | ReportBlock which contains data describing report from this page. | |
Size | Returns the exact size of the page, takes into account page scale. The size is calculated from center of border lines. | |
SubPlacements | Returns all grouped Placements. (Inherited from Eplan.EplApi.DataModel.Group) | |
TerminalStrips | Returns all Eplan.EplApi.DataModel.EObjects.TerminalStrips placed on the page. If the filter was set up, returns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching the filter. | |
TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) | |
WriteProtected | Check if object is currently write protected or sets Manual write protection |
Name | Description | |
---|---|---|
ConvertToGraphics | Converts all symbols and connections on the page into graphical instances. Graphical instances of a given symbol are automatically grouped. | |
CopyTo | Overloaded. Creates copy of this page. | |
Create | Overloaded. Creates a new Page object. It is placed in the project under location given as parameters. | |
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 | Overridden. Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. | |
GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) | |
GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) | |
GetWriteProtectionFlagSet | Checks if a specific write protection kind was set. | |
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) | |
PauseWriteProtection | Temporarily disables write protection. Note that current write protection flags are not cleared. | |
Remove | Overridden. Removes placement. | |
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) | |
SetName | Sets the name of the page. Name parts should be given in the PagePropertyList. | |
SetProject | Assigns a page to a given project. | |
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) |