ReminderItem.AlertTime Property

Gets or sets the date and time for firing an alert.

Namespace: DevExpress.Xpf.Scheduling

Assembly: DevExpress.Xpf.Scheduling.v18.2.dll

Declaration

C#

public DateTime AlertTime { get; set; }

VB.NET

Public Property AlertTime As Date

Property Value

Type	Description
DateTime	A DateTime object which specifies the reminder’s alert time.

Remarks

When the time specified by the AlertTime property arrives, the reminder is added to the SchedulerControl.TriggeredReminders collection, the SchedulerControl.RemindersWindowShowing event occurs and the Recurrence Window dialog is invoked.

Default value of the AlertTime property is calculated as follows:

ReminderItem.AlertTime = AppointmentItem.Start - ReminderItem.TimeBeforeStart.

However, you can set the AlertTime value explicitly in code. In this situation, the ReminderItem.TimeBeforeStart value remains unchanged and the formula does not apply.

Note

The ReminderItem.AlertTime value determines when to fire an alert. The ReminderItem.TimeBeforeStart value is displayed and set in the Recurrence Window dialog.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-reminders-in-code-and-use-a-custom-window-to-handle-alerts-t555815.

MainWindow.xaml.cs

// Remove previous reminders
appointment.Reminders.Clear();
// Set multiple reminders for an appointment
ReminderItem reminder1 = appointment.CreateNewReminder();
ReminderItem reminder2 = appointment.CreateNewReminder();
reminder1.AlertTime = DateTime.Now.AddMinutes(15);
reminder2.TimeBeforeStart = new TimeSpan(0, 30, 0);

appointment.Reminders.Add(reminder1);
appointment.Reminders.Add(reminder2);

MainWindow.xaml.vb

' Remove previous reminders
appointment.Reminders.Clear()
' Set multiple reminders for an appointment
Dim reminder1 As ReminderItem = appointment.CreateNewReminder()
Dim reminder2 As ReminderItem = appointment.CreateNewReminder()
reminder1.AlertTime = Date.Now.AddMinutes(15)
reminder2.TimeBeforeStart = New TimeSpan(0, 30, 0)

appointment.Reminders.Add(reminder1)
appointment.Reminders.Add(reminder2)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AlertTime property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-reminders-in-code-and-use-a-custom-window-to-handle-alerts-t555815/CS/CustomReminderExample/MainWindow.xaml.cs#L54

ReminderItem reminder2 = appointment.CreateNewReminder();
reminder1.AlertTime = DateTime.Now.AddMinutes(15);
reminder2.TimeBeforeStart = new TimeSpan(0, 30, 0);

VB.NET

how-to-create-reminders-in-code-and-use-a-custom-window-to-handle-alerts-t555815/VB/CustomReminderExample/MainWindow.xaml.vb#L59

Dim reminder2 As ReminderItem = appointment.CreateNewReminder()
reminder1.AlertTime = Date.Now.AddMinutes(15)
reminder2.TimeBeforeStart = New TimeSpan(0, 30, 0)