Back to Devexpress

ISchedulerStorageBase Members

corelibraries-devexpress-dot-xtrascheduler-dot-ischedulerstoragebase-dot-underscore-members.md

latest18.9 KB
Original Source

ISchedulerStorageBase Members

A base platform-independent interface that defines a storage which holds the Scheduler data.

Properties

NameDescription
AppointmentDependenciesGets a storage object which manages dependencies between appointments.
AppointmentsGets a storage object that contains appointments.
DateTimeSavingModeGets or sets in what time zone to store the appointment dates.
EnableRemindersGets or sets whether appointments can have associated reminders.
EnableSmartFetchGets or sets whether restrictive internal criteria for raising the SchedulerStorageBase.FetchAppointments event are applied to reduce the number of data requests.
EnableTimeZonesGets or sets whether the scheduler saves the appointment time zone information.
FetchOnVisibleResourcesChangedGets or sets whether to raise the FetchAppointments event when the EnableSmartFetch property is switched on and visible resources are changed.
ReminderDstBehaviorTypeGets 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.
RemindersCheckIntervalGets or sets the time interval a reminder’s alert time should be checked (in milliseconds).
RemindersEnabledGets whether the reminders are enabled.
ResourcesGets the object which manages resources for appointments.
ResourceSharingGets or sets a value indicating whether an appointment can be associated with multiple resources.
SupportsRecurrenceGets whether the scheduler storage can have recurrence information.
SupportsRemindersGets whether the scheduler storage can have reminder data.
TimeZoneIdGets or sets the time zone in which the storage operates.
UnboundModeGets a value indicating if the scheduler storage is bound to data.

Methods

NameDescription
CreateAppointment(AppointmentType, DateTime, DateTime, String)Creates an appointment of the specified type with the specified start time, end time and a subject.
CreateAppointment(AppointmentType, DateTime, DateTime)Creates an appointment of the specified type with the specified start and end time.
CreateAppointment(AppointmentType, DateTime, TimeSpan, String)Creates an appointment of the specified type with the specified start time, duration and a subject.
CreateAppointment(AppointmentType, DateTime, TimeSpan)Creates an appointment of the specified type with the specified start time and duration.
CreateAppointment(AppointmentType)Creates an appointment of the specified type.
CreateAppointmentDependency(Object, Object, AppointmentDependencyType)Creates a dependency of the specified type between two appointments specified by their IDs.
CreateAppointmentDependency(Object, Object)Creates a dependency between two appointments specified by their Ids.
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, String)Creates a new resource with the specified ID and a caption.
CreateResource(Object)Creates a resource for appointments.
Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable.
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)Retrieves the collection of appointments that fall within the specified time interval.
GetAppointments(TimeIntervalCollection)Retrieves the collection of appointments that fall within the specified time intervals.
GetAppointments(DateTime, DateTime)Retrieves the collection of appointments that fall within the specified time interval.
GetAppointmentsCore(TimeInterval, Object)This member supports the internal infrastructure and is not intended to be used directly from your code.
GetObjectRow(IPersistentObject)Returns the data row object which supplies data to 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.
GetResourceById(Object)Gets a resource contained in the storage by its ID value.
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.
RefreshData()Updates the Scheduler control to reflect any changes made in the persistent object data sources.
SetAppointmentDependencyFactory(IAppointmentDependencyFactory)Specifies the appointment dependency factory for use by the storage.
SetAppointmentFactory(IAppointmentFactory)Specifies the appointment factory for use by the storage.
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)Specifies the resource factory for use by the storage.
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.

Events

NameDescription
AppointmentChangingFires before an appointment’s property changes.
AppointmentCollectionAutoReloadingOccurs when the data source which contains appointment records is modified and appointments are set to be automatically reloaded.
AppointmentCollectionClearedFires after the appointment collection has been cleared.
AppointmentCollectionLoadedFires after appointments have been loaded into the storage.
AppointmentDeletingAllows you to cancel an appointment deletion.
AppointmentDependenciesChangedFires when the properties of the appointment dependency have been changed.
AppointmentDependenciesDeletedFires after deletion of one or several appointment dependencies.
AppointmentDependenciesInsertedFires after one or several appointment dependencies have been added to the storage.
AppointmentDependencyChangingFires when the appointment dependency type is changing.
AppointmentDependencyCollectionAutoReloadingOccurs when the data source which contains appointment dependency records is modified and dependencies are set to be automatically reloaded.
AppointmentDependencyCollectionClearedFires after the appointment dependency collection has been cleared.
AppointmentDependencyCollectionLoadedFires after appointment dependencies have been loaded into the storage.
AppointmentDependencyDeletingAllows you to cancel the deletion of an appointment dependency.
AppointmentDependencyInsertingAllows you to cancel the insertion of an appointment dependency to the storage.
AppointmentInsertingAllows you to cancel the insertion of an appointment.
AppointmentsChangedFires when the appointments’ properties have been changed.
AppointmentsDeletedFires after deletion of one or several appointments.
AppointmentsInsertedFires after one or several appointments have been added to the collection.
FetchAppointmentsOccurs before the ISchedulerStorageBase starts retrieving the appointments for the specified time interval.
FilterAppointmentHides specific appointments in the Scheduler control.
FilterDependencyHides specific appointment dependencies in the Gantt view.
FilterReminderAlertEnables you to fire alerts only for specific reminders.
FilterResourceHides specific resources in the Scheduler control.
ReminderAlertOccurs when a reminder alert is invoked.
ResourceChangingFires when a resource’s property is about to be changed.
ResourceCollectionAutoReloadingOccurs when the data source which contains resources is modified and the automatic reloading of resources is enabled.
ResourceCollectionClearedFires after the resource collection has been cleared.
ResourceCollectionLoadedFires after resources have been loaded into the storage.
ResourceDeletingAllows you to cancel a resource deletion operation.
ResourceInsertingAllows you to cancel the addition of a resource.
ResourcesChangedOccurs after modifying resource(s) in the storage.
ResourcesDeletedOccurs after a resource(s) is deleted.
ResourcesInsertedOccurs when new resources are inserted into the scheduler storage.

See Also

ISchedulerStorageBase Interface

DevExpress.XtraScheduler Namespace