system.nav.goHome

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.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.nav.goHome()

Parameters

None

Returns

PyObject - A reference to the home window that was navigated to.

Scope

Client

Code Examples

Code Snippet

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