OnReminders Event
See Also
- CalendarControl Control
- EnableReminders Method
- IsRemindersEnabled Method
- Calendar Reminders Collection
- Event Reminder Property
- Event ReminderMinutesBeforeStart Property
- CalendarReminder Object
- CalendarReminders Object
- Dismiss Method
- Snooze Method
- NextReminderTime Property
- DismissAll Method
- MinutesBeforeStart Property
- StartTime Property
- DoGetUpcomingEvents Event
Description
Occurs when reminders are enabled, disabled, snoozed, dismissed, or fired.
Syntax
Public Event OnReminders(ByVal Action As CalendarRemindersAction, ByVal Reminder As CalendarReminder)
Parameters
-
Action
Flag from the CalendarRemindersAction enumeration that indicates why the OnReminders event was fired. Possible values: -
xtpCalendarRemindersMonitoringStarted
Reminders were enabled via EnableReminders. -
xtpCalendarRemindersMonitoringStopped
Reminders were disabled via EnableReminders. -
xtpCalendarRemindersFire
A reminder has fired. This happens when the event's StartTime minus MinutesBeforeStart occurs on or before the current time. The reminder's NextReminderTime property indicates the next date and time the reminder will fire (if applicable). -
xtpCalendarReminderSnoozed
The reminder was snoozed using the Snooze method. -
xtpCalendarReminderDismissed
The reminder was dismissed using the Dismiss method. -
xtpCalendarReminderDismissedAll
All reminders were dismissed using the DismissAll method. -
Reminder
Reference to the CalendarReminder object that caused the OnReminders event to fire. This value will be null when Action is one of: - xtpCalendarRemindersMonitoringStarted
- xtpCalendarRemindersMonitoringStopped
- xtpCalendarReminderDismissedAll
Remarks
- The OnReminders event will not fire until reminders are enabled with the EnableReminders method.
- With reminders enabled, the event occurs automatically when a reminder is fired, dismissed, or snoozed.
- All calendar events have a Reminder property that can be used to set a reminder for the event. The MinutesBeforeStart and NextReminderTime properties indicate when the reminder will fire.
- Use IsRemindersEnabled to determine whether reminders are currently enabled.
- When a custom data provider is used, the DoGetUpcomingEvents event occurs immediately before OnReminders.
Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.