ShowPage
(Display Manager Library)
Description: | When called with a Page Name, will cause that page to display in the caller's display session context. |
Returns: | Object reference |
Usage: | Script Only. |
Function Groups: | Graphics |
Related to: | StopPage | ClosePopUp |
Format: | \DisplayManager.ShowPage(PageName[, ForceWin, Parm0, ... Parm99]); |
Parameters: |
PageName |
Required. Any text expression for the page to show. This is the name of the module as declared in AppRoot. If referencing a page in a subordinate application, prepend the name of the subordinate tag. For example, "SubTagName\Overview". |
ForceWin |
Optional. Any Boolean value, which if valid and true, requests a new window for the page. |
Parm0 through Parm99 |
Optional. Any parameters to be passed to the page as it is opened. |
Comments: |
The page's window flags will have priority over the value of ForceWin. A page configured to never open in a pop-up won't, even though you set ForceWin to TRUE. The currently signed-in user's security privileges are checked to ensure they have the right to view the page before VTScada opens it. Returns the window object that calls the page. To determine whether a page is already open before calling this function use: NumInstances(\PageModuleName) ... where PageModuleName is the name of the page module.
Pages that are configured to always open in a window (popup) will always open in a new window. Pages whose behavior is set as "Normal" will open in the same window. |
Examples:
If IconPressed[#AlarmIcon]; [ { Alarm icon -- switch to alarm page if clicked } \DisplayManager\ShowPage("AlarmPage"); ]