Back to Devexpress

TcxCustomSchedulerStorage Members

vcl-cxschedulerstorage-dot-tcxcustomschedulerstorage-dot-underscore-members.md

latest23.6 KB
Original Source

TcxCustomSchedulerStorage Members

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

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.
DesignInfoInherited from TComponent.
EditingEventInfoList
EventCountReturns the number of stored (posted) user events.
EventsProvides indexed access to all stored (posted) user events.
FieldCountGets the total number of both built-in and custom fields.
FieldsProvides indexed access to storage fields.
HolidaysReferences the TcxSchedulerHolidays component instance.
InternalUpdateDetermines whether the scheduler and its underlying data store are currently being synchronized.
LinksController
NameInherited from TComponent.
ObserversInherited from TComponent.
OwnerInherited from TComponent.
RemindersRepresents a collection, which stores timed out reminders, if any.
ResourceCountReturns the number of stored resources.
ResourceIDsReturns the unique identifier of a specified stored resource.
ResourceNamesReturns the display name of a specified stored resource.
ResourcesProvides access to the event persistence manager’s resource container.
StoreUsingGlobalTimeSpecifies whether the persistence manager component uses UTC time instead of local.
StoringNameSpecifies the stored name of the persistent scheduler control’s layout.
TagInherited from TComponent.
TimeBiasReturns the current UTC time offset.
UseActualTimeRangeSpecifies whether user events are retrieved based upon their time period bounds from the underlying data store.
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.
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.
CalculateEventActualTimeRangesPopulates the ActualStart and ActualFinish fields with the values of the user event‘s time period bounds.
CheckRequiredFields
ClearClears the scheduler storage component.
createEventCreates a user event with the default settings and adds the event to the storage component.
CreateOccurrence(TcxSchedulerEvent,TDateTime,TcxEventType)Creates occurrence of the APattern parent at the ADate date.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DoneRestore
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.
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.
FreeOnReleaseInherited from TComponent.
FullRefreshForces 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)
GetHashCodeInherited from TObject.
GetHolidayNamesByDate(TDate,string,Boolean)Populates a parameter with names of holidays taking place at a certain date.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GetReminderEvents(TDateTime,TcxSchedulerFilteredEventList)Populates the AList collection with in-memory user events containing reminders.
HasParentInherited from TComponent.
HolidaysChanged(TObject)
HolidaysRemoved(TObject)
InitRestore
InsertComponent(TComponent)Inherited from TComponent.
IsActiveIdentifies if the event persistence manager is ready for use by the associated scheduler control.
IsCaptionAvailable
IsEventEditing(TcxSchedulerControlEvent)
IsEventSharingAllowedIdentifies if the persistence manager can share an event between resources.
IsImplementorOf(IInterface)Inherited from TComponent.
IsLabelColorAvailableIdentifies if the persistence manager stores event label colors.
IsLocationAvailableIdentifies if the persistence manager stores information on event locations.
IsMessageAvailableIdentifies if the persistence manager stores user event descriptions.
IsRecurrenceAvailable
IsReminderAvailable
IsReminderByResourceAvailable
IsStateAvailableIdentifies if the persistence manager stores information on the event creator’s availability status.
LoadedInherited from TComponent.
Notification(TComponent,TOperation)Inherited from TComponent.
PopulateHolidayDates(TcxSchedulerDateList,TDate,TDate,Boolean,Boolean)Populates AList with holiday dates by the specified period.
PostEventsPublishes all newly created user events and updates content displayed in 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.
ToStringInherited from TObject.
UpdateAction(TBasicAction)Inherited from TComponent.

Events

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

See Also

TcxCustomSchedulerStorage Class

cxSchedulerStorage Unit