ReminderEventArgs Class

Provides data for the SchedulerStorageBase.ReminderAlert event.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.1.Core.dll

Declaration

C#

public class ReminderEventArgs :
    ReminderBaseEventArgs

VB.NET

Public Class ReminderEventArgs
    Inherits ReminderBaseEventArgs

Related API Members

ReminderEventArgs is the data class for the following events:

Library	Related API Members
Cross-Platform Class Library	ISchedulerStorageBase.ReminderAlert
	SchedulerStorageBase.ReminderAlert
WinForms Controls	SchedulerDataStorage.ReminderAlert
WPF Controls	SchedulerStorage.ReminderAlert
ASP.NET Web Forms Controls	ASPxSchedulerDataWebControlBase.ReminderAlert
	ASPxSchedulerStorage.ReminderAlert

Remarks

The SchedulerStorageBase.ReminderAlert event occurs when a reminder alert is invoked. The ReminderEventArgs class introduces the ReminderEventArgs.AlertNotifications property that specifies the collection for all the reminder’s notifications.

An instance of the ReminderEventArgs class with appropriate settings is automatically created and passed to the corresponding event’s handler.

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 ReminderEventArgs class.

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#L23

private void schedulerStorage1_ReminderAlert(object sender, ReminderEventArgs e) {
    for (int i = 0; i < e.AlertNotifications.Count; i++) {

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

void storage_ReminderAlert(object sender, ReminderEventArgs e) {
    ReminderAlertNotificationCollection reminders = e.AlertNotifications;

how-to-handle-the-remindersformshowing-event-and-invoke-the-reminder-form-manually-e3000/CS/RemindersFormExample/Form1.cs#L43

RemindersForm remindersForm = new RemindersForm((SchedulerControl)sender);
ReminderEventArgs args = new ReminderEventArgs(alerts);
remindersForm.FormClosed += new FormClosedEventHandler(remindersForm_FormClosed);

custom-form-custom-fields-and-custom-actions-on-reminder-alert-e382/CS/ReminderCustomActions/Form1.cs#L47

#region #reminderalert
private void SchedulerDataStorage1_ReminderAlert(object sender, ReminderEventArgs e) {
    // Create a new appointment.

how-to-customize-the-appointment-dialog-using-view-model-api-t582018/CS/DevExpressMvcApplication1/Models/SchedulerDataHelper.cs#L152

static void Storage_ReminderAlert(object sender, ReminderEventArgs e) {

VB.NET

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

Private Sub schedulerStorage1_ReminderAlert(ByVal sender As Object, ByVal e As ReminderEventArgs) Handles schedulerStorage1.ReminderAlert
    For i As Integer = 0 To e.AlertNotifications.Count - 1

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

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

how-to-handle-the-remindersformshowing-event-and-invoke-the-reminder-form-manually-e3000/VB/RemindersFormExample/Form1.vb#L41

Dim remindersForm As New RemindersForm(DirectCast(sender, SchedulerControl))
Dim args As New ReminderEventArgs(alerts)
AddHandler remindersForm.FormClosed, AddressOf remindersForm_FormClosed

custom-form-custom-fields-and-custom-actions-on-reminder-alert-e382/VB/ReminderCustomActions/Form1.vb#L49

#Region "#reminderalert"
Private Sub SchedulerDataStorage1_ReminderAlert(ByVal sender As Object, ByVal e As ReminderEventArgs)
    ' Create a new appointment.

how-to-customize-the-appointment-dialog-using-view-model-api-t582018/VB/DevExpressMvcApplication1/Models/SchedulerDataHelper.vb#L173

Private Shared Sub Storage_ReminderAlert(ByVal sender As Object, ByVal e As ReminderEventArgs)

Inheritance

Object

EventArgs

ReminderBaseEventArgs

ReminderEventArgs

RemindersFormDefaultActionEventArgs