SchedulerControl Control
- 4 minutes to read
This document introduces the Scheduler Control. The table below lists the control’s main members, exposes its main functionality and lets you identify the necessary APIs.
What Is the Scheduler Control?
The Scheduler Control is the main control of the XtraScheduler suite. It’s represented by the SchedulerControl class instance. This class is a visual control which is used to implement interactions between end-users and the scheduling application. The main purpose of this control is to show the schedule data (represented via appointments) on a form using one of the possible data views. Also, the Scheduler Control enables the end-users to create, edit and delete appointments, and perform other actions to schedule their timetables.
How Does the Scheduler Control Look?
Since the Scheduler Control shows the appointment data using different views, the appearance of the control usually depends upon the common appearance of the corresponding view. For instance, for the Day Week view the scheduler will show its data as follows.
Note also that the Scheduler Control implements the skin feature (which is used for most of .NET DevExpress components). To learn more on how to apply different skins to the Scheduler Control, read the Skins help document.
What Are the Main Members of the Scheduler Control?
The following table lists the main properties of the SchedulerControl class, which implement its basic functionality.
| Member Name | Description |
|---|---|
| Basic | |
| SchedulerControl.Start property | Gets or sets the first date of the time interval displayed by the scheduler view. |
| SchedulerControl.Storage property | Gets or sets the scheduler data storage, which is used to provide appointments and resources data for the scheduler. |
| SchedulerControl.ShowFeaturesIndicator property | Specifies if the Features Indicator should be drawn over the Scheduler Control at design time. The Features Indicator displays basic information about the Scheduler Control, which can be useful when adjusting its properties. |
| Data Representation | |
| SchedulerControl.Views property | Contains the settings of the Views that are used to represent information within the Scheduler Control. This provides a number of calendar Views that are used to represent information on appointments in a specific manner. |
| SchedulerControl.ActiveView property | Gets the View currently used by the Scheduler Control to show its data. |
| SchedulerControl.ActiveViewType property | Gets or sets the type of the View which is currently used by the Scheduler Control to show its data. |
| SchedulerControl.GroupType property | Specifies the type of grouping applied to the appointments managed by the Scheduler Control. |
| Appearance | |
| SchedulerControl.Appearance property | Gets the settings that control the appearance of the Scheduler Control’s elements (such as appointments and selections). |
| SchedulerControl.LookAndFeel property | Gets the settings that control the scheduler control’s look and feel, which enable you to specify how the visual elements of a scheduler control are painted. |
| SchedulerControl.PaintStyleName property | Gets or sets the paint scheme for the scheduler control. The paint scheme affects the overall appearance of the scheduler. |
| Options | |
| SchedulerControl.OptionsBehavior property | Provides access to the scheduler’s behavior options which describe the scheduler’s current functionality. |
| SchedulerControl.OptionsCustomization property | Provides access to the scheduler’s customization options which specify the functionality currently available to end-users. |
| SchedulerControl.OptionsPrint property | Provides access to the scheduler’s printing options, which specify the scheduler’s elements that are to be printed and the appearances used for this purpose. |
| SchedulerControl.OptionsView property | Provides access to the scheduler’s view options which specify the visibility and layout of visual elements. |
| Dialogs | |
| SchedulerControl.CreateAppointment method | Creates a new appointment with the specified settings and invokes the Edit Appointment dialog. |
| SchedulerControl.CreateNewAppointment method | Creates a new appointment and invokes the Edit Appointment dialog. |
| SchedulerControl.CreateNewAllDayEvent method | Creates a new Appointment.AllDay appointment and invokes the Edit Appointment dialog. |
| SchedulerControl.CreateNewRecurringAppointment method | Creates a new recurring appointment and invokes the Edit Appointment dialog. |
| SchedulerControl.CreateNewRecurringEvent method | Creates a new recurring all-day appointment and invokes the Edit Appointment dialog. |
| SchedulerControl.ShowEditAppointmentForm method | Invokes the Edit Appointment dialog for the specified appointment. |
| SchedulerControl.ShowGotoDateForm method | Invokes the dialog which allows the end-user to change the SchedulerControl.Start date of the Scheduler control. |
| SchedulerControl.ShowPrintOptionsForm method | Invokes the Page Setup dialog. |
| SchedulerControl.ShowPrintPreview method | Opens the Print Preview window for the Scheduler control. |
| Selection | |
| SchedulerControl.SelectedInterval property | Gets the time interval currently selected in the scheduler’s active view. |
| SchedulerControl.SelectedAppointments property | Provides access to the collection of selected appointments. |
| SchedulerControl.SelectedResource property | Gets the resource which contains the time interval currently selected in the scheduler’s active view. |
| SchedulerControl.DeleteSelectedAppointments method | Deletes the currently selected appointments. |
| Miscellaneous | |
| SchedulerControl.LimitInterval property | Gets or sets the time interval available to end-users. |
| SchedulerControl.Services property | Provides access to the object which contains implemented services and service-oriented methods. |
Note
We suggest that you encompass any methods that modify the number of items in collections, accessed via SchedulerControl properties, with the SchedulerControl.BeginUpdate - SchedulerControl.EndUpdate pair.