SchedulerStorageBase Members

Serves as a base class for a class that represents a storage which holds data for the XtraScheduler control.

Properties

Name Description
AppointmentCacheEnabled Obsolete. This member supports the internal infrastructure and is not intended to be used directly from your code.
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.
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.
EnableSmartFetch Gets or sets whether certain internal criteria for raising the SchedulerStorageBase.FetchAppointments event are applied to reduce the number of data requests.
EnableTimeZones Gets or sets whether the scheduler saves the appointment time zone information.
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.
IsUpdateLocked Gets whether the storage has been locked for updating.
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.
RemindersCheckInterval Gets or sets the time interval a reminder's alert time should be checked (in milliseconds).
RemindersEnabled Gets whether the reminders are enabled.
ResourceSharing Gets a value indicating whether an appointment could be shared between multiple resources.
Site Gets or sets the ISite of the Component. Inherited from Component.
SupportsRecurrence Gets whether the scheduler storage can contain information on appointment recurrence.
SupportsReminders Gets whether the appointment reminder data mapping is specified.
TimeZoneId Gets or sets the time zone in which the SchedulerStorage operates.
UnboundMode Gets a value indicating if the scheduler storage is bound to data.

Methods

Name Description
BeginInit() Starts the scheduler storage initialization. Initialization occurs at runtime.
BeginUpdate() Locks the object until the EndUpdate or CancelUpdate method is called.
CalcTotalAppointmentCountForExchange() Gets the number of appointments in the storage which can be exported.
CancelUpdate() Unlocks the SchedulerStorageBase object after it has been locked by the BeginUpdate method, without causing an immediate visual update.
CreateAppointment(AppointmentType) Creates an appointment of the specified type.
CreateAppointment(AppointmentType, DateTime, DateTime) Creates an appointment of the specified type with the specified start and end time.
CreateAppointment(AppointmentType, DateTime, DateTime, String) Creates an appointment of the specified type with the specified start time, end time and the subject.
CreateAppointment(AppointmentType, DateTime, TimeSpan) Creates an appointment of the specified type with the specified start time and duration.
CreateAppointment(AppointmentType, DateTime, TimeSpan, String) Creates an appointment of the specified type with the specified start time, duration and subject.
CreateAppointmentDependency(Object, Object) Creates a dependency between two appointments specified by their Ids.
CreateAppointmentDependency(Object, Object, AppointmentDependencyType) Creates a dependency of the specified type between two appointments specified by their IDs.
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.
CreateOutlookExportSynchronizer() Creates an object which allows you to control how MS Outlook's Calendar is synchronized with data in the storage.
CreateOutlookImporter() Creates an object which allows you to control how data is imported from MS Outlook's Calendar.
CreateOutlookImportSynchronizer() Creates an object which allows you to control how data in the storage is synchronized with data in MS Outlook's Calendar.
CreateReminder(Appointment) Creates a reminder for the specified appointment.
CreateResource(Object) Creates a new resource with the specified ID.
CreateResource(Object, String) Creates a new resource with the specified ID and a caption.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndInit() Ends the scheduler storage initialization.
EndUpdate() Unlocks the SchedulerStorageBase object after a call to the BeginUpdate method and causes an immediate visual update.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
ExportToICalendar(Stream) Exports appointments in the scheduler to a stream in the iCalendar format.
ExportToICalendar(String) Saves all appointments to file in iCalendar format.
ExportToOutlook() Exports the data in the storage to the MS Outlook calendar.
ExportToVCalendar(Stream) Exports the data in the scheduler to a stream in the vCalendar format.
ExportToVCalendar(String) Exports the data in the scheduler to a file in the vCalendar format.
GetAppointments(TimeInterval, Boolean) Retrieves the collection of appointments that fall within the specified time interval.
GetAppointments(TimeIntervalCollection, Boolean) Retrieves the collection of appointments that fall within the specified time interval.
GetAppointments(DateTime, DateTime, Boolean) Retrieves the collection of appointments that fall within the specified time interval.
GetHashCode() Serves as the default hash function. Inherited from Object.
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.
GetObjectRow(IPersistentObject) Returns the data row object that contains information about the specified persistent object.
GetObjectValue(IPersistentObject, String) Gets the value of the specified field in the data row that supplies data for the persistent object.
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.
ImportFromICalendar(String) Imports appointments from the file in iCalendar format.
ImportFromOutlook() Imports data from MS Outlook's Calendar to the scheduler's storage.
ImportFromVCalendar(Stream) Imports the scheduler's data from a stream whose data is in the vCalendar format.
ImportFromVCalendar(String) Imports data into the scheduler from a file in the vCalendar format.
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.
RaiseFilterDependency(AppointmentDependency) Raises the SchedulerStorageBase.FilterDependency event.
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.
SetAppointmentDependencyFactory(IAppointmentDependencyFactory) Specifies the appointment dependency factory for use by the storage.
SetAppointmentFactory(IAppointmentFactory) Assigns the specified appointment factory to the SchedulerStorageBase.
SetObjectValue(IPersistentObject, String, Object) Assigns the specified value to a field in the data row that contains information about the specified persistent object.
SetResourceFactory(IResourceFactory) Assigns the specified resource factory to the SchedulerStorageBase.
SynchronizeOutlookWithStorage(String) Updates MS Outlook's Calendar entries with appointments from the Scheduler storage.
SynchronizeStorageWithOutlook(String) Updates Scheduler appointments with MS Outlook's Calendar entries.
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.

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 Fires when the properties of the appointment dependency have been changed.
AppointmentDependenciesDeleted Fires after deletion of one or several appointment dependencies.
AppointmentDependenciesInserted Fires after one or several appointment dependencies have been added to the collection.
AppointmentDependencyChanging Fires when the appointment dependency type is changing.
AppointmentDependencyCollectionAutoReloading Occurs when the data source which contains appointment dependency records is modified and dependencies are set to be automatically reloaded.
AppointmentDependencyCollectionCleared Fires after the appointment dependency collection has been cleared.
AppointmentDependencyCollectionLoaded Fires after appointment dependencies have been loaded into the storage.
AppointmentDependencyDeleting Allows you to cancel the deletion of an appointment dependency.
AppointmentDependencyInserting Allows you to cancel the insertion of an appointment dependency.
AppointmentInserting Allows you to cancel the insertion of an appointment.
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 SchedulerStorageBase starts retrieving the appointments for the specified time interval.
FilterAppointment Hides specific appointments in the Scheduler control.
FilterDependency Hides certain appointment dependencies in the Gantt view.
FilterReminderAlert Enables you to fire alerts only for specific reminders.
FilterResource Hides specific resources in the Scheduler control.
ReminderAlert Occurs when a reminder alert is invoked.
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 resource collection has been cleared.
ResourceCollectionLoaded Fires after resources have been loaded into the Scheduler storage.
ResourceDeleting Allows the deletion of a resource to be cancelled.
ResourceInserting Allows you to cancel the addition of a resource.
ResourcesChanged Occurs when a scheduler's resource in a collection is changed.
ResourcesDeleted Occurs after a scheduler's resource(s) is deleted.
ResourcesInserted Occurs when new resources are inserted into the scheduler storage.
See Also