Class
RadToastNotification

Represents a toast notification that can be displayed to the user, providing customizable content, templates, and delivery options for desktop notifications.

Definition

Namespace:Telerik.RadToastNotificationManager

Assembly:Telerik.WinControls.RadToastNotification.dll

Syntax:

cs-api-definition
public class RadToastNotification : INotifyPropertyChanged

Inheritance: objectRadToastNotification

Implements: INotifyPropertyChanged

Constructors

RadToastNotification()

Initializes a new instance of the RadToastNotification class with a generic template type and a randomly generated unique name identifier.

Declaration

cs-api-definition
public RadToastNotification()

RadToastNotification(RadToastNotification)

Initializes a new instance of the RadToastNotification class by creating a copy of an existing notification with identical properties.

Declaration

cs-api-definition
public RadToastNotification(RadToastNotification toastNotification)

Parameters

toastNotification

RadToastNotification

The source RadToastNotification instance to copy properties from.

RadToastNotification(RadToastTemplateType, string)

Initializes a new instance of the RadToastNotification class with the specified template type and unique name, using the default XML template for the template type.

Declaration

cs-api-definition
public RadToastNotification(RadToastTemplateType type, string name)

Parameters

type

RadToastTemplateType

The RadToastTemplateType that defines the notification's layout and visual structure.

name

string

The unique identifier name for the notification, which must not be null or empty.

RadToastNotification(RadToastTemplateType, string, string)

Initializes a new instance of the RadToastNotification class with the specified template type, unique name, and custom XML content for advanced notification customization.

Declaration

cs-api-definition
public RadToastNotification(RadToastTemplateType type, string name, string xml)

Parameters

type

RadToastTemplateType

The RadToastTemplateType that defines the notification's layout structure.

name

string

The unique identifier name for the notification, which must not be null or empty.

xml

string

The custom XML content that defines the structure and content of the notification body.

Properties

BindingData

Gets or sets the binding data as key-value pairs for template parameter substitution, where the key represents the binding parameter name and the value contains the replacement content.

Declaration

cs-api-definition
public IDictionary<string, string> BindingData { get; set; }

Property Value

IDictionary<string, string>

DeliveryTime

Gets or sets the scheduled delivery time for the toast notification, allowing notifications to be displayed at a specific future time.

Declaration

cs-api-definition
public DateTimeOffset DeliveryTime { get; set; }

Property Value

DateTimeOffset

Name

Gets or sets a unique identifier name for the RadToastNotification that can be used for identification and management within a RadToastNotificationCollection.

Declaration

cs-api-definition
public string Name { get; set; }

Property Value

string

Tag

Gets or sets the unique tag identifier for this notification, enabling updates or replacement of existing notifications with the same tag.

Declaration

cs-api-definition
public string Tag { get; set; }

Property Value

string

TemplateType

Gets or sets the template type that defines the layout and visual structure of the RadToastNotification.

Declaration

cs-api-definition
public RadToastTemplateType TemplateType { get; set; }

Property Value

RadToastTemplateType

Xml

Gets or sets the XML content that defines the structure, layout, and content of the RadToastNotification body.

Declaration

cs-api-definition
public string Xml { get; set; }

Property Value

string

Events

PropertyChanged

Occurs when a property value changes, providing notification of property modifications for data binding and change tracking scenarios.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged