Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Main article: onContentReady.

See Also

disposing

Fires when the widget is being removed.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onDisposing option to handle the event.

See Also
NOTE
This event fires only if the widget is removed using the remove(), empty(), or html() jQuery methods.

hidden

Fires after the overlay is hidden.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onHidden option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

hiding

Fires before hiding the overlay.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
cancel: Boolean
Indicates whether to cancel hiding the overlay.

Instead, you can use the onHiding option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

initialized

Raised only once, after the widget is initialized.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.

Main article: onInitialized

See Also

optionChanged

Fires after an option of the component is changed.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onOptionChanged option to handle the event.

See Also

showing

Fires before showing the overlay.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onShowing option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

shown

Fires after the overlay is shown.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onShown option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

titleRendered

Fires after the widget title is rendered.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
titleElement: jQuery
The HTML element of the item title.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onTitleRendered option to handle the event.

See Also