RadSchedulerReminder
Represents a specialized reminder component for RadScheduler that automatically monitors scheduler appointments and provides reminder notifications based on their reminder settings.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
[TelerikToolboxCategory("Scheduler")]
public class RadSchedulerReminder : RadReminder, IComponent, IDisposableInheritance: objectMarshalByRefObjectComponentRadReminderRadSchedulerReminder
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadSchedulerReminder class with default settings.
public RadSchedulerReminder()The constructor sets the default reminder interval to monitor appointments from the current date to the end of the current day. This provides immediate reminder functionality for today's appointments.
Initializes a new instance of the RadSchedulerReminder class and adds it to the specified container.
public RadSchedulerReminder(IContainer container)The container that will manage the component's lifetime.
This constructor is typically used in design-time scenarios where the component is added to a form or user control. The container automatically handles disposal when the parent container is disposed.
Properties
Gets or sets the RadScheduler control that this reminder component will monitor for appointments requiring reminder notifications.
public RadScheduler AssociatedScheduler { get; set; }Gets or sets the end date and time of the interval during which the reminder component will monitor appointments for reminder notifications.
[Browsable(false)]
public DateTime EndReminderInterval { get; set; }Gets or sets the start date and time of the interval during which the reminder component will monitor appointments for reminder notifications.
[Browsable(false)]
public DateTime StartReminderInterval { get; set; }Methods
Adds a specific appointment to the reminder tracking system, handling both simple appointments and recurring appointment series with their individual occurrences. For simple appointments, this method checks if the appointment's start time falls within the reminder interval and adds it to the tracking list if it has no recurrence rule. For recurring appointments, the method uses an OccurrenceEnumerator to generate all occurrences within the reminder interval and adds each occurrence individually. It also processes any exceptions to the recurrence pattern, ensuring that modified or cancelled occurrences are handled correctly. The method respects the dismissed status of appointments and will skip adding reminders for appointments that have been explicitly dismissed by the user.
protected virtual void AddAppointmentToBeReminded(IEvent appointment)The appointment to add to the reminder tracking system.
Releases managed resources used by the RadSchedulerReminder, including disconnecting from the associated scheduler and clearing all event subscriptions.
protected override void Dispose(bool disposing)true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Gets the default owner window for displaying reminder dialogs, using the form that contains the associated RadScheduler.
protected override IWin32Window GetDefaultOwner()The parent form of the associated scheduler, or null if no scheduler is associated or the scheduler is not on a form.
Overrides:
Starts the reminder monitoring process by adding all qualifying appointments from the associated scheduler and activating the reminder timer.
public override void StartReminder()Overrides:
Stops the reminder monitoring process and clears all tracked reminder objects.
public override void StopReminder()Overrides:
Disconnects event handlers from the previously associated scheduler's appointment collection to prevent memory leaks and unwanted event handling.
protected virtual void UnwireAssociatedSchedulerEvents()This method is called automatically when the AssociatedScheduler property is changed or when the component is disposed. It ensures proper cleanup of event subscriptions to prevent memory leaks and avoid handling events from schedulers that are no longer associated.
Connects event handlers to the currently associated scheduler's appointment collection to monitor appointment changes.
protected virtual void WireAssociatedSchedulerEvents()