TcxSchedulerReminders Class

The TcxSchedulerReminders class manages timed out reminders, and also allows the Reminders window to be invoked.

Declaration

TcxSchedulerReminders = class(
    TcxInterfacedPersistent,
    IcxFormatControllerListener,
    IcxFormatControllerListener2,
    IdxSkinSupport
)

Remarks

Any reminder that triggers is automatically added to the TcxSchedulerReminders collection.

The TcxSchedulerReminders class manages the Reminders window using the following interface:

The ShowReminderWindow method – opens the Reminders window.
The IsReminderWindowShown method – checks whether the Reminders window is open.
The HideReminderWindow method – closes the Reminders window.
The UseReminderWindow property– specifies whether the Reminders window alerts when a reminder triggers.
The ReminderWindow property – references the Reminders window instance when it’s initialized.
The ReminderWindowLookAndFeel property – specifies the Reminders window’s look and feel settings.
The OnGetReminderWindowCaption event – enables you to customize the Reminders window’s title.
The OnHideReminderWindow event – enables you to customize the behavior that occurs when the Reminders window is about to be closed.
The OnOpenEvent event – adds the Open Item button (if implemented) and for example allows the user event selected by an end-user in the Reminders window to be edited. This can be done by invoking the TcxCustomScheduler.EditEventUsingDialog method within the OnOpenEvent event handler when an end-user clicks the Open Item button.
The OnShowReminderWindow event – enables you to customize the behavior that occurs when the Reminders window is about to be opened.

Developers can build their own Reminders window by deriving from the TcxSchedulerCustomReminderForm class.

The TcxSchedulerReminders class also enables the default settings of the Reminder check and combo boxes in the Event dialog to be managed:

The DefaultMinutesBeforeStart property – specifies the reminder time as the default value of the Reminder combo box, which is located in the Event dialog. The Reminder combo box’s value is in effect if the Reminder check box is enabled;
The DefaultReminder property – specifies whether the Reminder check box (located in the Event dialog) is selected by default.

The TcxSchedulerReminders class implements common reminder operations:

The Active property – specifies whether a reminder triggers when its time is up.
The DismissAll method – cancels all the reminders which are currently stored in the collection of the associated user events and removes these reminders from the collection.
The SnoozeAll method – notifies the scheduler to defer triggering of all the reminders which are currently stored in the collection for the specified interval.
The OnAlertReminder event – allows the behavior that occurs when a reminder is about to trigger to be customized.
The OnDismissReminder event – allows the behavior that occurs when a reminder is about to be dismissed to be customized.
The OnSnoozeReminder event – allows the behavior that occurs when a reminder is about to be snoozed to be customized.

And the following part of the TcxSchedulerReminders‘s interface allows basic operations to be performed on the reminders collection:

The Count property – gets a count of the reminders, which are currently stored in the collection.
The Items property – provides indexed access to the reminders, which are currently stored in the collection.
The HasReminders method – checks if there are reminders in the collection.
The Refresh method – updates the TcxSchedulerReminders collection.
The IsLocked method – checks whether the TcxSchedulerReminders collection can be updated.