Back to Devexpress

AppointmentStorage Members

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

latest27.8 KB
Original Source

AppointmentStorage Members

Represents a storage which holds a collection of appointments.

Constructors

NameDescription
AppointmentStorage(SchedulerStorage)Initializes a new instance of the AppointmentStorage class with the specified scheduler storage.

Properties

NameDescription
AppointmentFactoryProvides access to an appointment factory for the current storage. Inherited from AppointmentStorageBase.
AutoReloadGets or sets whether persistent object data is automatically fetched from the data source when it is modified. Inherited from PersistentObjectStorage<T>.
AutoRetrieveIdGets or sets whether to automatically retrieve an appointment’s identity from a data source.
CommitIdToDataSourceGets or sets whether the appointment ID value should be passed to the data source.
CountGets the number of elements contained in a collection. Inherited from PersistentObjectStorage<T>.
CustomFieldMappingsProvides access to the collection of objects, representing mappings of the appointments’ custom properties to appropriate data fields.
DataManagerFor internal use only. Inherited from AppointmentStorageBase.
DataMemberGets or sets the data source member which supplies data to the storage object. Inherited from PersistentObjectStorage<T>.
DataSourceGets or sets the object used as the data source to store persistent objects (appointments, resources or appointment dependencies). Inherited from PersistentObjectStorage<T>.
FilterGets or set an expression used as a criteria to filter appointments in the storage.
FilterCriteriaGets or sets the criteria to filter appointments in the storage.
IsDisposedGets a value indicating whether a storage has been disposed of. Inherited from PersistentObjectStorage<T>.
IsLoadingGets whether the storage is being initialized. Inherited from PersistentObjectStorage<T>.
IsUpdateLockedGets whether the storage has been locked for updating. Inherited from PersistentObjectStorage<T>.
Item[Int32]Provides indexed access to individual items in the appointment collection which can be accessed using the AppointmentStorageBase.Items property. Inherited from AppointmentStorageBase.
ItemsGets the collection of appointments within the storage. Inherited from AppointmentStorageBase.
LabelsGets the collection of appointment labels contained in the storage.
MappingsGets an object that specifies how appointment properties map to the data source fields. Inherited from AppointmentStorageBase.
ResourceSharingGets or sets a value indicating whether an appointment could be shared between multiple resources. Inherited from AppointmentStorageBase.
ShouldUpdateAfterInsertGets or sets whether the appointment storage should perform the UPDATE query after INSERT. Inherited from PersistentObjectStorage<T>.
StatusesUse the SchedulerDataStorage.Statuses property instead. Gets the collection of appointment statuses contained in the storage.
StorageReturns the storage that owns this AppointmentStorage.
SupportsRecurrenceGets whether the data mapping for appointment recurrence information is specified. Inherited from AppointmentStorageBase.
SupportsRemindersGets whether the appointment reminder data mapping is specified. Inherited from AppointmentStorageBase.
UnboundDataKeeperCreates and holds an internal data table for the unbound mode. For internal use. Inherited from PersistentObjectStorage<T>.
UnboundModeGets a value indicating if the storage is bound to data. Inherited from PersistentObjectStorage<T>.

Methods

NameDescription
Add(Appointment)Appends the specified Appointment object to the collection which can be accessed via the storage’s AppointmentStorageBase.Items property. Inherited from AppointmentStorageBase.
AddRange(Appointment[])Appends an array of appointments to the storage’s collection. Inherited from AppointmentStorageBase.
AppendBaseMappings(MappingCollection)Clears previous mappings and appends base mappings. Inherited from PersistentObjectStorage<T>.
AppendCustomMappings()Appends PersistentObjectStorage<T>.CustomFieldMappings to the collection of actual mappings. For internal use. Inherited from PersistentObjectStorage<T>.
AppendDefaultMappings(MappingCollection)Adds mappings for persistent object properties with field names equal to property names. Inherited from PersistentObjectStorage<T>.
AppendMappings(MappingCollection)Adds mappings defined in the storage to the specified mapping collection. Inherited from PersistentObjectStorage<T>.
BeginInit()Starts the appointment storage initialization. Inherited from AppointmentStorageBase.
BeginUpdate()Obsolete. Locks the object until the EndUpdate or CancelUpdate method is called. Inherited from PersistentObjectStorage<T>.
CancelUpdate()Obsolete. Unlocks the PersistentObjectStorage<T> object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from PersistentObjectStorage<T>.
Clear()Removes all the items from the persistent object storage. Inherited from PersistentObjectStorage<T>.
CommitExistingObject(Appointment)Commits changes to an existing object. Updates the object data record in the underlying data source. Inherited from AppointmentStorageBase.
CommitNewObject(T)Commits a new object. Creates a new object data record and stores it in the underlying data source. For internal use. Inherited from PersistentObjectStorage<T>.
Contains(Appointment)Determines whether the appointment storage contains the specified appointment. Inherited from AppointmentStorageBase.
CreateAppointment(AppointmentType, DateTime, DateTime, String)Creates an appointment of the specified type with the specified start time, end time and a subject. Inherited from AppointmentStorageBase.
CreateAppointment(AppointmentType, DateTime, DateTime)Creates an appointment of the specified type with the specified start and end time. Inherited from AppointmentStorageBase.
CreateAppointment(AppointmentType, DateTime, TimeSpan, String)Creates an appointment of the specified type with the specified start time, duration and a subject. Inherited from AppointmentStorageBase.
CreateAppointment(AppointmentType, DateTime, TimeSpan)Creates an appointment of the specified type with the specified start time and duration. Inherited from AppointmentStorageBase.
CreateAppointment(AppointmentType)Creates an appointment of the specified type. Inherited from AppointmentStorageBase.
CreateCustomFields(T)Creates the custom fields specific to this persistent object and adds them to the object’s custom fields collection. Inherited from PersistentObjectStorage<T>.
Dispose()Disposes of the PersistentObjectStorage<T> object. Inherited from PersistentObjectStorage<T>.
EndInit()Ends the appointment storage initialization. Inherited from AppointmentStorageBase.
EndUpdate()Obsolete. Unlocks the PersistentObjectStorage<T> object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from PersistentObjectStorage<T>.
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.
GetAppointmentById(Object)Gets the appointment by its identifier. Inherited from AppointmentStorageBase.
GetAppointmentsExpandingPatterns(TimeInterval, Boolean)Gets all appointments including occurrences and exceptions which are located in the specified time interval. Inherited from AppointmentStorageBase.
GetAppointmentsExpandingPatterns(TimeInterval)Gets all appointments including occurrences and exceptions which are located in the specified time interval. Inherited from AppointmentStorageBase.
GetColumnNames()Gets the names of data columns associated with this PersistentObjectStorage<T> object. Inherited from PersistentObjectStorage<T>.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetObjectRow(T)Returns the data row object that contains information about the specified persistent object. Inherited from PersistentObjectStorage<T>.
GetObjectValue(T, String)Returns the value of the specified field in the data row that contains information about the specified persistent object. Inherited from PersistentObjectStorage<T>.
GetType()Gets the Type of the current instance. Inherited from Object.
IsNewAppointment(Appointment)Determines whether the appointment is new, so that it is not an occurrence, and the current AppointmentStorageBase does not contain it. Inherited from AppointmentStorageBase.
LoadFromXml(Stream)Loads settings of appointments from the specified stream to the appointment storage. Inherited from AppointmentStorageBase.
LoadFromXml(String)Loads settings of appointments from the specified XML file to the appointment storage. Inherited from AppointmentStorageBase.
LoadObjects(Boolean)Loads persistent objects from the data source to the storage. Inherited from PersistentObjectStorage<T>.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
RaiseLoadException(Exception)Calls the handler for the AppointmentStorageBase.LoadException event. Inherited from AppointmentStorageBase.
RaiseReload(Boolean)Raises the internal Reload event. This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PersistentObjectStorage<T>.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Remove(Appointment)Removes the specified Appointment object from the collection. Inherited from AppointmentStorageBase.
RollbackExistingObject(T)Restores an object to its previous state and cancels uncommitted changes that were made to the object. Inherited from PersistentObjectStorage<T>.
SaveToXml(Stream)Saves appointments from the storage to the specified stream. Inherited from AppointmentStorageBase.
SaveToXml(String)Saves appointments from the storage to an XML file. Inherited from AppointmentStorageBase.
SetAppointmentFactory(IAppointmentFactory)Assigns the specified appointment factory to the AppointmentStorageBase. Inherited from AppointmentStorageBase.
SetObjectValue(T, String, Object)Assigns the specified value to a field in the data row that contains information about the specified persistent object. Inherited from PersistentObjectStorage<T>.
ToString()Returns a string that represents the current object. Inherited from Object.
ValidateDataSource()Checks mappings for validity. Inherited from PersistentObjectStorage<T>.

Events

NameDescription
AutoReloadingOccurs when persistent object data is automatically fetched from the data source; allows cancelling data loading. Inherited from PersistentObjectStorage<T>.
FilterChangedOccurs when the PersistentObjectStorage<T>.Filter property value is changed. Inherited from PersistentObjectStorage<T>.
LoadExceptionFires when a problem occurs in appointment loading to the storage from an external data source. Inherited from AppointmentStorageBase.
MappingsChangedOccurs when the field name of any object mapping in the storage is changed. Inherited from PersistentObjectStorage<T>.
ObjectChangedOccurs when a persistent object in the storage is changed. Inherited from PersistentObjectStorage<T>.
ObjectChangingOccurs before a persistent object in the storage is changed and allows you to cancel changes. Inherited from PersistentObjectStorage<T>.
ObjectCollectionClearedOccurs when a collection of persistent objects in the storage is cleared. Inherited from PersistentObjectStorage<T>.
ObjectCollectionLoadedOccurs when persistent objects are loaded from the data source into the storage. Inherited from PersistentObjectStorage<T>.
ObjectDeletedOccurs when a persistent object is deleted from the storage. Inherited from PersistentObjectStorage<T>.
ObjectDeletingOccurs before a persistent object is deleted from the storage and allows you to cancel deletion. Inherited from PersistentObjectStorage<T>.
ObjectInsertedOccurs when a persistent object is inserted into the storage. Inherited from PersistentObjectStorage<T>.
ObjectInsertingOccurs before a persistent object is inserted into the storage and allows you to cancel insertion. Inherited from PersistentObjectStorage<T>.
UIChangedThis member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from AppointmentStorageBase.

See Also

AppointmentStorage Class

DevExpress.XtraScheduler Namespace