Displays the page specified in the Target Page field configured for the current Navigation Menu Item.
This function should only be called as a menu command of a menu item. If your project is using multiple resolutions, you only need to specify the first part of your page name and the workspace will choose the best version to suit the required screen resolution. For example, if you have “MyPage_HD1080” and “MyPage_UHD4K”, just specify “MyPage”. For more information, see Configure a Project that Supports Multiple Screen Resolutions.
Syntax
Navigation_ShowTargetPage([STRING sPaneRef [, STRING sEquipmentContext [, STRING sEquipmentSecondaryContext [, STRING sWorkspaceName]]]])
sPaneRef
Name of the pane in which to display the target page. This is an optional parameter. This is the format of “<panename>.<panename>” if needing to display in a nested pane. If not specified, a pane that hosts the content type of the target page will be used. The default is "", which displays the page in the default pane.
sEquipmentContext
Equipment context to set for the page. This is an optional parameter. If not specified, the current context of the workspace will be used. The default value is WS_CONTEXT_Clear, which clears the context. If set to "", it retains the existing context.
sEquipmentSecondaryContext
The value of the equipment name that is set as the secondary context for related equipment. This is an optional parameter. For example, for a Polar Star Composite Genie, this will be the value specified in the Equipment Name option in the Presentation Options dialog box. This is used to determine the number of symbols to be displayed for MEOs. The default value is "", which retains the existing context.
sWorkspaceName
The name of the workspace in which to display the page. This is an optional parameter. If not specified, the workspace of the current window will be used. The default is "", which uses the worrspace of the current window.
Return Value
N/A
Related Functions
Published June 2018