ClassRadToastNotificationManager
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:
Inherited Members
Constructors
RadToastNotificationManager()
Initializes a new instance of the RadToastNotificationManager class.
Declaration
public RadToastNotificationManager()RadToastNotificationManager(IContainer)
Initializes a new instance of the RadToastNotificationManager class with the specified container.
Declaration
public RadToastNotificationManager(IContainer container)Parameters
container
The container to add the component to.
Properties
ToastNotifications
Gets or sets a collection of initialized toast notifications that can be shown by the manager.
Declaration
[Browsable(true)]
[TypeConverter(typeof(CollectionConverter))]
public RadToastNotificationCollection ToastNotifications { get; set; }Property Value
Methods
AddScheduledNotification(RadToastNotification)
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).
Declaration
public void AddScheduledNotification(RadToastNotification radToastNotification)Parameters
radToastNotification
The RadToastNotification that will be scheduled for future display.
Dispose(bool)
Clean up any resources being used.
Declaration
protected override void Dispose(bool disposing)Parameters
disposing
true if managed resources should be disposed; otherwise, false.
Overrides
HideNotification()
Hides the most recently displayed toast notification that is currently visible.
Declaration
public void HideNotification()RemoveScheduledNotification(string)
Removes a previously scheduled notification that has not yet been displayed. The notification is identified by the unique Tag assigned when it was scheduled.
Declaration
public void RemoveScheduledNotification(string tag)Parameters
tag
The unique tag that identifies the scheduled notification to remove.
ShowNotification(RadToastNotification)
Shows a given toast notification immediately.
Declaration
public void ShowNotification(RadToastNotification radToastNotification)Parameters
radToastNotification
The RadToastNotification instance that will be displayed.
ShowNotification(int)
Shows a notification from the ToastNotifications collection using its index.
Declaration
public void ShowNotification(int index)Parameters
index
The zero-based index of the notification to display.
ShowNotification(string)
Shows a notification from the ToastNotifications collection using its name.
Declaration
public void ShowNotification(string name)Parameters
name
The unique name of the notification to display.
Unregister()
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.
Declaration
public void Unregister()UpdateNotification(string, IDictionary<string, string>)
Updates a displayed notification based on its unique tag with new binding data.
Declaration
public void UpdateNotification(string tag, IDictionary<string, string> bindingData)Parameters
tag
The unique Tag that identifies the notification to update.
bindingData
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
RadToastOnActivated
Occurs when a user interacts with a toast notification by clicking on it or its action buttons.
Declaration
public static event RadToastOnActivatedEventHandler RadToastOnActivatedEvent Value