Back to Devexpress

TcxSchedulerDBStorage Members

vcl-cxschedulerdbstorage-dot-tcxschedulerdbstorage-dot-underscore-members.md

latest31.4 KB
Original Source

TcxSchedulerDBStorage Members

A persistence manager that stores user events and resources in a relational data store.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
CustomFieldsRepresents user-defined fields in storage.
DataSourceSpecifies the data source that links the bound event persistence manager to a dataset.
DesignInfoInherited from TComponent.
EditingEventInfoListInherited from TcxCustomSchedulerStorage.
EventCountReturns the number of stored (posted) user events. Inherited from TcxCustomSchedulerStorage.
EventsProvides indexed access to all stored (posted) user events. Inherited from TcxCustomSchedulerStorage.
FieldCountGets the total number of both built-in and custom fields. Inherited from TcxCustomSchedulerStorage.
FieldNamesProvides access to the dataset field names used for binding dataset fields to individual properties of the persisted user events.
FieldsProvides indexed access to storage fields. Inherited from TcxCustomSchedulerStorage.
GenerateGUIDForIDSpecifies whether the user event‘s ID should be generated as GUID.
HolidaysReferences the TcxSchedulerHolidays component instance. Inherited from TcxCustomSchedulerStorage.
InternalUpdateDetermines whether the scheduler and its underlying data store are currently being synchronized. Inherited from TcxCustomSchedulerStorage.
LinksControllerInherited from TcxCustomSchedulerStorage.
NameInherited from TComponent.
ObserversInherited from TComponent.
OwnerInherited from TComponent.
RemindersRepresents a collection, which stores timed out reminders, if any. Inherited from TcxCustomSchedulerStorage.
ResourceCountReturns the number of stored resources. Inherited from TcxCustomSchedulerStorage.
ResourceIDsReturns the unique identifier of a specified stored resource. Inherited from TcxCustomSchedulerStorage.
ResourceNamesReturns the display name of a specified stored resource. Inherited from TcxCustomSchedulerStorage.
ResourcesProvides access to the bound event persistence manager’s resource container.
SmartRefreshSpecifies the manner in which dataset records are updated.
StoreUsingGlobalTimeSpecifies whether the persistence manager component uses UTC time instead of local. Inherited from TcxCustomSchedulerStorage.
StoringNameSpecifies the stored name of the persistent scheduler control’s layout. Inherited from TcxCustomSchedulerStorage.
TagInherited from TComponent.
TimeBiasReturns the current UTC time offset. Inherited from TcxCustomSchedulerStorage.
UseActualTimeRangeSpecifies whether user events are retrieved based upon their time period bounds from the underlying data store. Inherited from TcxCustomSchedulerStorage.
UseIndexedIDSpecifies whether the indexed user event identifier field is used.
VCLComObjectInherited from TComponent.

Methods

NameDescription
AddListener(IcxSchedulerStorageListener)Registers the IcxSchedulerStorageListener listener specified by the AListener parameter so that it’s notified when the storage changes its state. Inherited from TcxCustomSchedulerStorage.
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject)Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject)Inherited from TComponent.
BeginInvoke(TProc,TObject)Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject)Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject)Inherited from TComponent.
BeginUpdatePostpones all notifications that reflect any scheduler storage component changes until an EndUpdate procedure call. Inherited from TcxCustomSchedulerStorage.
CalculateEventActualTimeRangesPopulates the ActualStart and ActualFinish fields with the values of the user event‘s time period bounds. Inherited from TcxCustomSchedulerStorage.
CheckRequiredFieldsChecks if all the obligatory properties of persisted user events are mapped to the corresponding fields of the underlying dataset.
ClearDeletes all user events from the bound persistence manager and updates the associated Scheduler control.
createEventCreates a user event with the default settings and adds the event to the storage component. Inherited from TcxCustomSchedulerStorage.
CreateOccurrence(TcxSchedulerEvent,TDateTime,TcxEventType)Creates occurrence of the APattern parent at the ADate date. Inherited from TcxCustomSchedulerStorage.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DoneRestoreInherited from TcxCustomSchedulerStorage.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndUpdateUpdates storage and releases a lock on the data controller. Inherited from TcxCustomSchedulerStorage.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
FindAvailableAllDay(TDateTime,TDateTime,Variant,Boolean,TDateTime)Searches for free time blocks which can be used to schedule an all-day user event. Inherited from TcxCustomSchedulerStorage.
FindAvailableTime(TcxSchedulerEvent,Boolean,TDateTime,TDateTime)Searches for free time blocks which can be used to schedule the AEvent user event. Inherited from TcxCustomSchedulerStorage.
FindAvailableTime(TDateTime,TDateTime,Boolean,Variant,Boolean,TDateTime,TcxSchedulerEvent)Inherited from TcxCustomSchedulerStorage.
FindComponent(String)Inherited from TComponent.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
FullRefreshForces the data controller to update itself and notify the registered IcxSchedulerStorageListener listeners. Inherited from TcxCustomSchedulerStorage.
GenerateHolidayEvents(Variant)Creates new user events that represent holidays, and adds them to the storage. Inherited from TcxCustomSchedulerStorage.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetEventByID(Variant)Returns an event by its unique identifier. Inherited from TcxCustomSchedulerStorage.
GetEvents(TcxSchedulerFilteredEventList,TDateTime,TDateTime,Variant)Clears the specified event list and populates it with events retrieved from the persistence manager’s resources. Inherited from TcxCustomSchedulerStorage.
GetEvents(TcxSchedulerFilteredEventList,TDateTime,TDateTime)Inherited from TcxCustomSchedulerStorage.
GetFieldByName(string)Inherited from TcxCustomSchedulerStorage.
GetHashCodeInherited from TObject.
GetHolidayNamesByDate(TDate,string,Boolean)Populates a parameter with names of holidays taking place at a certain date. Inherited from TcxCustomSchedulerStorage.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GetReminderEvents(TDateTime,TcxSchedulerFilteredEventList)Populates the AList collection with in-memory user events containing reminders. Inherited from TcxCustomSchedulerStorage.
HasParentInherited from TComponent.
HolidaysChanged(TObject)Inherited from TcxCustomSchedulerStorage.
HolidaysRemoved(TObject)Inherited from TcxCustomSchedulerStorage.
InitRestoreInherited from TcxCustomSchedulerStorage.
InsertComponent(TComponent)Inherited from TComponent.
IsActiveIdentifies if the event persistence manager is ready for use by the associated scheduler control. Inherited from TcxCustomSchedulerStorage.
IsCaptionAvailableInherited from TcxCustomSchedulerStorage.
IsEventEditing(TcxSchedulerControlEvent)Inherited from TcxCustomSchedulerStorage.
IsEventSharingAllowedIdentifies if the persistence manager can share an event between resources. Inherited from TcxCustomSchedulerStorage.
IsImplementorOf(IInterface)Inherited from TComponent.
IsLabelColorAvailableIdentifies if the persistence manager stores event label colors. Inherited from TcxCustomSchedulerStorage.
IsLocationAvailableIdentifies if the persistence manager stores information on event locations. Inherited from TcxCustomSchedulerStorage.
IsMessageAvailableIdentifies if the persistence manager stores user event descriptions. Inherited from TcxCustomSchedulerStorage.
IsRecurrenceAvailableInherited from TcxCustomSchedulerStorage.
IsReminderAvailableInherited from TcxCustomSchedulerStorage.
IsReminderByResourceAvailableInherited from TcxCustomSchedulerStorage.
IsStateAvailableIdentifies if the persistence manager stores information on the event creator’s availability status. Inherited from TcxCustomSchedulerStorage.
LoadedInherited from TComponent.
Notification(TComponent,TOperation)Inherited from TComponent.
PopulateHolidayDates(TcxSchedulerDateList,TDate,TDate,Boolean,Boolean)Populates AList with holiday dates by the specified period. Inherited from TcxCustomSchedulerStorage.
PostEventsSaves all new user events to the open and connected dataset and updates the associated Scheduler control.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RemoveListener(IcxSchedulerStorageListener)Deletes the IcxSchedulerStorageListener listener specified by the AListener parameter from the collection of listeners registered with the TcxCustomSchedulerStorage. Inherited from TcxCustomSchedulerStorage.
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ToStringInherited from TObject.
UpdateAction(TBasicAction)Inherited from TComponent.

Events

NameDescription
OnEventDeletedFires when AEvent is about to be deleted from storage and memory. Inherited from TcxCustomSchedulerStorage.
OnEventInsertedFires before the AEvent object is added to storage. Inherited from TcxCustomSchedulerStorage.
OnEventIntersectFires when AEvent1 and AEvent2 are about to be overlapped. Inherited from TcxCustomSchedulerStorage.
OnEventModifiedFires before the AEvent object is updated in storage. Inherited from TcxCustomSchedulerStorage.
OnFilterEventFires every time the AEvent instance is about to be loaded into the scheduler cache for displaying by the scheduler. Inherited from TcxCustomSchedulerStorage.
OnGetEventGeneratedIDFires when the details on a new user event have been posted to the database and a new unique identifier has been generated but not yet assigned to the new user event.
RemindersEventsInherited from TcxCustomSchedulerStorage.
ResourcesEventsInherited from TcxCustomSchedulerStorage.

See Also

TcxSchedulerDBStorage Class

cxSchedulerDBStorage Unit