Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Pivot Grid
  [Expand]Tree List
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Collapse]Scheduler
   [Expand]Product Information
   [Expand]Getting Started
   [Collapse]Fundamentals
    [Collapse]Scheduler Elements
      SchedulerControl Control
      SchedulerStorage Component
    [Expand]Scheduler Structure
    [Expand]Appointments
     Resources for Appointments
    [Expand]Views
    [Expand]Data Binding
    [Expand]Mappings
    [Expand]Supported Formats
    [Expand]Services
    [Expand]Time Zones
     Printing
    [Expand]Scheduler Reporting
   [Expand]Visual Elements
   [Expand]Design-Time Features
   [Expand]Examples
   [Expand]End-User Capabilities
   [Expand]Member Tables
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

SchedulerStorage Component

This document introduces the Scheduler Storage, and describes its main features. The table below lists the component's main members, and helps you to find the necessary APIs.

Expanded What Is the Scheduler Storage?

The Scheduler Storage is a specific component in the XtraScheduler suite intended to implement all data operations for the Scheduler Control. It's represented by the SchedulerStorage class instance. Although this component is not visible to end-users, it does all the background work required by the scheduling application. The Scheduler Storage contains two specific data storages for appointments and resources, which are used to bind a scheduler to the appointments and resources data source. Also, the Scheduler Storage provides the appointment export/import capability with MS Outlook and other scheduling applications.

For more information on the basic elements of the Scheduler, review the Scheduler Structure section.

Expanded How Does the Scheduler Storage Look?

Since the Scheduler Storage is a non-visual component, it looks like the components in the Component Tray in the Visual Studio IDE.

Expanded What Are the Main Members of the Scheduler Storage?

The following table lists the main properties and methods of the SchedulerStorage class which implement its basic functionality.

Member Name

Description

Data Binding
SchedulerStorage.Appointments property Gets a storage object that contains appointment related information, which can be used, for example, to specify the datasource that contains appointments, to access an object that allows the persistent properties of appointments to be mapped to the corresponding data fields, a collection of appointments, appointment labels and statuses accessed.
SchedulerStorage.Resources property Gets a storage object that contains resources related information, which can be used, for instance, to specify the datasource that contains resources, to access an object that allows the persistent properties of resources to be mapped to the corresponding data fields, and access a collection of resources.
SchedulerStorageBase.UnboundMode property Gets a value indicating if the Scheduler Storage is bound to data or not.
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.
ResourceStorage.Mappings Gets an object that allows the persistent properties of the resources 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.
AppointmentStorage.Labels property Provides access to the collection of appointment labels.
AppointmentStorage.Statuses property Provides access to the collection of appointment statuses.
Data Exchanging
SchedulerStorageBase.ExportToICalendar method Exports the storage's data to iCalendar format.
SchedulerStorageBase.ImportFromICalendar method Imports the storage's data from iCalendar format.
SchedulerStorageBase.ExportToOutlook method Exports the storage's data to MS Outlook's Calendar.
SchedulerStorageBase.ImportFromOutlook method Imports data from MS Outlook's Calendar to the scheduler's storage.
SchedulerStorageBase.ExportToVCalendar method Exports the storage's data to VCalendar file format (ver. 1.0).
SchedulerStorageBase.ImportFromVCalendar method Imports data from VCalendar file format (ver. 1.0) to the scheduler's storage.
SchedulerStorageBase.SynchronizeStorageWithOutlook method Synchronizes the contents of the storage with data from MS Outlook's Calendar.
SchedulerStorageBase.SynchronizeOutlookWithStorage method Synchronizes the contents of MS Outlook's Calendar with data from the storage.
Data Processing
SchedulerStorageBase.GetObjectRow method Returns the data row object that contains information about the persistent object specified.
SchedulerStorageBase.GetObjectValue method Returns the value of the specified field in the data row that contains information about the persistent object specified.
SchedulerStorageBase.SetObjectValue method Assigns the specified value to a field in the data row that contains information about the persistent object specified.
AppointmentStorageBase.Filter property Gets or sets a criteria string used to filter appointments.
ResourceStorageBase.Filter property Gets or sets a criteria string used to filter resources.
SchedulerStorageBase.FilterAppointment event Handle this event to hide specific appointments in the Scheduler control.
SchedulerStorageBase.FilterResource event Handle this event to hide specific resources in the Scheduler control.
Notification Events
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.
SchedulerStorageBase.AppointmentDeleting Fires when the appointment is about to be deleted.
SchedulerStorageBase.AppointmentsDeleted Occurs when appointments have been deleted.
SchedulerStorageBase.ResourceInserting Allows you to cancel the addition of a resource.
SchedulerStorageBase.ResourcesInserted Occurs when new resources are inserted into the scheduler storage.
SchedulerStorageBase.ResourceChanging Fires when a resource's property is about to be changed.
SchedulerStorageBase.ResourcesChanged Occurs when a scheduler's resource in a collection is changed.
SchedulerStorageBase.ResourceDeleting Allows the deletion of a resource to be cancelled.
SchedulerStorageBase.ResourcesDeleted Occurs after a scheduler's resource(s) is deleted.
Miscellaneous
SchedulerStorageBase.EnableReminders property Gets or sets whether reminders are enabled.
SchedulerStorageBase.RemindersEnabled property Gets whether the reminders are enabled.
SchedulerStorageBase.SupportsRecurrence property Gets whether the information on appointment recurrence is obtained from a data source.
SchedulerStorageBase.SupportsReminders property Gets whether the information on appointment reminders is obtained from a data source.

Expanded See Also

How would you rate this topic?​​​​​​​