Event arguments for the userPromptDisplaying event.

Constructors

Accessors

  • get canCancel(): boolean
  • Returns a boolean indicating if the operation that triggered the prompt can be cancelled.

    Returns boolean

  • get cancel(): boolean
  • Returns or sets a boolean indicating whether the operation that triggered the prompt should be cancelled. This property is only used if the canCancel is true, which indicates that the operation supports being cancelled, and if displayMessage is set to false. Otherwise if the message is shown and the operation may be cancelled then whether the operation is cancelled will be based upon the users response to the prompt.

    Returns boolean

  • set cancel(v): void
  • Parameters

    • v: boolean

    Returns void

  • get caption(): string
  • Returns or sets the caption for the message dialog that will be displayed.

    Returns string

  • set caption(v): void
  • Parameters

    • v: string

    Returns void

  • get displayMessage(): boolean
  • Returns or sets a boolean indicating if a message will be displayed to the end user.

    Returns boolean

  • set displayMessage(v): void
  • Parameters

    • v: boolean

    Returns void

  • get exception(): any
  • Returns the exception for the error, if there was one.

    Returns any

  • get message(): string
  • Returns or sets the message that will be displayed.

    Returns string

  • set message(v): void
  • Parameters

    • v: string

    Returns void