Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Dialog

Hierarchy

Index

Properties

cancelButton

cancelButton: Button

The cancel button

content

content: string | DialogTab[]

The content of the dialog. If multiple tabs are given they will be displayed with tabs If a string is given, it should be the ID of the dialog's model view content

customButtons

customButtons: Button[]

Any additional buttons that should be displayed

Optional dialogName

dialogName: string

Set the dialog name when opening the dialog for telemetry

isWide

isWide: boolean

Indicates the width of the dialog

message

message: DialogMessage

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

Readonly modelView

modelView: ModelView

Returns the model view content if registered. Returns undefined if model review is not registered

okButton

okButton: Button

The ok button

Readonly onValidityChanged

onValidityChanged: Event<boolean>

Fired whenever the panel's valid property changes

title

title: string

The title of the dialog

Readonly valid

valid: boolean

Whether the panel's content is valid

Methods

registerCloseValidator

  • registerCloseValidator(validator: () => boolean | Thenable<boolean>): void
  • Register a callback that will be called when the user tries to click done. Only one callback can be registered at once, so each registration call will clear the previous registration.

    Parameters

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

      The callback that gets executed when the user tries to click done. Return true to allow the dialog to close or false to block it from closing

        • (): boolean | Thenable<boolean>
        • Returns boolean | Thenable<boolean>

    Returns void

registerContent

  • registerContent(handler: (view: ModelView) => Thenable<void>): void
  • Register model view content for the dialog. Doesn't do anything if model view is already registered

    Parameters

    Returns void

registerOperation

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

    Parameters

    Returns void

Generated using TypeDoc