Page
Page class
Contains elements that define a page in the document.
Page()
Constructor.
Properties
| Name | Type | Description |
|---|---|---|
| Pages | PageCollection | Page collection. |
| Shapes | ShapeCollection | Shape collection. |
| PageSheet | PageSheet | Contains elements that define the page sheet for a Page or Master element. |
| Connects | ConnectCollection | Contains a Connect element for each connection between two shapes in a drawing. |
| ID | int | The unique ID of the element within its parent element. |
| Name | String | The name of the element. |
| NameU | String | The universal name of the element. |
| Background | int | A flag indicating if the page is a background page. The value of the property is BOOL integer constant. |
| BackPage | Page | The page’s background page. |
| ViewScale | float | The default magnification factor to use when a new view (window) of the page is opened. For example, 1 = 100%; 1.5 = 150 |
| ViewCenterX | float | ViewCenterX and ViewCenterY specify a center point on a page that a new view (window) assumes when it is opened initiall |
| ViewCenterY | float | ViewCenterX and ViewCenterY specify a center point on a page that a new view (window) assumes when it is opened initiall |
| ReviewerID | int | The ID of the reviewer associated with the markup overlay. |
| AssociatedPage | Page | The ID of the original drawing page that was marked up on separate markup overlays by reviewers of the drawing. |
| PresetTheme | int | Apply a preset theme to this page The value of the property is PresetThemeValue integer constant. |
| PresetThemeVariant | int | Apply a preset theme variant to this page The value of the property is PresetThemeVariantValue integer constant. |
| PresetThemeQuickStyle | int | Apply a preset theme variant quickstyle to this page The value of the property is PresetQuickStyleValue integer constant |
Methods
| Name | Description |
|---|---|
| centerDrawing | Centers a page’s shapes with respect to the extent of the page. Centering shapes does not change their position relative |
| copy | |
| dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| applyStyle | Applies style for full page. |
Default value is -1. | | moveTo | Moves the page to another location in the pages. | | addShape | Adds shape created by master on page with defined PinX and PinY. | | connectShapesViaConnector | Connect shapes via connector. | | glueShapeToConnectorBeginX | Glue shape to Connector’s BeginX | | glueShapeToConnectorEndX | Glue shape to Connector’s EndX | | connectShapesViaConnectorIndex | Connect shapes via connector index. | | glueShapesInContainerByID | Glue shapes by connection id in container | | glueShapesInContainer | Glue shapes in container using connection name | | bringForward | Brings a shape,defined by ID, forward one position in the z-order. | | sendBackward | Moves a shape,defined by ID, back one position in the z-order. | | bringToFront | Brings a shape,defined by ID, to the front of the z-order. | | sendToBack | Moves a shape,defined by ID, to the back of the z-order. | | addComment | Adds comment to a shape with shape’s id. | | autoSpaceShapes | Auto space shapes | | addText | Adds Text with defined PinX and PinY. | | drawLine | The process of drawing a single line. | | drawRectangle | The process of drawing rectangle. | | drawEllipse | The process of drawing Ellipse. | | drawOwal | The process of drawing owal. | | dropContainer | The process of creating Container. | | drawPolyline | The process of drawing Polyline. |