Cicode Programming Reference > Cicode Function Categories > Page Functions | Cicode

Page Functions

Following are functions relating to graphics pages:

PageAlarm

Displays a category of active alarms on the predefined alarms page.

PageBack

Displays the previously displayed page in the Window.

PageDisabled

Displays a category of disabled alarms on the predefined alarms page.

PageDisplay

Displays a graphics page.

PageExists

Checks if a particular page exists in your project.

PageFile

Displays a file on the predefined file to screen page.

PageFileInfo

Returns the width or height of an unopened page in pixels.

PageFileInfoEx

Returns the width, height or content type of an unopened page.

PageForward

PageForward() restores the previously displayed page in the window following a PageBack command.

PageGetInt

Gets a local page-based integer.

PageGetStr

Gets a local page-based string.

PageGoto

Displays a graphics page without pushing the last page onto the page navigation history.

PageHardware

Displays the active hardware alarms on the predefined alarms page.

PageHistoryDspMenu

Displays a pop-up menu which lists the page history of current window.

PageHistoryEmpty

Used to determine if the page history of the current window is empty.

PageHome

Displays the predefined home page in the window.

PageInfo

Gets page information.

PageKeyboardCommandsPut

Displays keyboard command options that are available in the Graphics Builder via the automation interface.

PageLast

Displays the last ten graphics pages.

PageListCount

Gets number of pages in the page list of the current window.

PageListCurrent

Gets index of the current page in the page list of the current window.

PageListInfo

Gets information of a page at the specific index in the page list of current window.

PageListDisplay

Recalls (displays) a page at the specific index in the page list of the current window, and moves the current index to the page. When a page is recalled, the original parameters (such as cluster context, super genie associations, PageTask arguments if applicable) used to display the page will be restored.

PageListDelete

Removes a page at the specific index from the page list of the current window.

PageMenu

Displays a menu page with page selection buttons.

PageNext

Displays the next graphics page.

PagePeekCurrent

Return the index in the page navigation history for the current page..

PagePeekLast

Gets information about a Page at an offset in the page navigation history.

PagePopLast

Gets the last page in the page navigation history.

PagePopUp

Displays the pop up window at the mouse position.

PagePrev

Displays the previous graphics page.

PageProcessAnalyst

Displays a Process Analyst page (in the same window) preloaded with the pre-defined Process Analyst View (PAV) file.

PageProcessAnalystPens

Display a page and add the specified pens to the first pane of the specified PA object on the page.

PagePushLast

Puts a page on the end of the page navigation history.

PageRecall

Displays the page at a specified depth in the page navigation history.

PageRichTextFile

Used as a page entry function - creates a rich text object, and loads a rich text file into that object.

PageSelect

Displays a dialog box with a list of graphics pages defined in the project.

PageSetInt

Stores a local page-based integer.

PageSetStr

Stores a local page-based string.

PageSOE

Displays a category of sequence of events (SOE) entries on the SOE page.

PageSummary

Displays a category of alarm summary entries on the predefined alarm page.

PageTask

Used for running preliminary Cicode before displaying a page in a window.

PageTransformCoords

Converts Page coordinates to absolute screen coordinates.

PageTrend

Displays a standard trend page in a single cluster system.

PageTrendEx

Displays a standard trend page in a multi-cluster system.

See Also

Published June 2018