Graphics Builder Automation Interface - Page Functions

Extensibility > Graphics Builder Automation Interface > Graphics Builder Automation Interface - Page Functions | Extensibility

Page Functions

Using the page functions, you can manipulate the pages in your project (for example, open, close, save, delete), and select objects on those pages. This includes templates, symbols, Genies, Super Genies.

PageActiveWindowHandle	Retrieves the window handle of the active page.
PageClose	Closes the current page. This function will also close an unsaved page.
PageConvertWindowCoordinates	Converts the raw window coordinates to page coordinates which account for the scroll bar position.
PageDelete	Deletes the specified page.
PageDeleteEx	Deletes a specified symbol, Genie or Supergenie from a library.
PageDeleteObject	Deletes the currently selected object.
PageDeleteTemplate	Deletes a specified graphics page template.
PageGroupSelectedObjects	Groups the currently selected objects.
PageImport	Imports a graphics file on to the page as a bitmap.
PageNew	Creates a new Citect SCADA graphics page.
PageNewEx	Creates a new symbol, Genie or Supergenie page.
PageNewLibrary	Creates a new library. Does not succeed, if project is read-only or not valid.
PageNewTemplate	Creates a new Citect SCADA graphics page template.
PageOpen	Opens an existing Citect SCADA graphics page.
PageOpenEx	Opens the specified symbol, Genie or Supergenie page, if it is found.
PageOpenTemplate	Opens a specified graphics page template.
PagePrint	Prints the current page.
PageUpdated	The event fired when a Graphics Builder page is updated.
PageSave	Saves the page using its current name.
PageSaveAs	Saves the page with a new name within a specified project.
PageSaveAsEx	Saves a symbol, Genie, Supergenie or template page to the specified location.
PageSelect	Select an opened page.
PageSelectFirst	Selects the first page currently open in the Graphics Builder. Does not succeed if there are no pages open.
PageSelectFirstObject	Selects the first object on the active page, based on its z-order number. This will not succeed if no object exists. Note that an object can also be a group object, in which case this function will iterate through the items of a group.
PageSelectFirstObjectEx	Selects the first object on the active page, based on its z-order number. This will not succeed if no object exists. This function will not iterate through the items of a group.
PageSelectFirstObjectInGenie	Select the first sub-object in the currently selected genie
PageSelectFirstObjectInGroup	Selects the first object in a group.
PageSelectNext	Selects the next page currently open in the Graphics Builder. Does not succeed if there are no pages open.
PageSelectNextObject	Selects the next object on the active page, based on its z-order number. This function will not succeed if no object exists. Note that an object can also be a group object, in which case this function will iterate through the items of a group.
PageSelectNextObjectEx	Selects the next object on the active page, based on its z-order number. This function will not succeed if no object exists. This function will not iterate through the items of a group.
PageSelectNextObjectInGenie	Select the next sub-object in the currently selected genie.
PageSelectNextObjectInGroup	Selects the next object in a group.
PageSelectObject	Selects an object using a specified AN number.
PageSelectObjectAdd	Selects an additional object using a specified AN number. This can be used to select multiple objects for a succeeding PageGroupSelectedObjects operation.
PageTemplateSelectFirstObject	Restart the template enumeration sequence.
PageTemplateSelectNextObject	Select the next object in the template.
PageThumbnailToClipboard	Creates a thumbnail image of the current page and copies it to the clipboard.
PageUngroupSelectedObject	Ungroups the currently selected grouped object.

For details and a VB example on handling return and error values, see Error Handling.