ClassRadSchedulerReminder
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
RadSchedulerReminder()
Initializes a new instance of the RadSchedulerReminder class with default settings.
Declaration
public RadSchedulerReminder()Remarks
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.
RadSchedulerReminder(IContainer)
Initializes a new instance of the RadSchedulerReminder class and adds it to the specified container.
Declaration
public RadSchedulerReminder(IContainer container)Parameters
container
The container that will manage the component's lifetime.
Remarks
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
AssociatedScheduler
Gets or sets the RadScheduler control that this reminder component will monitor for appointments requiring reminder notifications.
Declaration
public RadScheduler AssociatedScheduler { get; set; }Property Value
EndReminderInterval
Gets or sets the end date and time of the interval during which the reminder component will monitor appointments for reminder notifications.
Declaration
[Browsable(false)]
public DateTime EndReminderInterval { get; set; }Property Value
StartReminderInterval
Gets or sets the start date and time of the interval during which the reminder component will monitor appointments for reminder notifications.
Declaration
[Browsable(false)]
public DateTime StartReminderInterval { get; set; }Property Value
Methods
AddAppointmentToBeReminded(IEvent)
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.
Declaration
protected virtual void AddAppointmentToBeReminded(IEvent appointment)Parameters
appointment
The appointment to add to the reminder tracking system.
Dispose(bool)
Releases managed resources used by the RadSchedulerReminder, including disconnecting from the associated scheduler and clearing all event subscriptions.
Declaration
protected override void Dispose(bool disposing)Parameters
disposing
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
GetDefaultOwner()
Gets the default owner window for displaying reminder dialogs, using the form that contains the associated RadScheduler.
Declaration
protected override IWin32Window GetDefaultOwner()Returns
The parent form of the associated scheduler, or null if no scheduler is associated or the scheduler is not on a form.
Overrides
StartReminder()
Starts the reminder monitoring process by adding all qualifying appointments from the associated scheduler and activating the reminder timer.
Declaration
public override void StartReminder()Overrides
StopReminder()
Stops the reminder monitoring process and clears all tracked reminder objects.
Declaration
public override void StopReminder()Overrides
UnwireAssociatedSchedulerEvents()
Disconnects event handlers from the previously associated scheduler's appointment collection to prevent memory leaks and unwanted event handling.
Declaration
protected virtual void UnwireAssociatedSchedulerEvents()Remarks
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.
WireAssociatedSchedulerEvents()
Connects event handlers to the currently associated scheduler's appointment collection to monitor appointment changes.
Declaration
protected virtual void WireAssociatedSchedulerEvents()