PagePopUp

Displays a popup window at the mouse position. If the mouse position is not known then the popup will display in the center of the screen. The window is displayed with no resize and will be closed if the page is changed.

Syntax

PagePopUp(STRING sPage [, STRING sClusterName] [, INT bUnique])

sPage:

The name of the page (created using Graphics Builder).

sClusterName:

The name of the cluster that will accommodate the page at runtime (in quotation marks ""). The specified cluster is used to resolve any tags that have a cluster omitted. If the sPage parameter is prefixed with the name of a cluster, this parameter will not be used.

This parameter is optional, however if you omit a cluster context in the Page properties, then any tags which omit an explicit cluster. TagName will be ambiguous and become unresolved if you have multiple clusters defined in the project. Note that this ambiguity and resulting unresolved state will only occur if the parameter [General]TagDB is set to "0" which disables variable tag database loading.

bUnique:

Determines if a unique window is opened each time. Set this to 1 to prevent the window from being opened more than once. If a window is already opened, the function will exit without opening a new window. Default is 0.

Note: Before Plant SCADA version 5.0, page records could be edited in the Project Editor. One of the fields available for configuration was "Page Number". The value entered for a page could then be used in runtime with the Page Cicode functions such as PageDisplay(), PageGoto(), and PageInfo(1).
For example, PageDisplay("1") can be used to display the page that has "1" (without the quotes) set in the Page Number field. PageInfo(1) returns the Page Number of the current page.
From version 5.0 on, this feature is only backwards-supported. The "Alias" field in the project Pages.DBF file still contains the Page Numbers from upgraded projects; however, the pages database records are no longer available for direct editing in Plant SCADA.

Related Functions

PageLast, PagePeekCurrent, PagePeekLast, PagePopLast, PagePushLast

See Also

Page Functions