TcxCustomSchedulerStorage.UseActualTimeRange Property

Specifies whether user events are retrieved based upon their time period bounds from the underlying data store.

Declaration

property UseActualTimeRange: Boolean read; write; default False;

Type	Default
Boolean	False

Along with other information on the scheduled user event, time period bounds are persisted in a data store (see the TcxSchedulerEvent.ActualStart, TcxSchedulerEvent.ActualFinish, TcxSchedulerDBStorageFieldNames.ActualStart and TcxSchedulerDBStorageFieldNames.ActualFinish properties) since ExpressScheduler 2 was released.

Depending upon whether the user event is regular or recurring the time period has two meanings:

The period of time that the user event lasts for if this event is regular. Time period bounds are the same as the TcxSchedulerEvent.Start and TcxSchedulerEvent.Finish property values (see the TcxSchedulerDBStorageFieldNames.Start and TcxSchedulerDBStorageFieldNames.Finish properties).
The time range of the reoccurrences chain if the user event is recurring. This time range is defined as the first occurrence’s start date and the last occurrence’s end date.

Set the UseActualTimeRange property to True to use time period bounds when querying the data store. It can improve performance.

Note

if the UseActualTimeRange property is set to True, then user events, which have no time period bounds (legacy user events that were scheduled prior to the ExpressScheduler 2 release), won’t appear in the scheduling area. To avoid this use the CalculateEventActualTimeRanges method to populate the ActualStart and ActualFinish fields (see the TcxSchedulerDBStorageFieldNames.ActualStart and TcxSchedulerDBStorageFieldNames.ActualFinish properties) in the underlying data store with appropriate values.

The default value of the UseActualTimeRange property is False.