Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressScheduler Suite > API Reference > cxSchedulerDBStorage > TcxSchedulerDBStorage > Members
All docs
V24.1
VCL Controls
Express Cross Platform Library
ExpressQuantumGrid Suite
ExpressEditors Library
ExpressBars Suite
ExpressCharts Suite
ExpressRichEditControl Suite
ExpressSkins Library
ExpressScheduler Suite
Getting Started
VCL Scheduler: Supported Commands List
Concepts
How To...
API Reference
cxDateNavigator
cxExportSchedulerLink
cxScheduler
cxSchedulerActions
cxSchedulerAgendaView
cxSchedulerAggregateStorage
cxSchedulerCustomControls
cxSchedulerCustomResourceView
cxSchedulerDBStorage
TcxFieldName
TcxSchedulerDBStorage
Members
Constructors
Properties
Methods
Events
TcxSchedulerDBStorageDataController
TcxSchedulerDBStorageField
TcxSchedulerDBStorageFieldNames
TcxSchedulerDBStorageFields
TcxSchedulerDBStorageResources
TcxSchedulerGetEventGeneratedIDEvent
cxSchedulerDateNavigator
cxSchedulerDayView
cxSchedulerDialogs
cxSchedulerEventEditor
cxSchedulerGanttView
cxSchedulerHolidays
cxSchedulerICalendar
cxSchedulerOutlookExchange
cxSchedulerRangeControlClientProperties
cxSchedulerRecurrence
cxSchedulerRecurrenceEditor
cxSchedulerReminderWindow
cxSchedulerStorage
cxSchedulerTimeGridView
cxSchedulerUtils
cxSchedulerWebServiceStorage
cxSchedulerWebServiceStorageGoogleProvider
cxSchedulerWebServiceStorageOfficeProvider
cxSchedulerWeekView
cxSchedulerYearView
cxSchedulercxGridConnection
ExpressSpreadSheet Suite
ExpressQuantumTreeList Suite
ExpressPDFViewer Suite
ExpressPrinting System
ExpressLayoutControl Suite
ExpressNavBar Suite
ExpressPivotGrid Suite
ExpressVerticalGrid Suite
ExpressDocking Library
ExpressMemData
ExpressDataController
ExpressSpellChecker Suite
ExpressMapControl Suite
ExpressGanttControl Suite
ExpressGaugeControl Suite
ExpressTileControl Suite
ExpressFlowChart Suite
ExpressFlowChart Editor
ExpressOrgChart Suite
ExpressPageControl Suite
ExpressWizardControl Suite

TcxSchedulerDBStorage Members

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

Constructors

Name Description
Create(TComponent) Inherited from TComponent.

Properties

Name Description
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
CustomFields Represents user-defined fields in storage.
DataSource Specifies the data source that links the bound event persistence manager to a dataset.
DesignInfo Inherited from TComponent.
EditingEventInfoList Inherited from TcxCustomSchedulerStorage.
EventCount Returns the number of user events stored in the persistence manager. Inherited from TcxCustomSchedulerStorage.
Events Provides zero-based indexed access to all user events persisted in the storage. Inherited from TcxCustomSchedulerStorage.
FieldCount Gets the total number of both built-in and custom fields. Inherited from TcxCustomSchedulerStorage.
FieldNames Provides access to the dataset field names used for binding dataset fields to individual properties of the persisted user events.
Fields Provides indexed access to storage fields. Inherited from TcxCustomSchedulerStorage.
GenerateGUIDForID Specifies whether the user event‘s ID should be generated as GUID.
Holidays References the TcxSchedulerHolidays component instance. Inherited from TcxCustomSchedulerStorage.
InternalUpdate Determines whether the scheduler and its underlying data store are currently being synchronized. Inherited from TcxCustomSchedulerStorage.
LinksController Inherited from TcxCustomSchedulerStorage.
Name Inherited from TComponent.
Observers Inherited from TComponent.
Owner Inherited from TComponent.
Reminders Represents a collection, which stores timed out reminders, if any. Inherited from TcxCustomSchedulerStorage.
ResourceCount Returns the number of stored resources. Inherited from TcxCustomSchedulerStorage.
ResourceIDs Returns the unique identifier of a specified stored resource. Inherited from TcxCustomSchedulerStorage.
ResourceNames Returns the display name of a specified stored resource. Inherited from TcxCustomSchedulerStorage.
Resources Provides access to the bound event persistence manager’s resource container.
SmartRefresh Specifies the manner in which dataset records are updated.
StoreUsingGlobalTime Specifies whether the persistence manager component uses UTC time instead of local. Inherited from TcxCustomSchedulerStorage.
StoringName Specifies the stored name of the persistent scheduler control’s layout. Inherited from TcxCustomSchedulerStorage.
Tag Inherited from TComponent.
TimeBias

Returns the system time offset from UTC.

This property is for internal use.

Inherited from TcxCustomSchedulerStorage.
UseActualTimeRange Specifies whether user events are retrieved based upon their time period bounds from the underlying data store. Inherited from TcxCustomSchedulerStorage.
UseIndexedID Specifies whether the indexed user event identifier field is used.
VCLComObject Inherited from TComponent.

Methods

Name Description
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.
BeginUpdate Acquires a lock on the data controller to prevent View update callbacks being made to the registered IcxSchedulerStorageListener listener by the data controller, until a block of data update statements has finished executing. Inherited from TcxCustomSchedulerStorage.
CalculateEventActualTimeRanges Populates the ActualStart and ActualFinish fields with the values of the user event‘s time period bounds. Inherited from TcxCustomSchedulerStorage.
CheckRequiredFields Checks if all the obligatory properties of persisted user events are mapped to the corresponding fields of the underlying dataset.
Clear Deletes all user events from the bound persistence manager and updates the associated Scheduler control.
createEvent Creates a user event with the default settings. Inherited from TcxCustomSchedulerStorage.
CreateOccurrence(TcxSchedulerEvent,TDateTime,TcxEventType) Creates occurrence of the APattern parent at the ADate date. Inherited from TcxCustomSchedulerStorage.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
DoneRestore Inherited from TcxCustomSchedulerStorage.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
EndUpdate Updates 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.
FreeOnRelease Inherited from TComponent.
FullRefresh Forces 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.
GetHashCode Inherited from TObject.
GetHolidayNamesByDate(TDate,string,Boolean) Populates a parameter with names of holidays taking place at a certain date. Inherited from TcxCustomSchedulerStorage.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Inherited from TComponent.
GetReminderEvents(TDateTime,TcxSchedulerFilteredEventList) Populates the AList collection with in-memory user events containing reminders. Inherited from TcxCustomSchedulerStorage.
HasParent Inherited from TComponent.
HolidaysChanged(TObject) Inherited from TcxCustomSchedulerStorage.
HolidaysRemoved(TObject) Inherited from TcxCustomSchedulerStorage.
InitRestore Inherited from TcxCustomSchedulerStorage.
InsertComponent(TComponent) Inherited from TComponent.
IsActive Identifies if the event persistence manager is ready for use by the associated scheduler control. Inherited from TcxCustomSchedulerStorage.
IsCaptionAvailable Inherited from TcxCustomSchedulerStorage.
IsEventEditing(TcxSchedulerControlEvent) Inherited from TcxCustomSchedulerStorage.
IsEventSharingAllowed Identifies if the persistence manager can share an event between resources. Inherited from TcxCustomSchedulerStorage.
IsImplementorOf(IInterface) Inherited from TComponent.
IsLabelColorAvailable Identifies if the persistence manager stores event label colors. Inherited from TcxCustomSchedulerStorage.
IsLocationAvailable Identifies if the persistence manager stores information on event locations. Inherited from TcxCustomSchedulerStorage.
IsMessageAvailable Identifies if the persistence manager stores user event descriptions. Inherited from TcxCustomSchedulerStorage.
IsRecurrenceAvailable Inherited from TcxCustomSchedulerStorage.
IsReminderAvailable Inherited from TcxCustomSchedulerStorage.
IsReminderByResourceAvailable Inherited from TcxCustomSchedulerStorage.
IsStateAvailable Identifies if the persistence manager stores information on the event creator’s availability status. Inherited from TcxCustomSchedulerStorage.
Loaded Inherited 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.
PostEvents Saves 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.
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.

Events

Name Description
OnEventDeleted Fires when AEvent is about to be deleted from storage and memory. Inherited from TcxCustomSchedulerStorage.
OnEventInserted Fires before the AEvent object is added to storage. Inherited from TcxCustomSchedulerStorage.
OnEventIntersect Fires when AEvent1 and AEvent2 are about to be overlapped. Inherited from TcxCustomSchedulerStorage.
OnEventModified Fires before the AEvent object is updated in storage. Inherited from TcxCustomSchedulerStorage.
OnFilterEvent Fires every time the AEvent instance is about to be loaded into the scheduler cache for displaying by the scheduler. Inherited from TcxCustomSchedulerStorage.
OnGetEventGeneratedID Fires 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.
RemindersEvents Inherited from TcxCustomSchedulerStorage.
ResourcesEvents Inherited from TcxCustomSchedulerStorage.
See Also