Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressScheduler Suite > API Reference > cxSchedulerStorage > TcxCustomSchedulerStorage > 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
cxSchedulerDateNavigator
cxSchedulerDayView
cxSchedulerDialogs
cxSchedulerEventEditor
cxSchedulerGanttView
cxSchedulerHolidays
cxSchedulerICalendar
cxSchedulerOutlookExchange
cxSchedulerRangeControlClientProperties
cxSchedulerRecurrence
cxSchedulerRecurrenceEditor
cxSchedulerReminderWindow
cxSchedulerStorage
IcxSchedulerEventEditorForm
IcxSchedulerStorageListener
IcxSchedulerStorageListener2
IcxShedulerCustomEditorForm
TcxCompareEventsProc
TcxCustomSchedulerStorage
Members
Constructors
Properties
Methods
Events
TcxCustomSchedulerStorageField
TcxCustomSchedulerStorageFields
TcxDoublyLinkedEventList
TcxDoublyLinkedEventListData
TcxDueTimeInfoToTextProc
TcxEventType
TcxGetRecurrenceDescriptionStringProc
TcxOccurrenceDateStatus
TcxOnAfterEditingProc
TcxOnDeleteEventFunc
TcxSchedulerControlEvent
TcxSchedulerControlEventID
TcxSchedulerCustomReminderForm
TcxSchedulerEditingEventInfo
TcxSchedulerEditingEventInfoList
TcxSchedulerEvent
TcxSchedulerEventConflictsInfo
TcxSchedulerEventConflictsInfoClass
TcxSchedulerEventEditInfo
TcxSchedulerEventGroupItems
TcxSchedulerEventIntersectEvent
TcxSchedulerEventItemLink
TcxSchedulerEventLinks
TcxSchedulerEventLinksController
TcxSchedulerEventList
TcxSchedulerEventRecurrenceInfo
TcxSchedulerEventRelation
TcxSchedulerEventTaskStatus
TcxSchedulerFilterEventEvent
TcxSchedulerFilteredEventList
TcxSchedulerForEachEventHandlerProc
TcxSchedulerGetEventDueTimeTextEvent
TcxSchedulerGetReminderWindowCaption
TcxSchedulerGetResourceImageIndexEvent
TcxSchedulerGetResourceNameEvent
TcxSchedulerNotificationEvent
TcxSchedulerOccurrenceCalculator
TcxSchedulerReminder
TcxSchedulerReminderDueTimeElement
TcxSchedulerReminderDueTimeInfo
TcxSchedulerReminderDueTimeKind
TcxSchedulerReminderEvent
TcxSchedulerReminderEventID
TcxSchedulerReminderFormClass
TcxSchedulerReminderOpenEvent
TcxSchedulerReminderResource
TcxSchedulerReminderResources
TcxSchedulerReminderResourcesData
TcxSchedulerReminders
TcxSchedulerRemindersEvent
TcxSchedulerResourceEvent
TcxSchedulerSnoozeReminderEvent
TcxSchedulerStorage
TcxSchedulerStorageDataController
TcxSchedulerStorageField
TcxSchedulerStorageFields
TcxSchedulerStorageResourceItem
TcxSchedulerStorageResourceItemClass
TcxSchedulerStorageResourceItems
TcxSchedulerStorageResources
cxDueTimeInfoToText(TcxSchedulerReminderDueTimeInfo)
cxDueTimeInfoToTextProc
cxFieldValueToReminderResourcesData(Variant)
cxGetRecurrenceDescriptionString(TcxSchedulerEventRecurrenceInfo,Boolean)
cxGetRecurrenceDescriptionStringProc
cxMaxCheckedDuration
cxReminderResourcesDataToFieldValue(TcxSchedulerReminderResourcesData)
cxSchedulerEventConflictsInfoClass
omAllDayEvent
omCollapsed
omEnabled
omGroup
omReminder
tlsBusy
tlsFree
tlsOutOfOffice
tlsTentative
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

TcxCustomSchedulerStorage Members

The base class for all classes that implement persistence manager components that the Scheduler control can use.

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.
DesignInfo Inherited from TComponent.
EditingEventInfoList
EventCount Returns the number of user events stored in the persistence manager.
Events Provides zero-based indexed access to all user events persisted in the storage.
FieldCount Gets the total number of both built-in and custom fields.
Fields Provides indexed access to storage fields.
Holidays References the TcxSchedulerHolidays component instance.
InternalUpdate Determines whether the scheduler and its underlying data store are currently being synchronized.
LinksController
Name Inherited from TComponent.
Observers Inherited from TComponent.
Owner Inherited from TComponent.
Reminders Represents a collection, which stores timed out reminders, if any.
ResourceCount Returns the number of stored resources.
ResourceIDs Returns the unique identifier of a specified stored resource.
ResourceNames Returns the display name of a specified stored resource.
Resources Provides access to the event persistence manager’s resource container.
StoreUsingGlobalTime Specifies whether the persistence manager component uses UTC time instead of local.
StoringName Specifies the stored name of the persistent scheduler control’s layout.
Tag Inherited from TComponent.
TimeBias

Returns the system time offset from UTC.

This property is for internal use.
UseActualTimeRange Specifies whether user events are retrieved based upon their time period bounds from the underlying data store.
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.
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.
CalculateEventActualTimeRanges Populates the ActualStart and ActualFinish fields with the values of the user event‘s time period bounds.
CheckRequiredFields
Clear Deletes all user events from the persistence manager and updates the associated scheduler control.
createEvent Creates a user event with the default settings.
CreateOccurrence(TcxSchedulerEvent,TDateTime,TcxEventType) Creates occurrence of the APattern parent at the ADate date.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
DoneRestore
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.
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.
FindAvailableTime(TcxSchedulerEvent,Boolean,TDateTime,TDateTime) Searches for free time blocks which can be used to schedule the AEvent user event.
FindAvailableTime(TDateTime,TDateTime,Boolean,Variant,Boolean,TDateTime,TcxSchedulerEvent)
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.
GenerateHolidayEvents(Variant) Creates new user events that represent holidays, and adds them to the storage.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetEventByID(Variant) Returns an event by its unique identifier.
GetEvents(TcxSchedulerFilteredEventList,TDateTime,TDateTime,Variant) Clears the specified event list and populates it with events retrieved from the persistence manager’s resources.
GetEvents(TcxSchedulerFilteredEventList,TDateTime,TDateTime)
GetFieldByName(string)
GetHashCode Inherited from TObject.
GetHolidayNamesByDate(TDate,string,Boolean) Populates a parameter with names of holidays taking place at a certain date.
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.
HasParent Inherited from TComponent.
HolidaysChanged(TObject)
HolidaysRemoved(TObject)
InitRestore
InsertComponent(TComponent) Inherited from TComponent.
IsActive Identifies if the event persistence manager is ready for use by the associated scheduler control.
IsCaptionAvailable
IsEventEditing(TcxSchedulerControlEvent)
IsEventSharingAllowed Identifies if the persistence manager can share an event between resources.
IsImplementorOf(IInterface) Inherited from TComponent.
IsLabelColorAvailable Identifies if the persistence manager stores event label colors.
IsLocationAvailable Identifies if the persistence manager stores information on event locations.
IsMessageAvailable Identifies if the persistence manager stores user event descriptions.
IsRecurrenceAvailable
IsReminderAvailable
IsReminderByResourceAvailable
IsStateAvailable Identifies if the persistence manager stores information on the event creator’s availability status.
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.
PostEvents Moves all new user events to the list of stored events 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.
SetParentComponent(TComponent) Inherited from TComponent.
SetSubComponent(Boolean) Inherited from TComponent.
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.

Events

Name Description
OnEventDeleted protected Fires when AEvent is about to be deleted from storage and memory.
OnEventInserted protected Fires before the AEvent object is added to storage.
OnEventIntersect protected Fires when AEvent1 and AEvent2 are about to be overlapped.
OnEventModified protected Fires before the AEvent object is updated in storage.
OnFilterEvent protected Fires every time the AEvent instance is about to be loaded into the scheduler cache for displaying by the scheduler.
RemindersEvents
ResourcesEvents
See Also