Manages toast notifications creation, display, scheduling, and dismissal for Windows desktop applications.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.RadToastNotification.dll
Syntax:
public class RadToastNotificationManager : Component, IComponent, IDisposableInheritance: objectMarshalByRefObjectComponentRadToastNotificationManager
Implements:
Constructors
Initializes a new instance of the RadToastNotificationManager class.
public RadToastNotificationManager()Initializes a new instance of the RadToastNotificationManager class with the specified container.
public RadToastNotificationManager(IContainer container)The container to add the component to.
Properties
Gets or sets a collection of initialized toast notifications that can be shown by the manager.
[Browsable(true)]
[TypeConverter(typeof(CollectionConverter))]
public RadToastNotificationCollection ToastNotifications { get; set; }Methods
Schedules a toast notification to be displayed at a future time specified by DeliveryTime. To enable later removal of the scheduled notification, assign a unique Tag which can be used with RemoveScheduledNotification(string).
public void AddScheduledNotification(RadToastNotification radToastNotification)The RadToastNotification that will be scheduled for future display.
Clean up any resources being used.
protected override void Dispose(bool disposing)true if managed resources should be disposed; otherwise, false.
Overrides:
Hides the most recently displayed toast notification that is currently visible.
public void HideNotification()Removes a previously scheduled notification that has not yet been displayed. The notification is identified by the unique Tag assigned when it was scheduled.
public void RemoveScheduledNotification(string tag)The unique tag that identifies the scheduled notification to remove.
Shows a notification from the ToastNotifications collection using its index.
public void ShowNotification(int index)The zero-based index of the notification to display.
Shows a given toast notification immediately.
public void ShowNotification(RadToastNotification radToastNotification)The RadToastNotification instance that will be displayed.
Shows a notification from the ToastNotifications collection using its name.
public void ShowNotification(string name)The unique name of the notification to display.
Cleans up resources used by the Toast Notification Manager and removes all displayed notifications. Calling this will clear notifications in the action center as well. Call this when the program exits or during uninstallation. Must be called from the same executable that displayed the toast notifications.
public void Unregister()Updates a displayed notification based on its unique tag with new binding data.
public void UpdateNotification(string tag, IDictionary<string, string> bindingData)The unique Tag that identifies the notification to update.
bindingDataIDictionary<string, string>Key-value pairs that will update the notification's content. The key is the binding parameter name and the value is the new content to display.
Events
Occurs when a user interacts with a toast notification by clicking on it or its action buttons.
public static event RadToastOnActivatedEventHandler RadToastOnActivated