ClassRadReminder
Represents a reminder component that manages and displays reminder notifications for scheduler appointments.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
[TelerikToolboxCategory("Scheduler")]
public class RadReminder : Component, IComponent, IDisposableInheritance: objectMarshalByRefObjectComponentRadReminder
Derived Classes:
Implements:
Inherited Members
Constructors
RadReminder()
Initializes a new instance of the RadReminder class.
Declaration
public RadReminder()RadReminder(IContainer)
Initializes a new instance of the RadReminder class with the specified container.
Declaration
public RadReminder(IContainer container)Parameters
container
The container that the component will be added to.
Fields
Properties
ThemeName
Gets or sets the name of the theme.
Declaration
public string ThemeName { get; set; }Property Value
The name of the theme.
TimeInterval
Gets or sets the time interval that the reminder should check for new remind objects.
Declaration
public int TimeInterval { get; set; }Property Value
The time interval.
Methods
AddRemindObject(IRemindObject)
Adds a reminder object to the reminder collection.
Declaration
public virtual RadReminderBindableObject AddRemindObject(IRemindObject remindObject)Parameters
remindObject
The reminder object to add.
Returns
The RadReminderBindableObject that wraps the reminder object.
AddRemindObjects(List<IRemindObject>)
Adds multiple reminder objects to the reminder collection.
Declaration
public List<RadReminderBindableObject> AddRemindObjects(List<IRemindObject> remindObjects)Parameters
remindObjects
List<IRemindObject>
The list of reminder objects to add.
Returns
List<RadReminderBindableObject>
A list of RadReminderBindableObject instances that wrap the reminder objects.
ClearRemindObjects()
Clears the remind objects.
Declaration
public void ClearRemindObjects()ContainsRemindObject(IRemindObject)
Determines whether the reminder collection contains the specified reminder object.
Declaration
public virtual bool ContainsRemindObject(IRemindObject remindObject)Parameters
remindObject
The reminder object to locate in the collection.
Returns
true if the reminder collection contains the specified reminder object; otherwise, false.
Dispose(bool)
Releases the unmanaged resources used by the RadReminder and optionally releases the managed resources.
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 the alarm form.
Declaration
protected virtual IWin32Window GetDefaultOwner()Returns
The default owner window, or null if no owner is specified.
GetRemindObjects()
Gets all reminder objects currently in the reminder collection.
Declaration
public List<IRemindObject> GetRemindObjects()Returns
List<IRemindObject>
A list of all IRemindObject instances in the collection.
OnDataFormating(RadDueInArgs)
Raises the DataFormatting event.
Declaration
protected virtual void OnDataFormating(RadDueInArgs e)Parameters
e
The RadDueInArgs instance containing the event data.
OnItemOpened(RadOpenItemArgs)
Raises the ItemOpened event.
Declaration
protected virtual void OnItemOpened(RadOpenItemArgs e)Parameters
e
The RadOpenItemArgs instance containing the event data.
OnRemindObjectShown(RadShowRemindObjectArgs)
Raises the RemindObjectShown event.
Declaration
protected virtual void OnRemindObjectShown(RadShowRemindObjectArgs e)Parameters
e
The RadShowRemindObjectArgs instance containing the event data.
OnShowingAlarmForm(RadAlarmFormShowingEventArgs)
Raises the AlarmFormShowing event.
Declaration
protected virtual void OnShowingAlarmForm(RadAlarmFormShowingEventArgs args)Parameters
args
The RadAlarmFormShowingEventArgs instance containing the event data.
RemoveRemindObject(IRemindObject)
Removes a reminder object from the reminder collection.
Declaration
public virtual bool RemoveRemindObject(IRemindObject remindObject)Parameters
remindObject
The reminder object to remove.
Returns
true if the reminder object was successfully removed; otherwise, false.
ResetToDefaultAlarmForm()
Resets the alarm form to the default RadAlarmForm implementation.
Declaration
public void ResetToDefaultAlarmForm()ShowAlarmForm()
Shows the alarm form if it contains reminder objects that need to be displayed.
Declaration
protected virtual void ShowAlarmForm()StartReminder()
Starts the reminder.
Declaration
public virtual void StartReminder()TimerTick()
Checks for reminder objects that need to be displayed and shows the alarm form if necessary. This method is called on each timer tick to evaluate reminder notifications.
Declaration
protected virtual void TimerTick()Events
AlarmFormShowing
Occurs when the alarm form is about to be shown.
Declaration
public event EventHandler<RadAlarmFormShowingEventArgs> AlarmFormShowingEvent Value
DataFormatting
Occurs when data formatting is required for reminder display.
Declaration
public event EventHandler<RadDueInArgs> DataFormattingEvent Value
ItemOpened
Occurs when a reminder item is opened.
Declaration
public event EventHandler<RadOpenItemArgs> ItemOpenedEvent Value
RemindObjectShown
Occurs when a reminder object is shown.
Declaration
public event EventHandler<RadShowRemindObjectArgs> RemindObjectShownEvent Value