SchedulerStorageBase.RemindersCheckInterval Property

Gets or sets the time interval a reminder’s alert time should be checked (in milliseconds).

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.1.Core.Desktop.dll

NuGet Package: DevExpress.Scheduler.CoreDesktop

Declaration

C#

public int RemindersCheckInterval { get; set; }

VB.NET

Public Property RemindersCheckInterval As Integer

Property Value

Type	Description
Int32	An integer value which represents the time interval between checks of the reminder’s alert.

Remarks

By default all reminder alerts are checked by the scheduler storage every 15 seconds (15000 milliseconds), but your reminders can be checked more or less frequently. Set the RemindersCheckInterval property to another time interval value.

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/winforms-scheduler-create-appointments-on-reminder-alert

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

Implements

RemindersCheckInterval