RadReminder
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:
Constructors
Initializes a new instance of the RadReminder class.
public RadReminder()Initializes a new instance of the RadReminder class with the specified container.
public RadReminder(IContainer container)The container that the component will be added to.
Fields
protected IAlarmForm alarmFormProperties
Gets or sets the name of the theme.
public string ThemeName { get; set; }The name of the theme.
Gets or sets the time interval that the reminder should check for new remind objects.
public int TimeInterval { get; set; }The time interval.
Methods
Adds a reminder object to the reminder collection.
public virtual RadReminderBindableObject AddRemindObject(IRemindObject remindObject)The reminder object to add.
Returns:The RadReminderBindableObject that wraps the reminder object.
Adds multiple reminder objects to the reminder collection.
public List<RadReminderBindableObject> AddRemindObjects(List<IRemindObject> remindObjects)The list of reminder objects to add.
Returns:List<RadReminderBindableObject>
A list of RadReminderBindableObject instances that wrap the reminder objects.
Clears the remind objects.
public void ClearRemindObjects()Determines whether the reminder collection contains the specified reminder object.
public virtual bool ContainsRemindObject(IRemindObject remindObject)The reminder object to locate in the collection.
Returns:true if the reminder collection contains the specified reminder object; otherwise, false.
Releases the unmanaged resources used by the RadReminder and optionally releases the managed resources.
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 the alarm form.
protected virtual IWin32Window GetDefaultOwner()The default owner window, or null if no owner is specified.
Gets all reminder objects currently in the reminder collection.
public List<IRemindObject> GetRemindObjects()List<IRemindObject>
A list of all IRemindObject instances in the collection.
Raises the DataFormatting event.
protected virtual void OnDataFormating(RadDueInArgs e)The RadDueInArgs instance containing the event data.
Raises the ItemOpened event.
protected virtual void OnItemOpened(RadOpenItemArgs e)The RadOpenItemArgs instance containing the event data.
Raises the RemindObjectShown event.
protected virtual void OnRemindObjectShown(RadShowRemindObjectArgs e)The RadShowRemindObjectArgs instance containing the event data.
Raises the AlarmFormShowing event.
protected virtual void OnShowingAlarmForm(RadAlarmFormShowingEventArgs args)The RadAlarmFormShowingEventArgs instance containing the event data.
Removes a reminder object from the reminder collection.
public virtual bool RemoveRemindObject(IRemindObject remindObject)The reminder object to remove.
Returns:true if the reminder object was successfully removed; otherwise, false.
Resets the alarm form to the default RadAlarmForm implementation.
public void ResetToDefaultAlarmForm()Shows the alarm form if it contains reminder objects that need to be displayed.
protected virtual void ShowAlarmForm()Starts the reminder.
public virtual void StartReminder()Stops the reminder.
public virtual void StopReminder()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.
protected virtual void TimerTick()Events
Occurs when the alarm form is about to be shown.
public event EventHandler<RadAlarmFormShowingEventArgs> AlarmFormShowingOccurs when data formatting is required for reminder display.
public event EventHandler<RadDueInArgs> DataFormattingOccurs when a reminder item is opened.
public event EventHandler<RadOpenItemArgs> ItemOpenedOccurs when a reminder object is shown.
public event EventHandler<RadShowRemindObjectArgs> RemindObjectShown