Loading...

Class RadDesktopAlertManager

This class provides API for managing the RadDesktopAlert instances on the current screen position.

Inheritance
System.Object
RadDesktopAlertManager
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

public class RadDesktopAlertManager : Object

Constructors

RadDesktopAlertManager()

Initializes a new instance of the RadDesktopAlertManager class.

Declaration
public RadDesktopAlertManager()

RadDesktopAlertManager(AlertScreenPosition)

Initializes a new instance of the RadDesktopAlertManager class.

Declaration
public RadDesktopAlertManager(AlertScreenPosition screenPosition)
Parameters
AlertScreenPosition screenPosition

The position on the screen used to display the alerts on.

RadDesktopAlertManager(AlertScreenPosition, Double)

Initializes a new instance of the RadDesktopAlertManager class.

Declaration
public RadDesktopAlertManager(AlertScreenPosition screenPosition, double alertsDistance)
Parameters
AlertScreenPosition screenPosition

The position on the screen used to display the alerts on.
System.Double alertsDistance

Distance between the opened alerts.

RadDesktopAlertManager(AlertScreenPosition, Point)

Initializes a new instance of the RadDesktopAlertManager class.

Declaration
public RadDesktopAlertManager(AlertScreenPosition screenPosition, Point screenPositionOffset)
Parameters
AlertScreenPosition screenPosition

The position on the screen used to display the alerts on.
System.Windows.Point screenPositionOffset

Offset of the used screen position.

RadDesktopAlertManager(AlertScreenPosition, Point, Double)

Initializes a new instance of the RadDesktopAlertManager class.

Declaration
public RadDesktopAlertManager(AlertScreenPosition screenPosition, Point screenPositionOffset, double alertsDistance)
Parameters
AlertScreenPosition screenPosition

The position on the screen used to display the alerts on.
System.Windows.Point screenPositionOffset

Offset of the used screen position.
System.Double alertsDistance

Distance between the opened alerts.

Properties

AlertsDistance

Gets or sets the distance between the opened alerts.

Declaration
public double AlertsDistance { get; set; }
Property Value
System.Double

AlertsReorderAnimationDuration

Gets or sets duration in milliseconds of the animation used for updating the order of all instances of RadDesktopAlert.

Declaration
public int AlertsReorderAnimationDuration { get; set; }
Property Value
System.Int32

HideAnimation

Gets or sets the animation used for hiding all instances of RadDesktopAlert.

Declaration
public RadAnimation HideAnimation { get; set; }
Property Value
RadAnimation

ScreenPosition

Gets the position on the screen used to display all instances of RadDesktopAlert.

Declaration
public AlertScreenPosition ScreenPosition { get; }
Property Value
AlertScreenPosition

ShowAnimation

Gets or sets the animation used for showing all instances of RadDesktopAlert.

Declaration
public RadAnimation ShowAnimation { get; set; }
Property Value
RadAnimation

Methods

Attach(DependencyObject)

Attaches the current instance of RadDesktopAlertManager to the Window of the passed element. When attached to Window, the manager shows alerts on the current screen where the Window is located.

Declaration
public void Attach(DependencyObject element)
Parameters
System.Windows.DependencyObject element

CloseAlert(RadDesktopAlert, Boolean)

Unregisters a desktop alert from the manager and close it.

Declaration
public void CloseAlert(RadDesktopAlert alert, bool useAnimations = true)
Parameters
RadDesktopAlert alert

The alert to close.
System.Boolean useAnimations

Indicates whether the Close animation should be used. By default is True.

CloseAllAlerts(Boolean)

Unregisters all desktop alerts from the manager and close them.

Declaration
public void CloseAllAlerts(bool useAnimations = true)
Parameters
System.Boolean useAnimations

Indicates whether the Close animation should be used. By default is True.

ContainsAlert(RadDesktopAlert)

Evaluates whether a given RadDesktopAlert is registered with the RadDesktopAlertManager.

Declaration
public bool ContainsAlert(RadDesktopAlert alert)
Parameters
RadDesktopAlert alert

The RadDesktopAlert to check.
Returns
System.Boolean

True if RadDesktopAlert is present; otherwise, false.

Detach()

Detaches the current instance of RadDesktopAlertManager from Window. All alerts will be shown on the main monitor.

Declaration
public void Detach()

GetAllAlerts()

Gets a collection of all registered RadDesktopAlert instances with the RadDesktopAlertManager.

Declaration
public IEnumerable<RadDesktopAlert> GetAllAlerts()
Returns
System.Collections.Generic.IEnumerable<RadDesktopAlert>

ShowAlert(DesktopAlertParameters, Boolean)

Registers an instance of the RadDesktopAlert from the provided DesktopAlertParameters and displays it on the screen.

Declaration
public void ShowAlert(DesktopAlertParameters parameters, bool useAnimations = true)
Parameters
DesktopAlertParameters parameters

The alert to show.
System.Boolean useAnimations

Indicates whether the Show animation should be used. By default is True.

ShowAlert(RadDesktopAlert, Boolean)

Registers an instance of the RadDesktopAlert and displays it on the screen.

Declaration
public void ShowAlert(RadDesktopAlert alert, bool useAnimations = true)
Parameters
RadDesktopAlert alert

The alert to show.
System.Boolean useAnimations

Indicates whether the Show animation should be used. By default is True.

Extension Methods