Class RadToastNotificationManager

Manages toast notifications creation, display, scheduling, and dismissal for Windows desktop applications.

Inheritance
System.Object
RadToastNotificationManager
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RadToastNotification.dll

Syntax

public class RadToastNotificationManager : Component

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
System.ComponentModel.IContainer 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
public RadToastNotificationCollection ToastNotifications { get; set; }
Property Value
RadToastNotificationCollection

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 radToastNotification

The RadToastNotification that will be scheduled for future display.

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.

HideNotification()

Hides the most recently displayed toast notification that is currently visible.

Declaration
public void HideNotification()

OnRadToastActivated(String, Dictionary<String, String>, String)

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. Activator is no longer needed. We suggest using the new RadToastOnActivated event instead.")]
public static void OnRadToastActivated(string arguments, Dictionary<string, string> userInput, string appUserModelId)
Parameters
System.String arguments

The arguments passed from the toast notification.
System.Collections.Generic.Dictionary<System.String, System.String> userInput

The user input collected from the toast notification.
System.String appUserModelId

The application model ID.

Register()

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. Registration is no longer needed.")]
public void Register()

Register(String, String, String)

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. Registration is no longer needed.")]
public void Register(string exePath, string shortcutName, string aumid)
Parameters
System.String exePath

The path of the executable
System.String shortcutName

A name of the shortcut that will be placed in start menu.
System.String aumid

Unique id of the application - recommended string - name + GUID.

Register<T>()

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. Registration is no longer needed.")]
public void Register<T>()
    where T : RadToastNotificationActivatorBase, new()
Type Parameters
T

An activator that receives notification activations. Must inherit RadToastNotificationActivatorBase.

Register<T>(String, String, String)

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. Registration is no longer needed.")]
public void Register<T>(string exePath, string shortcutName, string aumid)
    where T : RadToastNotificationActivatorBase, new()
Parameters
System.String exePath

The path of the executable
System.String shortcutName

A name of the shortcut that will be placed in start menu.
System.String aumid

Unique id of the application - recommended string - name + GUID.
Type Parameters
T

An activator that receives notification activations. Must inherit RadToastNotificationActivatorBase.

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
System.String tag

The unique tag that identifies the scheduled notification to remove.

ShowNotification(Int32)

Shows a notification from the ToastNotifications collection using its index.

Declaration
public void ShowNotification(int index)
Parameters
System.Int32 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
System.String name

The unique name of the notification to display.

ShowNotification(RadToastNotification)

Shows a given toast notification immediately.

Declaration
public void ShowNotification(RadToastNotification radToastNotification)
Parameters
RadToastNotification radToastNotification

The RadToastNotification instance that will be displayed.

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()

Unregister(String, String)

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. We suggest using only Unregister().")]
public void Unregister(string shortcutName, string aumid)
Parameters
System.String shortcutName

A name of the shortcut that will be removed.
System.String aumid

Unique id of the application.

Unregister<T>()

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. We suggest using only Unregister().")]
public void Unregister<T>()
    where T : RadToastNotificationActivatorBase, new()
Type Parameters
T

The registered activator. Must inherit RadToastNotificationActivatorBase.

Unregister<T>(String, String)

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This method is deprecated. We suggest using only Unregister().")]
public void Unregister<T>(string shortcutName, string aumid)
    where T : RadToastNotificationActivatorBase, new()
Parameters
System.String shortcutName

A name of the shortcut that will be removed.
System.String aumid

Unique id of the application.
Type Parameters
T

The registered activator. Must inherit RadToastNotificationActivatorBase.

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
System.String tag

The unique Tag that identifies the notification to update.
System.Collections.Generic.IDictionary<System.String, System.String> 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

RadToastActivated

This property/method/event is not relevant for this class.

Declaration
[Obsolete("This event is deprecated. We suggest using the new RadToastOnActivated event instead.")]
public static event RadToastActivatedEventHandler RadToastActivated
Event Type
RadToastActivatedEventHandler

RadToastOnActivated

Occurs when a user interacts with a toast notification by clicking on it or its action buttons.

Declaration
public static event RadToastOnActivatedEventHandler RadToastOnActivated
Event Type
RadToastOnActivatedEventHandler

Extension Methods