system.nav.goHome

note

This function was deprecated in 8.3. Use system.vision.goHome instead.

This function is used in Python Scripting.

Description

When using the typical navigation strategy, this function will navigate to the "home" window. This is automatically detected as the first main-screen window shown in a project. If you are using this system function with system.nav.openWindow(), your home window should be closed before navigating to it, or system.nav.goHome() may not work.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.nav.goHome()

Parameters

Nothing

Returns

Window - A reference to window that was navigated to. Refer to the list of window objects.

Scope

Vision Client

Code Examples

Example #1

# This code would go in a button to move to the Home screen.
system.nav.goHome()