Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProgressDialog

Represents a progress dialog.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

closing

closing: boolean

Whether the dialog is closing.

params

params: DialogParams

The dialog creation parameters.

result

result: { button?: string }

Dialog result.

Type declaration

  • Optional button?: string

    Selected button.

wnd

wnd: StandardWindow

The underlying window.

Methods

Optional _resolveFn

  • _resolveFn(): void

  • [internal] Do not use.

    Returns void

body

  • body(): HTMLElement

  • Returns the body.

    Returns HTMLElement

    The body HTML container.

center

  • center(): void

  • Centers the dialog.

    Returns void

close

  • close(): void

  • Closes the dialog.

    Returns void

setMessage

  • setMessage(text: string): void

  • Sets the progress message.

    Parameters

    • text: string

      The text to use.

    Returns void

setProgress

  • setProgress(prog: number | "idle"): void

  • Sets the dialog progress.

    Parameters

    • prog: number | "idle"

      The progress to set.

    Returns void

show

  • show(): void

  • Shows the dialog.

    Returns void

wait

  • wait(): Promise<void>

  • Waits for dialog closure.

    Returns Promise<void>

Generated using TypeDoc