ReminderEventArgs.AlertNotifications Property

Gets any reminders currently triggered.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.2.Core.dll

NuGet Packages: DevExpress.Scheduler.Core, DevExpress.WindowsDesktop.Scheduler.Core

Declaration

C#

public ReminderAlertNotificationCollection AlertNotifications { get; }

VB.NET

Public ReadOnly Property AlertNotifications As ReminderAlertNotificationCollection

Property Value

Type	Description
ReminderAlertNotificationCollection	A ReminderAlertNotificationCollection object which holds a collection of notifications.

Remarks

The SchedulerStorageBase.ReminderAlert event is raised when a reminder alert is invoked. Note that multiple reminders can trigger at the same time. Use the AlertNotifications property to access these reminders. Each notification is represented by a ReminderAlertNotification object.

Example

The following example demonstrates how to manually handle reminders and perform a custom action when the SchedulerStorageBase.ReminderAlert event is fired.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/custom-form-custom-fields-and-custom-actions-on-reminder-alert-e382

Form1.cs

    // Handle this event to perform a custom action when a reminder alert is fired.
    schedulerStorage1.ReminderAlert += SchedulerStorage1_ReminderAlert;
    // Specify the interval at which the reminder is polled for alert.
    schedulerStorage1.RemindersCheckInterval = checkInterval * 1000;
    // Hide the reminder alert window.
    schedulerControl1.OptionsBehavior.ShowRemindersForm = false;
private void SchedulerStorage1_ReminderAlert(object sender, ReminderEventArgs e) {
    // Create a new appointment.
    Appointment app = schedulerStorage1.CreateAppointment(AppointmentType.Normal);
    app.Subject = "Created on alert from appointment w/Price = " + e.AlertNotifications[0].ActualAppointment.CustomFields["CustomPrice"];
    app.Start = e.AlertNotifications[0].ActualAppointment.Start.AddHours(2);
    app.Duration = TimeSpan.FromHours(4);
    schedulerStorage1.Appointments.Add(app);

    // Modify the appointment for which the alert is triggered.
    e.AlertNotifications[0].ActualAppointment.LabelKey = 3;

    // Prevent the event from being fired one more time.
    e.AlertNotifications[0].ActualAppointment.Reminder.Dismiss();
}

Form1.vb

    ' Handle this event to perform a custom action when a reminder alert is fired.
    AddHandler schedulerStorage1.ReminderAlert, AddressOf SchedulerStorage1_ReminderAlert
    ' Specify the interval at which the reminder is polled for alert.
    schedulerStorage1.RemindersCheckInterval = checkInterval * 1000
    ' Hide the reminder alert window.
    schedulerControl1.OptionsBehavior.ShowRemindersForm = False
Private Sub SchedulerStorage1_ReminderAlert(ByVal sender As Object, ByVal e As ReminderEventArgs)
    ' Create a new appointment.
    Dim app As Appointment = schedulerStorage1.CreateAppointment(AppointmentType.Normal)
    app.Subject = "Created on alert from appointment w/Price = " + e.AlertNotifications(0).ActualAppointment.CustomFields("CustomPrice").ToString()
    app.Start = e.AlertNotifications(0).ActualAppointment.Start.AddHours(2)
    app.Duration = TimeSpan.FromHours(4)
    schedulerStorage1.Appointments.Add(app)

    ' Modify the appointment for which the alert is triggered.
    e.AlertNotifications(0).ActualAppointment.LabelKey = 3

    ' Prevent the event from being fired one more time.
    e.AlertNotifications(0).ActualAppointment.Reminder.Dismiss()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AlertNotifications 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#

show-alert-notifications-of-only-appointments-that-are-associated-with-the-current-user-e3212/CS/MainForm.cs#L25

for (int i = 0; i < e.AlertNotifications.Count; i++) {
    ReminderAlertNotification reminderAlertNotification = e.AlertNotifications[i];

how-to-use-reminders-on-a-web-form-without-the-scheduler-control-t190761/CS/T190761/StorageForm.aspx.cs#L68

void storage_ReminderAlert(object sender, ReminderEventArgs e) {
    ReminderAlertNotificationCollection reminders = e.AlertNotifications;
    ASPxCallback1.JSProperties["cpReminders"] = reminders;

VB.NET

show-alert-notifications-of-only-appointments-that-are-associated-with-the-current-user-e3212/VB/MainForm.vb#L35

For i As Integer = 0 To e.AlertNotifications.Count - 1
    Dim reminderAlertNotification As ReminderAlertNotification = e.AlertNotifications(i)

how-to-use-reminders-on-a-web-form-without-the-scheduler-control-t190761/VB/T190761/StorageForm.aspx.vb#L73

Private Sub storage_ReminderAlert(ByVal sender As Object, ByVal e As ReminderEventArgs)
    Dim reminders As ReminderAlertNotificationCollection = e.AlertNotifications
    ASPxCallback1.JSProperties("cpReminders") = reminders