DialogEventArgs

Description

sealed class Tinman.Engine.Widgets.DialogEventArgs

Event arguments for widget dialogs.

Public / Constructors

DialogEventArgs


public constructor DialogEventArgs → (4)

dialog in : string

See Dialog.

resultCode in : DialogResultCode

See ResultCode.

resultValue opt : object = null

See ResultValue.

userData opt : object = null

See UserData.

Creates a new instance of DialogEventArgs.

Public / Methods

Cancel


public method Cancel → ()

returns → bool

true if this dialog event is DialogResultCode.Cancel and has been consumed, false if not.

Consumes this dialog event if it represents DialogResultCode.Cancel.

Consume


public method Consume → ()

Consumes this dialog event so that subsequent handlers will not process it.

Ok


public method Ok → ()

returns → bool

true if this dialog event is DialogResultCode.Ok and has been consumed, false if not.

Consumes this dialog event if it represents DialogResultCode.Ok.

Public / Attributes

Dialog


public readonly attribute Dialog → (string)

The identifier of the dialog that has produced the event.

IsConsumed


public attribute IsConsumed → (get)

value : bool

true if an earlier handler has already processed the dialog event, false if the event is still unhandled.

Has this dialog event been consumed?

ResultCode


public readonly attribute ResultCode → (DialogResultCode)

The result code of the dialog.

ResultValue


public readonly attribute ResultValue → (object)

The result value of the dialog or null if none.

UserData


public readonly attribute UserData → (object)

The user data value of the dialog or null if none.