TcxSchedulerEvent Class

A persistent user event object in the scheduler control.

Declaration

delphi

TcxSchedulerEvent = class(
    TPersistent
)

Remarks

Each TcxSchedulerEvent object corresponds to a record in the relational data store (see the TcxSchedulerDBStorage ) or a persistent value in a non-relational data store (see the TcxSchedulerStorage ). A temporary in-memory user event object is represented by the TcxSchedulerControlEvent and mirrors the persistent TcxSchedulerEvent user event object. The TcxSchedulerEvent object is referenced by the TcxCustomSchedulerStorage.Events property.

To specify the start and end times of the user event use the Start and Finish (or Duration) properties.

The ActualStart and ActualFinish property values specify the date range in a query’s conditional clause. They define the user event’s lifetime if it is regular or the date range of the occurrences sequence if the user event is recurring.

If the user event lasts 24 hours then the AllDayEvent property should be used (the Finish or Duration property in this case will be ignored). If the user event is recurring use the RecurrenceInfo and RecurrenceIndex properties to specify recurrence’s details.

The following properties are essential to specify information on the user event:

The subject text (caption) (Caption).
The color (LabelColor).
The location (Location).
The description (Message).
The availability status (State).

Inheritance

TObject TPersistent TcxSchedulerEvent