Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProgressDialogParams

Progress dialog parameters.

Hierarchy

Index

Properties

Properties

Optional body

body: string

Dialog text.

Optional buttons

buttons: DialogButton[]

Dialog buttons.

Optional events

events: { onclose: any; onshown: any }

Type declaration

  • onclose: function
    • onclose(e?: { dlg: Dialog; e: any }): void

    • Parameters

      Returns void

  • onshown: function
    • onshown(e?: { dlg: Dialog }): void

    • Parameters

      Returns void

Optional icon

icon: string

The icon to use.

Optional maxHeight

maxHeight: number

Max dialog height.

Optional maxWidth

maxWidth: number

Max dialog width.

message

message: string

The message to use.

Optional noComments

noComments: boolean

[internal] Whether to disable comments.

progress

progress: number | "idle"

The progress.

Optional sounds

sounds: { error: string; info: string; question: string; warning: string }

Dialog sounds.

Type declaration

  • error: string
  • info: string
  • question: string
  • warning: string

Optional title

title: string

The dialog title.

Generated using TypeDoc