Navigator Methods

Not supported by TWC

Method icon The Navigator supports the following scripting methods.

See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.

Method Description

Equals

The Equals method determines whether the specified object is equal to the current object.

GetHashCode

The GetHashCode method returns a hash code for the current object.

GetType

The GetType method returns the runtime type of the current instance.

HyperlinkReplace

The HyperlinkReplace method replaces the active screen in the control with a facility's associated screen.

See Hyperlinking Screens and Navigation by Facility for more information about using this method.

HyperlinkReplaceWithNavigation

The HyperlinkReplaceWithNavigation method replaces the active screen in the control with a facility's associated screen and adds a navigation toolbar.

See Hyperlinking Screens and Navigation by Facility for more information about using this method.

Refresh

The Refresh method resets the cache and gets all data for the control from the associated service.

ReturnToStartScreen

The ReturnToStartScreen method returns the Navigator menu to the start screen.

Select

The Select method takes in a NavigationItem as a parameter and sets the ActiveItem property to that item and does not return any value. Select allows you to provide navigation items that do not exist in the navigation menu. This is how you select navigation items via script.

ToString

The ToString method returns a string that represents the current object.