Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Collapse]ASP.NET WebForms Controls
  [Expand]Reporting
  [Expand]Chart Control
  [Expand]Grid View
  [Expand]Card View
  [Expand]Vertical Grid
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Image and Data Browsing
  [Expand]Docking and Popups
  [Expand]Site Navigation and Layout
  [Expand]File Management
  [Expand]Multi-Use Site Controls
  [Collapse]Scheduler
   [Expand]Product Information
    Getting Started
   [Expand]Fundamentals
   [Collapse]Concepts
    [Expand]Scheduler Elements
    [Collapse]Appointments
      What Is an Appointment
      Appointment Labels and Statuses
      Recurring Appointments and Exceptions
      Reminders for Appointments
    [Expand]Resources
    [Expand]Views
     Data Binding
    [Expand]Services
     Templates
     Client-Side Functionality
     Callback Commands
    [Expand]Reporting
     Time Zones
     Keyboard Shortcuts
   [Expand]Visual Elements
   [Expand]Design-Time Features
   [Expand]Examples
   [Expand]End-User Capabilities
   [Expand]Member Tables
  [Expand]HTML Editor
  [Expand]Pivot Grid
  [Expand]Tree List
  [Expand]Gauges
  [Expand]Data Editors
  [Expand]Spell Checker
  [Expand]Query Builder
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Reminders for Appointments

This document introduces the Reminder for Appointments concept, and describes how reminders can be created and handled. It contains a code sample to help you make the most of reminders in XtraScheduler.

Expanded Overview

Any appointment can have one or more reminders. They are responsible for sending alerts at specified time periods before an appointment's start time. If an appointment has a reminder, the image is displayed. The ASPxScheduler Suite provides an abstract ReminderBase class, which implements the basic reminder functionality and two derived classes - Reminder for appointments of AppointmentType.Normal type and RecurringReminder for appointments of a recurrence series.

Expanded Creating Reminders

A reminder can be created for a particular appointment either via code or with the help of appointment's editing form.

There are two methods for creating a reminder via code. The simplest one is the Appointment.HasReminder property - if an appointment has no reminders, and the HasReminder is set to true, then a new reminder with default parameters is created and associated with the appointment. If several reminders for an appointment are required, you should use another method. First, a new reminder is created via the Appointment.CreateNewReminder method. Then, after its characteristics are set, it should be added to the reminder's collection Appointment.Reminders of the particular appointment.

Expanded Using Reminders

To access the appointment's reminders, use the Appointment.Reminder property, which returns the first reminder in a collection (and the only one if it has been created via the Appointment.HasReminder property), or the Appointment.Reminders property, which gets the entire collection of reminders for an appointment.

When the time has come for the reminder to alert, it invokes the notification dialog, as illustrated below:

The end-user can switch the reminders off by clicking the "Dismiss" or "Dismiss All" buttons.

Another option is to shift the alert time by selecting the time interval in the combo box and clicking the "Snooze" button. Then, the notification will be postponed for a specified time.

Expanded Handling Outdated Appointments

  • If a reminder is set for an appointment of AppointmentType.Normal type, this outdated appointment generates an alert as usual (taking into account the SchedulerStorageBase.RemindersCheckInterval setting). You can use the SchedulerStorageBase.TriggerAlerts method to fire all reminders for outdated appointments at once, when application starts.
  • If a reminder is set for a recurrent appointment, the reminder never fires for an outdated occurrence. It appears reasonable because recurrence chains can be lengthy and even infinite.

Expanded Handling Reminders for Changed Occurrences

If an occurrence is in the future:

  • Once this occurrence is moved to the past, its reminder is deleted.
  • When this occurrence is restored and becomes located in the future, its reminder is restored and will persist until this occurrence becomes in the past again.
  • When this occurrence is restored and becomes in the past, the reminders are not restored.

If a recurring appointment is in the past (such occurrences do not have reminders):

  • Once the occurrence is moved to the future, its reminder is re-created from the pattern.
  • When the occurrence is restored and becomes in the past, the reminder is deleted.

Expanded Reminder Member Table

The following table lists the main properties, methods and events which implement Reminder basic functionality.

Member Name

Description

Availability
AppointmentStorageBase.SupportsReminders property Informs you whether the mapping for reminder info exists so the storage can operate with reminders (relevant for the bound mode).
SchedulerStorageBase.EnableReminders property Enables you to specify whether reminder operations are allowed.
SchedulerStorageBase.RemindersEnabled property Indicates whether reminders are enabled (supported AND allowed).
Appointment Information
Reminder.Appointment property Gets the appointment which the reminder is applied to.
Reminder.Subject property Gets the subject text of the appointment the reminder is applied to.
Alert Options
ReminderBase.AlertTime property Gets the reminder's alert time.
ReminderBase.TimeBeforeStart property Gets or sets the time interval before the appointment's start time.
Alert Handling
ASPxScheduler.ReminderAlert event. Occurs when a reminder is triggered.
ReminderBase.Dismiss method Switches the reminder off for the associated appointment.
ReminderBase.Snooze method Notifies the scheduler to defer the triggering of a reminder by the specified interval.
SchedulerStorageBase.RemindersCheckInterval property Gets or sets the time interval a reminder's alert time should be checked (in milliseconds).
SchedulerStorageBase.TriggerAlerts method Trigger alerts immediately.
Reminders Form
ASPxScheduler.RemindersFormShowing event Occurs before the Reminders form is displayed.
ASPxScheduler.RemindersFormDefaultAction event. Occurs when an end-user doesn't click the Dismiss or Snooze button on the Reminders Form, but simply closes it. The DevExpress.XtraScheduler.SchedulerOptionsBehaviorBase.RemindersFormDefaultAction property should be set to DevExpress.XtraScheduler.RemindersFormDefaultAction.Custom.
ASPxSchedulerOptionsForms.RemindersFormTemplateUrl property. Gets or sets a template location for the form used to edit an alert associated with the current appointment.

How would you rate this topic?​​​​​​​