Logo FluentUI

WindowRouter QML Type

A singleton for multi-window routing and navigation. More...

Import Statement: import FluentUI.Controls 1.0

Properties

Methods

  • void addWindow(object window)
  • void exit(int retCode)
  • void go(string route, var argument, var windowRegister)
  • void removeWindow(object win)

Detailed Description

WindowRouter manages the navigation between routes and windows in a FluentUI application. It supports launching windows with different launch modes, managing window lifecycles, and passing arguments between windows.

Property Documentation

routes : var

The route table defining the available routes and their associated window or page components. Each route entry specifies a component to load and optional launch configuration.

windows : list<Window>

The list of currently open windows managed by the router. This property is read-only and provides access to all active windows.

Method Documentation

void addWindow(object window)

Registers an existing window with the router for management.

void exit(int retCode)

Exits the application with the specified return code retCode.

void go(string route, var argument, var windowRegister)

Navigates to the specified route. Optional argument can be passed to the target page or window. The windowRegister parameter allows specifying custom window registration options.

void removeWindow(object win)

Unregisters and removes a win from the router's window management.