Events

This section describes events fired by this widget.

See Also

appointmentAdded

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The added appointment's data.

error: Error

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The data of the appointment to be added.

cancel:

Boolean

|

Promise<Boolean> (jQuery or native)

Allows you to cancel appointment adding.
If you pass a Promise to this field, appointment adding is continued or canceled once the Promise has been resolved.

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

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The initial appointment.

targetedAppointmentData:

Object

The clicked appointment.

appointmentElement:

Element (jQuery or HTML)

The clicked appointment's container.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

cancel:

Boolean

Allows you 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

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The initial appointment.

targetedAppointmentData:

Object

The clicked appointment.

appointmentElement:

Element (jQuery or HTML)

The clicked appointment's container.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

cancel:

Boolean

Allows you to cancel execution of the default appointment 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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The deleted appointment's data.

error: Error

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The data of the appointment to be deleted.

cancel:

Boolean

|

Promise<Boolean> (jQuery or native)

Allows you to prevent the appointment from being deleted.
If you pass a Promise to this field, appointment deleting is continued or canceled once the Promise has been resolved.

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

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The data of the appointment for which a form is created.

form:

Form

The form's configuration.

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

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The initial appointment's data.

targetedAppointmentData:

Object

The current appointment's data.

appointmentElement:

Element (jQuery or HTML)

The appointment's container.

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

appointmentData:

Object

The updated appointment's data.

error: Error

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

oldData:

Object

The data of the appointment to be updated.

newData:

Object

The appointment with new data.

cancel:

Boolean

|

Promise<Boolean> (jQuery or native)

Allows you to prevent an appointment update.
If you pass a Promise to this field, the appointment updating is continued or canceled once the Promise has been resolved.

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

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

cellData:

Object

The clicked cell's data.

cellElement:

Element (jQuery or HTML)

The clicked cell's container.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

cancel:

Boolean

Allows you 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

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only when using Knockout.

Main article: onContentReady.

See Also

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

See Also

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's instance.

element:

Element (jQuery or HTML)

The widget's container.

Main article: onInitialized

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

See Also