Back to Devexpress

SchedulerControl Events

windowsforms-devexpress-dot-xtrascheduler-dot-schedulercontrol-dot-underscore-events.md

latest43.8 KB
Original Source

SchedulerControl Events

Displays scheduled data using one of the available views and provides the capability to edit, save and load appointments. See Scheduler.

NameDescription
ActiveViewChangedOccurs after the active view of the Scheduler control has been changed.
ActiveViewChangingOccurs when the Scheduler control is changing its active view.
AllowAppointmentConflictsOccurs when the scheduler finds appointments that are in conflict, and the SchedulerOptionsCustomization.AllowAppointmentConflicts property is set to Custom.
AllowAppointmentCopyOccurs when an end-user tries to copy an appointment and the SchedulerOptionsCustomization.AllowAppointmentCopy property is set to Custom.
AllowAppointmentCreateOccurs when an end-user tries to create a new appointment and the SchedulerOptionsCustomization.AllowAppointmentCreate property is set to Custom.
AllowAppointmentDeleteOccurs when the SchedulerControl checks whether the appointment can be deleted. The event fires only if the SchedulerOptionsCustomization.AllowAppointmentDelete property is set to Custom.
AllowAppointmentDragOccurs when an end-user tries to drag an appointment and the SchedulerOptionsCustomization.AllowAppointmentDrag property is set to Custom.
AllowAppointmentDragBetweenResourcesOccurs when an end-user tries to drag an drop an appointment between resources and the SchedulerOptionsCustomization.AllowAppointmentDragBetweenResources property is set to Custom.
AllowAppointmentEditOccurs when an end-user tries to edit an appointment and the SchedulerOptionsCustomization.AllowAppointmentEdit property is set to Custom.
AllowAppointmentResizeOccurs when an end-user tries to resize an appointment and the SchedulerOptionsCustomization.AllowAppointmentResize property is set to Custom.
AllowInplaceEditorOccurs when an end-user tries to invoke an appointment’s in-place editor and the SchedulerOptionsCustomization.AllowInplaceEditor property is set to Custom.
AppointmentDragOccurs when appointment is dragged in the Scheduler control.
AppointmentDropFires when you drop the appointment dragged with the mouse.
AppointmentDropComplete
AppointmentFlyoutHtmlElementMouseClickOccurs when a user clicks any HTML element within a flyout tooltip whose content is specified with an HTML template.
AppointmentFlyoutShowingOccurs before the appointment flyout is shown and allows you to substitute a flyout with another control.
AppointmentHtmlElementMouseClick
AppointmentResizedOccurs after the user modifies the appointment’s interval by dragging its border with the mouse.
AppointmentResizingOccurs when the user starts modifying the appointment’s interval by dragging its border with the mouse.
AppointmentsDragThe resulting event that fires after the last AppointmentDrag event. Allows you to schedule appointments added to the AdditionalAppointments collection, and perform other actions.
AppointmentsDropThe resulting event that fires after the last AppointmentDrop event. Allows you to perform custom actions when the drag-and-drop operation is over.
AppointmentViewInfoCustomizingUse this event to customize the appointment’s appearance by modifying the style elements when it is painted. If the multi-threading is on, this event does not raise in the UI thread.
AutoSizeChangedThis event is not relevant for this class. Inherited from Control.
BackColorChangedOccurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChangedOccurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChangedOccurs when the BackgroundImageLayout property changes. Inherited from Control.
BeforeLoadLayoutOccurs before a layout is restored from storage (a stream, xml file or the system registry).
BindingContextChangedOccurs when the value of the BindingContext property changes. Inherited from Control.
CausesValidationChangedOccurs when the value of the CausesValidation property changes. Inherited from Control.
ChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
ClickOccurs when the control is clicked. Inherited from Control.
ClientSizeChangedOccurs when the value of the ClientSize property changes. Inherited from Control.
ContextMenuChangedOccurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAddedOccurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemovedOccurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CursorChangedOccurs when the value of the Cursor property changes. Inherited from Control.
CustomAppointmentFlyoutTemplateValueAllows you to pass values to elements bound to an appointment flyout’s data fields.
CustomAppointmentGroupAllows you to split appointments into groups.
CustomAppointmentSortAllows you to sort appointments in any custom order.
CustomAppointmentTemplateValueAllows you to assign custom values to HTML elements bound to data fields.
CustomDayViewColumnWidthAllows you to set custom relative widths to DayView, WorkWeekView and FullWeekView columns.
CustomDrawAppointmentEnables appointments to be painted manually.
CustomDrawAppointmentBackgroundEnables the backgrounds of appointments to be painted manually.
CustomDrawAppointmentFlyoutSubjectOccurs before displaying the appointment flyout. Follows the SchedulerControl.CustomizeAppointmentFlyout event. Enables you to manually draw the visual elements composing the Subject rectangle without having to do a full default draw.
CustomDrawDayHeaderEnables day headers to be painted manually.
CustomDrawDayOfWeekHeaderEnables day of week headers to be painted manually.
CustomDrawDayViewAllDayAreaEnables the All-Day Area to be painted manually.
CustomDrawDayViewTimeRulerEnables the time ruler to be painted manually.
CustomDrawDependencyEnables dependencies to be painted manually.
CustomDrawGroupSeparatorEnables group separators to be painted manually.
CustomDrawNavigationButtonEnables navigation buttons to be painted manually.
CustomDrawResourceHeaderEnables resource headers to be painted manually.
CustomDrawTabHeaderAllows you to paint resource tab headers.
CustomDrawTimeCellAllows you to manually paint time cells.
CustomDrawTimeIndicatorEnables the Time Indicator to be painted manually.
CustomDrawTimeRegionHandle this event to manually re-paint Time Regions.
CustomDrawViewEnables drawing objects on the top of the scheduler view.
CustomDrawWeekViewTopLeftCornerEnables the top left corner of the week view to be painted manually.
CustomizeAppointmentFlyoutOccurs before displaying an appointment flyout and allows you to change the displayed text, background and the subject’s font. Precedes the SchedulerControl.CustomDrawAppointmentFlyoutSubject event.
CustomizeAppointmentFlyoutTemplateAllows you to dynamically customize elements of appointment flyout rendered from HTML-CSS templates.
CustomizeAppointmentTemplateAllows you to hide specific HTML elements at runtime, or change their CSS style properties.
CustomizeDateNavigationBarCaptionHandle this event to specify the caption of the Date Navigation Bar control.
CustomizeMessageBoxCaptionAllows you to change the caption of a built-in message box that prompts the user for an action after an error condition has occurred.
CustomizePageSetupResources
CustomizeResourceHeaderTemplateAllows you to modify resource header templates at runtime.
CustomResourceHeaderTemplateValueAllows you to pass values to elements bound to custom data fields.
DateNavigatorQueryActiveViewTypeEnables you to specify the active view type of the Scheduler when the user selects dates in the bound DateNavigator.
DeleteRecurrentAppointmentFormShowingOccurs before the Confirm Delete dialog window is invoked.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChangedOccurs when the value of the Dock property changes. Inherited from Control.
DoubleClickOccurs when the control is double-clicked. Inherited from Control.
DragDropOccurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnterOccurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeaveOccurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOverOccurs when an object is dragged over the control’s bounds. Inherited from Control.
EditAppointmentDependencyFormShowingOccurs before the Appointment Dependency dialog window is invoked.
EditAppointmentFormShowingOccurs before the Edit Appointment dialog window is invoked.
EditRecurrentAppointmentFormShowingOccurs before the Open Recurring Item dialog window is invoked.
EnabledChangedOccurs when the Enabled property value has changed. Inherited from Control.
EnterOccurs when the control is entered. Inherited from Control.
FontChangedOccurs when the Font property value changes. Inherited from Control.
ForeColorChangedOccurs when the ForeColor property value changes. Inherited from Control.
GiveFeedbackOccurs during a drag operation. Inherited from Control.
GotFocusOccurs when the control receives focus. Inherited from Control.
GotoDateFormShowingOccurs before the Go To Date dialog window is invoked.
GroupTypeChangedOccurs after the SchedulerControl.GroupType property of the Scheduler control has been changed.
HandleCreatedOccurs when a handle is created for the control. Inherited from Control.
HandleDestroyedOccurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequestedOccurs when the user requests help for a control. Inherited from Control.
HyperlinkClick
ImeModeChangedOccurs when the ImeMode property has changed. Inherited from Control.
InitAppointmentDisplayTextEnables custom text and a description to be displayed within appointments.
InitAppointmentImagesEnables custom images to be displayed within appointments.
InitNewAppointmentOccurs before a new appointment is created in the Scheduler.
InplaceEditorShowingOccurs every time an in-place editor is invoked in place of the edited appointment. This event is not cancelable. If you want to disable in-place editors for specific appointments, handle the AllowInplaceEditor event (this event fires when the AllowInplaceEditor property equals “Custom”).
InvalidatedOccurs when a control’s display requires redrawing. Inherited from Control.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from Control.
KeyPressOccurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUpOccurs when a key is released while the control has focus. Inherited from Control.
LayoutOccurs when a control should reposition its child controls. Inherited from Control.
LayoutUpgradeOccurs when a layout is restored from a data store (a stream, xml file or system registry), and its version differs from the version of the current layout.
LayoutViewInfoCustomizingUse this event to customize the appearance of certain visual elements before they are painted.
LeaveOccurs when the input focus leaves the control. Inherited from Control.
LocationChangedOccurs when the Location property value has changed. Inherited from Control.
LostFocusOccurs when the control loses focus. Inherited from Control.
MarginChangedOccurs when the control’s margin changes. Inherited from Control.
MoreButtonClickedOccurs when the More Button is clicked.
MouseCaptureChangedOccurs when the control loses mouse capture. Inherited from Control.
MouseClickOccurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClickOccurs when the control is double clicked by the mouse. Inherited from Control.
MouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnterOccurs when the mouse pointer enters the control. Inherited from Control.
MouseHoverOccurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeaveOccurs when the mouse pointer leaves the control. Inherited from Control.
MouseMoveOccurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUpOccurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheelOccurs when the mouse wheel moves while the control has focus. Inherited from Control.
MoveOccurs when the control is moved. Inherited from Control.
NavigationButtonClick
PaddingChangedOccurs when the control’s padding changes. Inherited from Control.
PaintOccurs when the control is redrawn. Inherited from Control.
PaintExA DirectX-compatible method that replaces the standard Control.Paint method.
ParentChangedOccurs when the Parent property value changes. Inherited from Control.
PopupMenuShowingOccurs before a popup menu is displayed for a SchedulerControl. Allows you to customize the built-in menu or display a custom menu.
PrepareContextMenuObsolete. This member is obsolete. Handle the SchedulerControl.PopupMenuShowing event instead.
PrepareDragDataFires when a user drags data items from another control or application, and allows you to create appointments based on the dragged data.
PreparePopupMenuObsolete. This member is obsolete. Handle the SchedulerControl.PopupMenuShowing event instead.
PreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
QueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryAppointmentTemplateAllows you to assign unique HTML templates to individual Appointments.
QueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
QueryResourceColorSchemaEnables visible resources to be painted according to certain conditions.
QueryResourceHeaderTemplateAllows you to assign individual templates to different resource headers.
QueryWorkTimeOccurs when the scheduler’s view calculates the work time interval for the specific resource.
RangeControlAutoAdjustingOccurs before the RangeControl has been automatically adjusted when the scheduler active view or start date is changed.
RegionChangedOccurs when the value of the Region property changes. Inherited from Control.
RemindersFormActionOccurs when a user clicks the Dismiss, Dismiss All, Snooze buttons on the Reminders Form , or closes the form.
RemindersFormDefaultActionOccurs when an end-user doesn’t click the Dismiss or Snooze button on the Reminders Form , but simply closes it. The SchedulerOptionsBehaviorBase.RemindersFormDefaultAction property should be set to Custom.
RemindersFormShowingOccurs before the Reminders form is displayed.
ResizeOccurs when the control is resized. Inherited from Control.
ResourceHeaderHtmlElementMouseClick
RightToLeftChangedOccurs when the RightToLeft property value changes. Inherited from Control.
SelectionChangedFires after the selection has been changed.
SizeChangedOccurs when the Size property value changes. Inherited from Control.
StorageChangedFires after the SchedulerControl.DataStorage property value has been changed.
StyleChangedOccurs when the control style changes. Inherited from Control.
SystemColorsChangedOccurs when the system colors change. Inherited from Control.
TabIndexChangedOccurs when the TabIndex property value changes. Inherited from Control.
TabStopChangedOccurs when the TabStop property value changes. Inherited from Control.
TextChangedOccurs when the Text property value changes. Inherited from Control.
TimeRegionCustomizeWhen you disable the TimeRegion.Editable setting, users are unable to create or modify existing appointments so that they belong to this region. Handle this event and override its e.Editable parameter to remove restrictions for specific appointments and/or users.
ValidatedOccurs when the control is finished validating. Inherited from Control.
ValidatingOccurs when the control is validating. Inherited from Control.
VisibleChangedOccurs when the Visible property value changes. Inherited from Control.
VisibleIntervalChangedFires when the time interval displayed by the control’s scheduling area is changed.
VisibleResourcesChangedOccurs when resources displayed in the scheduler view are changed, or the number of visible resources is changed, or the scheduler switches views.

See Also

SchedulerControl Class

SchedulerControl Members

DevExpress.XtraScheduler Namespace