Member Table: Appointments
- 5 minutes to read
Below is the list of the primary members which can be used to manage appointments in the XtraScheduler suite.
Public Properties
| Name | Description |
|---|---|
| SchedulerStorage.Appointments | Gets a storage object that contains appointment related information. Using the members of the AppointmentStorage object, you can specify the data source that contains appointments, access an object that allows the persistent properties of appointments to be mapped to the corresponding data fields, access a collection of appointments, an individual appointment, collections of appointment labels and statuses. |
| AppointmentStorageBase.Items | Gets a collection of appointments within the storage. |
| SchedulerControl.SelectedAppointments | Gets a collection of appointments selected in the Scheduler. |
| AppointmentStorageBase.Mappings | Gets an object that allows the persistent properties of the appointments maintained by the current storage to be bound to appropriate fields in the data source. |
| PersistentObject.CustomFields | Gets a collection of custom fields for an appointment. Custom fields can be used as tags, extra attributes, or additional info storages. |
| Appointment.LabelId | Bindable. Gets or sets a label for an appointment. The label identifier is the member ID in the AppointmentStorage.Labels collection. See Appointment Labels and Statuses for more information. |
| Appointment.StatusId | Bindable. Gets or sets a status attribute for an appointment. The label identifier is the member ID in the AppointmentStorage.Labels collection. See Appointment Labels and Statuses for more information. |
| Appointment.Start | Bindable. Gets or sets the start date and time of the appointment. |
| Appointment.End | Bindable. Gets or sets the end date and time of the appointment. |
| Appointment.Duration | Gets or sets the duration of the appointment. |
| Appointment.AllDay | Bindable. Gets or sets a value indicating if the current appointment is an all-day appointment. |
| Appointment.Subject | Bindable. Gets or sets the appointment’s subject text. |
| Appointment.Description | Bindable. Gets or sets the text for the appointment’s description. |
| Appointment.Location | Bindable. Gets or sets the text that specifies where the appointment is going to take place. |
| Appointment.ResourceId and Appointment.ResourceIds | Bindable. Both properties represent resources associated with the appointment. Both are mapped to the same data field, although if the AppointmentStorageBase.ResourceSharing is set to true, the data field contains an XML list of resources. |
| Appointment.IsRecurring | Indicates whether the appointment is a member of a recurrence chain. |
| Appointment.Type | Bindable. Gets the type of the appointment, i.e. its role in a recurring series. |
| Appointment.RecurrencePattern | Provides access to an appointment which specifies the common properties of recurrence chain members. Change the pattern to modify appointments in a recurrence chain. |
| Appointment.RecurrenceInfo | Bindable. Provides access to recurrence information. |
| Appointment.Reminder and Appointment.Reminders | Bindable. Provides access to appointment reminders. |
| SchedulerOptionsCustomization.AllowAppointmentConflicts, SchedulerOptionsCustomization.AllowAppointmentCopy, SchedulerOptionsCustomization.AllowAppointmentCreate, SchedulerOptionsCustomization.AllowAppointmentDelete, SchedulerOptionsCustomization.AllowAppointmentDrag, SchedulerOptionsCustomization.AllowAppointmentDragBetweenResources, SchedulerOptionsCustomization.AllowAppointmentEdit, SchedulerOptionsCustomization.AllowAppointmentMultiSelect | Specify appointment modification restrictions. |
| AppointmentStorageBase.Filter | Specify a filter to apply when displaying appointments. |
Public Methods
| Name | Description |
|---|---|
| SchedulerControl.CreateNewAppointment | Creates a new appointment, displays it in the Edit Appointment dialog, and then adds it to the SchedulerStorage.Appointments collection of the control’s storage. |
| SchedulerControl.CreateNewAllDayEvent | Creates a new All-Day appointment, displays it in the Edit Appointment dialog, and then adds it to the SchedulerStorage.Appointments collection of the control’s storage. |
| SchedulerControl.CreateNewRecurringAppointment | Creates a new recurring appointment, shows it in the Edit Appointment dialog, and then adds it to the SchedulerStorage.Appointments collection of the control’s storage. |
| SchedulerControl.CreateNewRecurringEvent | Creates a new recurring All-Day appointment, displays it in the Edit Appointment dialog, and then adds it to the SchedulerStorage.Appointments collection of the control’s storage. |
| SchedulerControl.CreateAppointment | Creates a new appointment with custom fields. |
| SchedulerViewBase.GetAppointments and SchedulerStorageBase.GetAppointments | Retrieves the collection of appointments which are displayed in the current view or fall within the specified time interval. |
| SchedulerViewBase.SelectAppointment | Selects the specified appointment. |
| Appointment Selection Service | Provides a set of methods for appointment selection. |
| SchedulerControl.DeleteAppointment | Deletes the specified appointment from the scheduler’s storage. |
| SchedulerControl.DeleteSelectedAppointments | Deletes the selected appointments. |
Public Events
| Name | Description |
|---|---|
| SchedulerControl.InitNewAppointment | Occurs when a new appointment is created. |
| SchedulerStorageBase.AppointmentInserting | Fires when a new appointment is about to be added to the persistent storage. |
| SchedulerStorageBase.AppointmentsInserted | Occurs after a new appointment is added to the persistent storage. |
| SchedulerStorageBase.AppointmentChanging | Fires when an appointment is about to be modified. |
| SchedulerStorageBase.AppointmentsChanged | Occurs when appointments have been changed. |
| SchedulerControl.AppointmentResizing | Occurs when the user starts modifying the appointment’s interval by dragging its border with the mouse. |
| SchedulerControl.AppointmentResized | Occurs after the user modifies the appointment’s interval by dragging its border with the mouse. |
| SchedulerControl.AppointmentDrag | Occurs when appointment is dragged in the Scheduler control. |
| SchedulerControl.AppointmentDrop | Fires when you drop the appointment dragged with the mouse. |
| SchedulerControl.AdditionalAppointmentsDrag | Occurs for the appointments added to the AppointmentDragEventArgs.AdditionalAppointments collection when they are dragged with the primary appointment. |
| SchedulerStorageBase.AppointmentDeleting | Fires when the appointment is about to be deleted. |
| SchedulerStorageBase.AppointmentsDeleted | Occurs when appointments have been deleted. |
| SchedulerControl.AllowAppointmentConflicts, SchedulerControl.AllowAppointmentCopy, SchedulerControl.AllowAppointmentCreate, SchedulerControl.AllowAppointmentDelete, SchedulerControl.AllowAppointmentDrag, SchedulerControl.AllowAppointmentDragBetweenResources, SchedulerControl.AllowAppointmentEdit, SchedulerControl.AllowAppointmentResize | Occurs when a corresponding action is performed and a property of the same name is set to Custom. |
| SchedulerStorageBase.FilterAppointment | Use this event to selectively display appointments according to specific criteria. |
| SchedulerControl.InitAppointmentDisplayText | Enables you to specify the text to display in the appointment rectangle. |
| SchedulerControl.InitAppointmentImages | Enables you to specify the pictures to display in the appointment rectangle. |
| SchedulerControl.CustomDrawAppointment | Enables you to manually draw the appointment rectangle. |
| SchedulerControl.CustomDrawAppointmentBackground | Enables you to manually draw the background of the appointment rectangle. |
| SchedulerControl.AppointmentViewInfoCustomizing | Enables you to modifying the style elements of the appointment when it is painted. |