Reminder Class
Represents a reminder for a non-recurring appointment.
Namespace: DevExpress.XtraScheduler
Assembly: DevExpress.XtraScheduler.v24.2.Core.dll
Declaration
Related API Members
The following members return Reminder objects:
Library | Related API Members |
---|---|
Cross-Platform Class Library | Appointment.CreateNewReminder() |
Appointment.Reminder | |
ISchedulerStorageBase.CreateReminder(Appointment) | |
ReminderAlertNotification.Reminder | |
ReminderCancelEventArgs.Reminder | |
SchedulerStorageBase.CreateReminder(Appointment) | |
WinForms Controls | CustomizeAppointmentFlyoutEventArgs.Reminder |
IAppointmentFlyoutData.Reminder | |
SchedulerDataStorage.CreateReminder(Appointment) | |
WPF Controls | SchedulerStorage.CreateReminder(Appointment) |
Remarks
Reminders are used to provide a notification of a future appointment. If an appointment has a reminder, the image is displayed. The Appointment.Reminder property provides access to a reminder.
The simplest way to add a reminder to an appointment is to set the Appointment.HasReminder property to true.
The associated appointment is returned by the Reminder.Appointment property. The time interval before the appointment’s start time is specified by the ReminderBase.TimeBeforeStart property. To obtain the reminder’s alert time use the ReminderBase.AlertTime property.
When an alert is fired, the SchedulerStorageBase.ReminderAlert event occurs. You can handle the SchedulerStorageBase.FilterReminderAlert event to prevent alerts for particular reminders (or for any reminder) from being fired.
To trigger all alerts, which are ready to fire, at one moment, call the SchedulerStorageBase.TriggerAlerts method.
The ReminderBase.Snooze method defers triggering a reminder by the specified interval. The ReminderBase.Dismiss method can be used to switch the reminder off.
For more information on reminders, see the Reminders for Appointments topic.