Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace window

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

DialogButtonPosition

DialogButtonPosition: "left" | "right"

DialogMessage

DialogMessage: { description?: string; level?: MessageLevel; text: string }

A message shown in a dialog. If the level is not set it defaults to error.

Type declaration

  • Optional Readonly description?: string
  • Optional Readonly level?: MessageLevel
  • Readonly text: string

DialogWidth

DialogWidth: "narrow" | "medium" | "wide" | number | string

The width of a dialog, either from a predetermined size list or a specific size (such as px)

Functions

closeDialog

  • closeDialog(dialog: Dialog): void

  • Closes the given dialog if it is open

    Parameters

    Returns void

createButton

  • Create a button which can be included in a dialog

    Parameters

    Returns Button

createModelViewDialog

  • createModelViewDialog(title: string, dialogName?: string, isWide?: boolean): Dialog
  • deprecated

    please use the method createModelViewDialog(title: string, dialogName?: string, width?: DialogWidth) instead. Create a dialog with the given title

    Parameters

    • title: string

      The title of the dialog, displayed at the top

    • Optional dialogName: string
    • Optional isWide: boolean

      Indicates whether the dialog is wide or normal

    Returns Dialog

createTab

  • Create a dialog tab which can be included as part of the content of a dialog

    Parameters

    • title: string

      The title of the page, displayed on the tab to select the page

    Returns DialogTab

createWebViewDialog

  • creates a web view dialog

    Parameters

    • title: string

    Returns ModalDialog

createWizard

  • Create a wizard with the given title and width

    Parameters

    • title: string

      The title of the wizard

    • Optional name: string

      The name used to identify the wizard in telemetry

    • Optional width: DialogWidth

      The width of the wizard, default value is 'narrow'

    Returns Wizard

createWizardPage

  • createWizardPage(title: string, pageName?: string): WizardPage

  • Create a wizard page with the given title, for inclusion in a wizard

    Parameters

    • title: string

      The title of the page

    • Optional pageName: string

      The optional page name parameter will be used for telemetry

    Returns WizardPage

openDialog

  • openDialog(dialog: Dialog): void

  • Opens the given dialog if it is not already open

    Parameters

    Returns void

Generated using TypeDoc