Events

This section describes events fired by this widget.

appointmentAdded

Fires after an appointment has been added to the data source.

Type:

Event

Function parameters:
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.

appointmentData:

Object

The appointment object added to the data source.

The standard Error object that defines the occurred error.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentAdding

Fires before an appointment is added to the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

Data that is available for binding against the element. Available only in the Knockout approach.

appointmentData:

Object

The appointment object to be added to the data source.

A flag allowing you to prevent the appointment from being added to the data source.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentClick

Fires after an appointment has been clicked.

Type:

Event

Function parameters:
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.

appointmentData:

Object

The object associated with the initial appointment.

targetedAppointmentData:

Object

The object associated with the clicked appointment.

appointmentElement:

jQuery

An HTML element of the clicked appointment.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

cancel:

Boolean

Indicates whether or not to cancel execution of the default appointment click handler.

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

In case of recurring appointments or appointments with multiple resources, you may want to obtain information about the currently selected appointment, not the initial appointment. For this purpose, use the targetedAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentDblClick

Fires after an appointment has been double clicked.

Type:

Event

Function parameters:
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.

appointmentData:

Object

The object associated with the initial appointment.

targetedAppointmentData:

Object

The object associated with the clicked appointment.

appointmentElement:

jQuery

An HTML element of the clicked appointment.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

cancel:

Boolean

Indicates whether or not to cancel execution of the default appointment double click handler.

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

In case of recurring appointments or appointments with multiple resources, you may want to obtain information about the currently selected appointment, not the initial appointment. For this purpose, use the targetedAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentDeleted

Fires after an appointment has been deleted from the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

Data that is available for binding against the element. Available only in the Knockout approach.

appointmentData:

Object

The appointment object deleted from the data source.

The standard Error object that defines the occurred error.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentDeleting

Fires before an appointment is deleted from the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

Data that is available for binding against the element. Available only in the Knockout approach.

appointmentData:

Object

The appointment object to be deleted from the data source.

A flag allowing you to prevent the appointment from being deleted from the data source.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentFormCreated

Fires after an edit form has been created for an appointment.

Type:

Event

Function parameters:
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.

appointmentData:

Object

The object associated with the appointment for which a form is created.

form:

Object

An instance of the dxForm widget used to edit the appointment details.

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

See Also

appointmentRendered

Fires after an appointment is rendered.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

appointmentData:

Object

The data that is bound to the initial appointment.

targetedAppointmentData:

Object

The data that is bound to the appointment to be rendered.

appointmentElement:

jQuery

An HTML element of the appointment.

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

In case of recurring appointments or appointments with multiple resources, you may want to obtain information about the appointment to be rendered, not the initial appointment. For this purpose, use the targetedAppointmentData field of the function parameter. Otherwise, use the appointmentData field.

See Also

appointmentUpdated

Fires after an appointment has been updated in the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

Data that is available for binding against the element. Available only in the Knockout approach.

appointmentData:

Object

The appointment object updated in the data source.

The standard Error object that defines the occurred error.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

appointmentUpdating

Fires before an appointment is updated in the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

Data that is available for binding against the element. Available only in the Knockout approach.

oldData:

Object

The appointment object to be updated in the data source.

newData:

Object

The appointment object containing new values for the specified appointment.

A flag allowing you to prevent the appointment from being updated in the data source.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

cellClick

Fires after a view cell has been clicked.

Type:

Event

Function parameters:
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.

cellData:

Object

An object associated with the clicked cell.

cellElement:

jQuery

An HTML element of the clicked cell.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

cancel:

Boolean

Indicates whether or not to cancel execution of the default cell click handler.

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

See Also
Show Example:
AngularJS
Knockout
jQuery

contentReady

Fires when the widget content is ready.

Type:

Event

Function parameters:
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 onContentReady option to handle the event.

If data displayed by the widget is specified using a DataSource instance, the contentReady event fires each time the load() method of the DataSource instance is called as well as when the widget content is ready or an appointment is modified.

See Also

disposing

Fires when the widget is being removed.

Type:

Event

Function parameters:
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.

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
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.

Type:

Event

Function parameters:
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