SchedulerStorage.RemindersCheckInterval Property

Gets or sets the time interval between checks of the reminder alert time (in milliseconds).

Namespace: DevExpress.Xpf.Scheduler

Assembly: DevExpress.Xpf.Scheduler.v23.2.dll

NuGet Package: DevExpress.Wpf.Scheduler

Declaration

C#

public int RemindersCheckInterval { get; set; }

VB.NET

Public Property RemindersCheckInterval As Integer

Property Value

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

Remarks

Important

You are viewing documentation for the legacy WPF Scheduler control. If you’re starting a new project, we strongly recommend that you use a new control declared in the DevExpress.Xpf.Scheduling namespace. If you decide to upgrade an existing project in order to switch to the updated scheduler control, see the Migration Guidelines document.

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 SchedulerStorage.ReminderAlert event is fired.

C#

using System;
using System.Windows;
using DevExpress.XtraScheduler;
using DevExpress.Xpf.Scheduler.UI;
// ...

private void button1_Click(object sender, RoutedEventArgs e) {
    // Remove all appointments.
    schedulerControl1.Storage.AppointmentStorage.Clear();        

    // Add a new appointment with a reminder.
    schedulerControl1.Storage.AppointmentStorage.Add(CreateAppointmentWithReminder());

    // Set time interval to check for active reminders to 3 seconds.
    schedulerControl1.Storage.RemindersCheckInterval = 3000;
}

private Appointment CreateAppointmentWithReminder() {
    // Create a new appointment and set its properties.
    Appointment apt = new Appointment(DateTime.Today, TimeSpan.FromHours(1));
    apt.Subject = "Test appointment";
    apt.HasReminder = true;

    return apt;
}

private void SchedulerStorage_ReminderAlert(object sender, ReminderEventArgs e){
    RemindersForm form = new RemindersForm(schedulerControl1);
    form.OnReminderAlert(e.AlertNotifications);
}

VB.NET

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows
Imports DevExpress.XtraScheduler
Imports DevExpress.Xpf.Scheduler.UI
' ...

Private Sub button1_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    ' Remove all appointments.
    schedulerControl1.Storage.AppointmentStorage.Clear()

    ' Add a new appointment with a reminder.
    schedulerControl1.Storage.AppointmentStorage.Add(CreateAppointmentWithReminder())

    ' Set time interval to check for active reminders to 3 seconds.
    schedulerControl1.Storage.RemindersCheckInterval = 3000
End Sub

Private Function CreateAppointmentWithReminder() As Appointment
    ' Create a new appointment and set its properties.
    Dim apt As New Appointment(DateTime.Today, TimeSpan.FromHours(1))
    apt.Subject = "Test appointment"
    apt.HasReminder = True

    Return apt
End Function

Private Sub SchedulerStorage_ReminderAlert(ByVal sender As Object, _
                                           ByVal e As ReminderEventArgs)
    Dim form As New RemindersForm(schedulerControl1)
    form.OnReminderAlert(e.AlertNotifications)
End Sub

XAML

<dxsch:SchedulerControl Name="schedulerControl1">
    <dxsch:SchedulerControl.Storage>
        <dxsch:SchedulerStorage ReminderAlert="SchedulerStorage_ReminderAlert"/>
    </dxsch:SchedulerControl.Storage>
</dxsch:SchedulerControl>