ASPxSchedulerStorage Members
Represents a storage which holds data for the ASPxScheduler control.Constructors
| Name | Description |
|---|---|
| ASPxSchedulerStorage() | Initializes a new instance of the ASPxSchedulerStorage class with the default settings. |
| ASPxSchedulerStorage(ASPxScheduler) | Initializes a new instance of the ASPxSchedulerStorage class for the specified Scheduler control. |
| ASPxSchedulerStorage(ASPxSchedulerDataWebControlBase) | Initializes a new instance of the ASPxSchedulerStorage class. |
Properties
| Name | Description |
|---|---|
| AppointmentCacheEnabled | Obsolete. This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from SchedulerStorageBase. |
| Appointments | Gets a storage object that contains appointment related information. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| DateTimeSavingMode | Gets or sets in what time zone to store the appointment dates. Inherited from SchedulerStorageBase. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| EnableReminders | Gets or sets whether the Reminder availability for appointments is enabled. Inherited from SchedulerStorageBase. |
| EnableSmartFetch | Gets or sets whether certain internal criteria for raising the SchedulerStorageBase.FetchAppointments event are applied to reduce the number of data requests. Inherited from SchedulerStorageBase. |
| EnableTimeZones | Gets or sets whether the scheduler saves the appointment time zone information. Inherited from SchedulerStorageBase. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| FetchOnVisibleResourcesChanged | Gets or sets whether to raise the FetchAppointments event when the EnableSmartFetch property is switched on and visible resources are changed. Inherited from SchedulerStorageBase. |
| IsUpdateLocked | Gets whether the storage has been locked for updating. Inherited from SchedulerStorageBase. |
| ReminderDstBehaviorType | Gets or sets the reminder’s behavior if the reminder alert falls within the interval that actually doesn’t exist because of the Daylight Saving Time shift. Inherited from SchedulerStorageBase. |
| RemindersCheckInterval | Gets or sets the time interval a reminder’s alert time should be checked (in milliseconds). Inherited from SchedulerStorageBase. |
| RemindersEnabled | Gets whether the reminders are enabled. Inherited from SchedulerStorageBase. |
| Resources | Gets the object which manages resources for appointments. |
| ResourceSharing | Gets a value indicating whether an appointment could be shared between multiple resources. Inherited from SchedulerStorageBase. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| SupportsRecurrence | Gets whether the scheduler storage can contain information on appointment recurrence. Inherited from SchedulerStorageBase. |
| SupportsReminders | Gets whether the appointment reminder data mapping is specified. Inherited from SchedulerStorageBase. |
| TimeZoneId | Gets or sets the time zone in which the SchedulerStorage operates. Inherited from SchedulerStorageBase. |
| UnboundMode | Gets a value indicating if the scheduler storage is bound to data. Inherited from SchedulerStorageBase. |
Methods
| Name | Description |
|---|---|
| BeginInit() | Starts the scheduler storage initialization. Initialization occurs at runtime. Inherited from SchedulerStorageBase. |
| BeginUpdate() | Locks the object until the EndUpdate or CancelUpdate method is called. Inherited from SchedulerStorageBase. |
| CalcTotalAppointmentCountForExchange() | Gets the number of appointments in the storage which can be exported. Inherited from SchedulerStorageBase. |
| CancelUpdate() | Unlocks the SchedulerStorageBase object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from SchedulerStorageBase. |
| CreateAppointment(AppointmentType, DateTime, DateTime, String) | Creates an appointment of the specified type with the specified start time, end time and the subject. Inherited from SchedulerStorageBase. |
| CreateAppointment(AppointmentType, DateTime, DateTime) | Creates an appointment of the specified type with the specified start and end time. Inherited from SchedulerStorageBase. |
| CreateAppointment(AppointmentType, DateTime, TimeSpan, String) | Creates an appointment of the specified type with the specified start time, duration and subject. Inherited from SchedulerStorageBase. |
| CreateAppointment(AppointmentType, DateTime, TimeSpan) | Creates an appointment of the specified type with the specified start time and duration. Inherited from SchedulerStorageBase. |
| CreateAppointment(AppointmentType) | Creates an appointment of the specified type. Inherited from SchedulerStorageBase. |
| CreateAppointmentDependency(Object, Object, AppointmentDependencyType) | Creates a dependency of the specified type between two appointments specified by their IDs. Inherited from SchedulerStorageBase. |
| CreateAppointmentDependency(Object, Object) | Creates a dependency between two appointments specified by their Ids. Inherited from SchedulerStorageBase. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| CreateOutlookExporter() | Creates an object which provides the capability to control how data is exported to MS Outlook’s Calendar. Inherited from SchedulerStorageBase. |
| CreateOutlookExportSynchronizer() | Creates an object which allows you to control how MS Outlook’s Calendar is synchronized with data in the storage. Inherited from SchedulerStorageBase. |
| CreateOutlookImporter() | Creates an object which allows you to control how data is imported from MS Outlook’s Calendar. Inherited from SchedulerStorageBase. |
| CreateOutlookImportSynchronizer() | Creates an object which allows you to control how data in the storage is synchronized with data in MS Outlook’s Calendar. Inherited from SchedulerStorageBase. |
| CreateReminder(Appointment) | Creates a reminder for the specified appointment. Inherited from SchedulerStorageBase. |
| CreateResource(Object, String) | Creates a new resource with the specified ID and a caption. Inherited from SchedulerStorageBase. |
| CreateResource(Object) | Creates a new resource with the specified ID. Inherited from SchedulerStorageBase. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndInit() | Ends the scheduler storage initialization. Inherited from SchedulerStorageBase. |
| EndUpdate() | Unlocks the ASPxSchedulerStorage object after a call to the BeginUpdate method and causes an immediate visual update. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| ExportToICalendar(Stream) | Exports appointments in the scheduler to a stream in the iCalendar format. Inherited from SchedulerStorageBase. |
| ExportToICalendar(String) | Saves all appointments to file in iCalendar format. Inherited from SchedulerStorageBase. |
| ExportToOutlook() | Exports the data in the storage to the MS Outlook calendar. Inherited from SchedulerStorageBase. |
| ExportToVCalendar(Stream) | Exports the data in the scheduler to a stream in the vCalendar format. Inherited from SchedulerStorageBase. |
| ExportToVCalendar(String) | Exports the data in the scheduler to a file in the vCalendar format. Inherited from SchedulerStorageBase. |
| GetAppointmentId(Appointment) | Gets the identifier of the specified appointment. |
| GetAppointments(TimeInterval, Boolean) | Retrieves the collection of appointments that fall within the specified time interval. Inherited from SchedulerStorageBase. |
| GetAppointments(TimeIntervalCollection, Boolean) | Retrieves the collection of appointments that fall within the specified time interval. Inherited from SchedulerStorageBase. |
| GetAppointments(DateTime, DateTime, Boolean) | Retrieves the collection of appointments that fall within the specified time interval. Inherited from SchedulerStorageBase. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLabelColor(Object) | Obtains the color of the label by its ID. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetNonFilteredAppointments(TimeInterval, Object) | Retrieves the collection of appointments that fall within the specified time interval bypassing filter settings. For internal use. Inherited from SchedulerStorageBase. |
| GetObjectRow(IPersistentObject) | Returns the data row object that contains information about the specified persistent object. Inherited from SchedulerStorageBase. |
| GetObjectValue(IPersistentObject, String) | Gets the value of the specified field in the data row that supplies data for the persistent object. Inherited from SchedulerStorageBase. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| ImportFromICalendar(Stream) | Imports appointments from the file in iCalendar format. Inherited from SchedulerStorageBase. |
| ImportFromICalendar(String) | Imports appointments from the file in iCalendar format. Inherited from SchedulerStorageBase. |
| ImportFromOutlook() | Imports data from MS Outlook’s Calendar to the scheduler’s storage. Inherited from SchedulerStorageBase. |
| ImportFromVCalendar(Stream) | Imports the scheduler’s data from a stream whose data is in the vCalendar format. Inherited from SchedulerStorageBase. |
| ImportFromVCalendar(String) | Imports data into the scheduler from a file in the vCalendar format. Inherited from SchedulerStorageBase. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| OnAppointmentsAutoReloading(Object, CancelListChangedEventArgs) | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from SchedulerStorageBase. |
| RaiseFilterDependency(AppointmentDependency) | Raises the SchedulerStorageBase.FilterDependency event. Inherited from SchedulerStorageBase. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RefreshData() | Updates XtraScheduler to reflect any changes made in the data sources which store the appointments and appointment resources. Inherited from SchedulerStorageBase. |
| SetAppointmentDependencyFactory(IAppointmentDependencyFactory) | Specifies the appointment dependency factory for use by the storage. Inherited from SchedulerStorageBase. |
| SetAppointmentFactory(IAppointmentFactory) | Assigns the specified appointment factory to the SchedulerStorageBase. Inherited from SchedulerStorageBase. |
| SetAppointmentId(Appointment, Object) | Sets the identifier of the specified appointment to a specified value. |
| SetObjectValue(IPersistentObject, String, Object) | Assigns the specified value to a field in the data row that contains information about the specified persistent object. Inherited from SchedulerStorageBase. |
| SetResourceFactory(IResourceFactory) | Assigns the specified resource factory to the SchedulerStorageBase. Inherited from SchedulerStorageBase. |
| SynchronizeOutlookWithStorage(String) | Updates MS Outlook’s Calendar entries with appointments from the Scheduler storage. Inherited from SchedulerStorageBase. |
| SynchronizeStorageWithOutlook(String) | Updates Scheduler appointments with MS Outlook’s Calendar entries. Inherited from SchedulerStorageBase. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
| TriggerAlerts() | Invokes reminder alerts for the current time. Inherited from SchedulerStorageBase. |
Events
| Name | Description |
|---|---|
| AppointmentChanging | Fires when an appointment’s property is about to change. |
| AppointmentCollectionAutoReloading | Occurs when the data source which contains appointment records is modified and appointments are set to be automatically reloaded. |
| AppointmentCollectionCleared | Fires after the appointment collection has been cleared. |
| AppointmentCollectionLoaded | Fires after appointments have been loaded into the AppointmentBaseCollection collection. |
| AppointmentDeleting | Allows you to cancel the deletion of an appointment. |
| AppointmentDependenciesChanged | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependenciesDeleted | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependenciesInserted | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependencyChanging | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependencyCollectionAutoReloading | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependencyCollectionCleared | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependencyCollectionLoaded | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependencyDeleting | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentDependencyInserting | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| AppointmentInserting | Allows you to cancel the insertion of an appointment. |
| AppointmentRowDeleted | Fires after an appointment’s data row is deleted from the data source. |
| AppointmentRowDeleting | Fires before an appointment data row is deleted from the data source. |
| AppointmentRowInserted | Fires after a new record containing appointment information is inserted into the data source. |
| AppointmentRowInserting | Fires before appointment data is posted to the data source for insertion. |
| AppointmentRowUpdated | Fires after an appointment’s data record is updated. |
| AppointmentRowUpdating | Fires before the appointment data is posted to the data source to update the record. |
| AppointmentsChanged | Fires when the appointments’ properties have been changed. |
| AppointmentsDeleted | Fires after deletion of one or several appointments. |
| AppointmentsInserted | Fires after one or several appointments have been added to the collection. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| FetchAppointments | Occurs before the ASPxSchedulerStorage starts retrieving the appointments for the specified time interval. |
| FilterAppointment | Enables specific appointments to be hidden in the Scheduler control. |
| FilterDependency | This event is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools. |
| FilterReminderAlert | Enables you to fire alerts only for specific reminders. Inherited from SchedulerStorageBase. |
| FilterResource | Enables specific resources to be hidden in the Scheduler control. |
| ReminderAlert | Occurs when a reminder is triggered. |
| ResourceChanging | Fires when a resource’s property is about to be changed. |
| ResourceCollectionAutoReloading | Occurs when the data source which contains resources is modified, and the automatic reloading of resources is enabled. |
| ResourceCollectionCleared | Fires after the resources collection has been cleared. |
| ResourceCollectionLoaded | Fires after resources have been loaded into the ResourceBaseCollection collection. |
| ResourceDeleting | Allows the deletion of a resource to be cancelled. |
| ResourceInserting | Allows you to cancel the addition of a resource. |
| ResourcesChanged | Fires when the resources’ properties are changed. |
| ResourcesDeleted | Occurs when a scheduler’s resource is deleted from the collection. |
| ResourcesInserted | Occurs when new resources are inserted into the ResourceBaseCollection collection. |
See Also