RadReminder
| RELATED VIDEOS | |
|---|---|
|
Getting Started with RadSchedulerReminder In this video, you will learn how to notify users of upcoming appointments through the use of RadSchedulerReminder. |
 |
Overview
RadReminder is a component that reminds you of an object that you pass to it. This object should implement IRemindObject and depending on the values that you set in the implementation of the IRemindObject interface, RadReminder throws an event. When the event is fired, you can show an appropriate message to the user using RadDesktopAlert or another alert implementation of your choice.
Figure 1: RadReminder
Properties
TimeInterval: Determines the interval in which IRemindObject should be notified. The default value is 60000 milliseconds (a minute).
ThemeName: Determines the theme which should be applied to the alarm form.
Public Methods
StartReminder: Starts the reminder.
StopReminder: Stops the reminder.
ClearRemindObjects: Clear all reminder objects.
AddRemindObject: Adds an IRemindObject to the reminder and returns the RadReminderBindableObject.
AddRemindObjects: Adds IRemindObjects collection to the reminder and returns RadReminderBindableObjects.
RemoveRemindObject: Removes IRemindObject from the reminder.
GetRemindObjects: Returns all added IRemindObjects.
Protected Methods
- GetDefaultOwner: Returns the container form of the RadReminder events.
Events
AlarmFormShowing: This event is fired before the notification form is shown. RadAlarmFormShowingArgs are passed as a parameter of the event. You can use this event to replace the default notification form.
ItemOpened: This event is fired when the user tries to open the item from the notification form. RadOpenItemArgs are passed as a parameter of the event. These arguments contain the IRemindObject.
DataFormatting: This event is fired on each change of the DueIn property of the RadReminderBindableObject. DueInEventsArgs are passed as a parameter of the event. You can use this event to change the formatting of the DueIn that is represented on the notification form.
RemindObjectShown: This event is fired for each IRemindObject that the reminder should show. RadShowRemindObjectArgs are passed as a parameter of the event. They contain the IRemindObject that should be shown.
IRemindObject
The IRemindObject interface has the following properties that must be implemented in a descendant class.
Reminder: Gets or sets a time span value indicating how much time before the StartDateTime the reminder event should be raised.
Snoozed: Gets or sets a time span indicating the amount of time this reminder of this is snoozed for. If an appointment starts at 14:00 a reminder is set for 30min before the meeting the user can snooze this appointment for 10 minutes. This will result in another remind event being raised by RadReminder 20 minutes before the meeting.
Dismissed: Gets or sets a value indicating whether this reminder is dismissed.
Subject: Gets the subject of this remind object. This text is usually displayed when visualizing a reminder.
StartDateTime: Gets the start date time for this remind object. This is the time when the event this remind object is created for will actually start e.g., start of a meeting, doctor appointment, etc.
RemindId: Gets a unique identifier used for identifying the reminder.