Back to Devexpress

SchedulerStorage Members

windowsforms-devexpress-dot-xtrascheduler-dot-schedulerstorage-dot-underscore-members.md

latest38.7 KB
Original Source

SchedulerStorage Members

Use a SchedulerDataStorage as a component that holds data for the SchedulerControl.

Constructors

NameDescription
SchedulerStorage()Initializes a new instance of the SchedulerStorage class with default settings.
SchedulerStorage(IContainer)Initializes a new instance of the SchedulerStorage class with the specified container.

Properties

NameDescription
AppointmentCacheEnabledObsolete. This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from SchedulerStorageBase.
AppointmentDependenciesGets a storage object which manages dependencies between appointments.
AppointmentsGets a storage object that contains appointments.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DateTimeSavingModeGets or sets in what time zone to store the appointment dates. Inherited from SchedulerStorageBase.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnableRemindersGets or sets whether the Reminder availability for appointments is enabled. Inherited from SchedulerStorageBase.
EnableSmartFetchGets or sets whether certain internal criteria for raising the SchedulerStorageBase.FetchAppointments event are applied to reduce the number of data requests. Inherited from SchedulerStorageBase.
EnableTimeZonesGets or sets whether the scheduler saves the appointment time zone information. Inherited from SchedulerStorageBase.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FetchOnVisibleResourcesChangedGets or sets whether to raise the FetchAppointments event when the EnableSmartFetch property is switched on and visible resources are changed. Inherited from SchedulerStorageBase.
IsUpdateLockedGets whether the storage has been locked for updating. Inherited from SchedulerStorageBase.
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. Inherited from SchedulerStorageBase.
RemindersCheckIntervalGets or sets the time interval a reminder’s alert time should be checked (in milliseconds). Inherited from SchedulerStorageBase.
RemindersEnabledGets whether the reminders are enabled. Inherited from SchedulerStorageBase.
ResourcesGets the object which manages resources for appointments.
ResourceSharingGets a value indicating whether an appointment could be shared between multiple resources. Inherited from SchedulerStorageBase.
SiteGets or sets the ISite of the Component. Inherited from Component.
SupportsRecurrenceGets whether the scheduler storage can contain information on appointment recurrence. Inherited from SchedulerStorageBase.
SupportsRemindersGets whether the appointment reminder data mapping is specified. Inherited from SchedulerStorageBase.
TimeZoneIdGets or sets the time zone in which the SchedulerStorage operates. Inherited from SchedulerStorageBase.
UnboundModeGets a value indicating if the scheduler storage is bound to data. Inherited from SchedulerStorageBase.

Methods

NameDescription
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 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()
Equals(Object, Object) staticDetermines 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.
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.
GetFilteredComponents()This member supports the internal infrastructure and is not intended to be used directly from your code.
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) protectedReturns 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates 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) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RefreshData()
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

NameDescription
AppointmentChangingFires when an appointment’s property is about to change. Inherited from SchedulerStorageBase.
AppointmentCollectionAutoReloadingOccurs when the data source which contains appointment records is modified and appointments are set to be automatically reloaded. Inherited from SchedulerStorageBase.
AppointmentCollectionClearedFires after the appointment collection has been cleared. Inherited from SchedulerStorageBase.
AppointmentCollectionLoadedFires after appointments have been loaded into the AppointmentBaseCollection collection. Inherited from SchedulerStorageBase.
AppointmentDeletingAllows you to cancel the deletion of an appointment. Inherited from SchedulerStorageBase.
AppointmentDependenciesChangedFires when the properties of the appointment dependency have been changed. Inherited from SchedulerStorageBase.
AppointmentDependenciesDeletedFires after deletion of one or several appointment dependencies. Inherited from SchedulerStorageBase.
AppointmentDependenciesInsertedFires after one or several appointment dependencies have been added to the collection. Inherited from SchedulerStorageBase.
AppointmentDependencyChangingFires when the appointment dependency type is changing. Inherited from SchedulerStorageBase.
AppointmentDependencyCollectionAutoReloadingOccurs when the data source which contains appointment dependency records is modified and dependencies are set to be automatically reloaded. Inherited from SchedulerStorageBase.
AppointmentDependencyCollectionClearedFires after the appointment dependency collection has been cleared. Inherited from SchedulerStorageBase.
AppointmentDependencyCollectionLoadedFires after appointment dependencies have been loaded into the storage. Inherited from SchedulerStorageBase.
AppointmentDependencyDeletingAllows you to cancel the deletion of an appointment dependency. Inherited from SchedulerStorageBase.
AppointmentDependencyInsertingAllows you to cancel the insertion of an appointment dependency. Inherited from SchedulerStorageBase.
AppointmentInsertingAllows you to cancel the insertion of an appointment. Inherited from SchedulerStorageBase.
AppointmentsChangedFires when the appointments’ properties have been changed. Inherited from SchedulerStorageBase.
AppointmentsDeletedFires after deletion of one or several appointments. Inherited from SchedulerStorageBase.
AppointmentsInsertedFires after one or several appointments have been added to the collection. Inherited from SchedulerStorageBase.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
FetchAppointmentsOccurs before the SchedulerStorageBase starts retrieving the appointments for the specified time interval. Inherited from SchedulerStorageBase.
FilterAppointmentHides specific appointments in the Scheduler control. Inherited from SchedulerStorageBase.
FilterDependencyHides certain appointment dependencies in the Gantt view. Inherited from SchedulerStorageBase.
FilterReminderAlertEnables you to fire alerts only for specific reminders. Inherited from SchedulerStorageBase.
FilterResourceHides specific resources in the Scheduler control. Inherited from SchedulerStorageBase.
PrepareAppointmentFilterColumnFires when a column, representing an appointment’s field, is added to the collection of filter columns contained within the FilterControl.
PrepareResourceFilterColumnFires when a column, representing a resource’s field, is added to the collection of filter columns contained within the FilterControl.
ReminderAlertOccurs when a reminder alert is invoked. Inherited from SchedulerStorageBase.
ResourceChangingFires when a resource’s property is about to be changed. Inherited from SchedulerStorageBase.
ResourceCollectionAutoReloadingOccurs when the data source which contains resources is modified and the automatic reloading of resources is enabled. Inherited from SchedulerStorageBase.
ResourceCollectionClearedFires after the resource collection has been cleared. Inherited from SchedulerStorageBase.
ResourceCollectionLoadedFires after resources have been loaded into the Scheduler storage. Inherited from SchedulerStorageBase.
ResourceDeletingAllows the deletion of a resource to be cancelled. Inherited from SchedulerStorageBase.
ResourceInsertingAllows you to cancel the addition of a resource. Inherited from SchedulerStorageBase.
ResourcesChangedOccurs when a scheduler’s resource in a collection is changed. Inherited from SchedulerStorageBase.
ResourcesDeletedOccurs after a scheduler’s resource(s) is deleted. Inherited from SchedulerStorageBase.
ResourcesInsertedOccurs when new resources are inserted into the scheduler storage. Inherited from SchedulerStorageBase.

See Also

SchedulerStorage Class

DevExpress.XtraScheduler Namespace