Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Wizard

Hierarchy

  • Wizard

Index

Properties

backButton

backButton: Button

The back button

cancelButton

cancelButton: Button

The cancel button

Readonly currentPage

currentPage: number

The index in the pages array of the active page, or undefined if the wizard is not currently visible

customButtons

customButtons: Button[]

Any additional buttons that should be displayed for all pages of the dialog. If buttons are needed for specific pages they can be added using the customButtons property on each page.

displayPageTitles

displayPageTitles: boolean

When set to false page titles and descriptions will not be displayed at the top of each wizard page. The default is true.

doneButton

doneButton: Button

The done button

generateScriptButton

generateScriptButton: Button

The generate script button

message

message: DialogMessage

Set the informational message shown in the wizard. Hidden when the message is undefined or the text is empty or undefined. The default level is error.

Optional name

name: string

The name used to identify the wizard in telemetry

nextButton

nextButton: Button

The next button

onPageChanged

onPageChanged: Event<WizardPageChangeInfo>

Event fired when the wizard's page changes, containing information about the previous page and the new page

pages

pages: WizardPage[]

The wizard's pages. Pages can be added/removed while the dialog is open by using the addPage and removePage methods

title

title: string

The title of the wizard

Methods

addPage

  • addPage(page: WizardPage, index?: number): Thenable<void>
  • Add a page to the wizard at the given index

    Parameters

    • page: WizardPage

      The page to add

    • Optional index: number

      The index in the pages array to add the page at, or undefined to add it at the end

    Returns Thenable<void>

close

  • close(): Thenable<void>
  • Close the wizard. Does nothing if the wizard is not open.

    Returns Thenable<void>

open

  • open(): Thenable<void>
  • Open the wizard. Does nothing if the wizard is already open.

    Returns Thenable<void>

registerNavigationValidator

  • registerNavigationValidator(validator: (pageChangeInfo: WizardPageChangeInfo) => boolean | Thenable<boolean>): void
  • Register a callback that will be called when the user tries to navigate by changing pages or clicking done. Only one callback can be registered at once, so each registration call will clear the previous registration.

    Parameters

    • validator: (pageChangeInfo: WizardPageChangeInfo) => boolean | Thenable<boolean>

      The callback that gets executed when the user tries to navigate. Return true to allow the navigation to proceed, or false to cancel it.

    Returns void

registerOperation

  • Register an operation to run in the background when the wizard is done

    Parameters

    Returns void

removePage

  • removePage(index: number): Thenable<void>
  • Remove the page at the given index from the wizard

    Parameters

    • index: number

      The index in the pages array to remove

    Returns Thenable<void>

setCurrentPage

  • setCurrentPage(index: number): Thenable<void>
  • Go to the page at the given index in the pages array.

    Parameters

    • index: number

      The index of the page to go to

    Returns Thenable<void>

Generated using TypeDoc