Documentation

Class DesktopAlertManager

This class provides API for managing RadDesktopAlertcomponents.

Inheritance
System.Object
DesktopAlertManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class DesktopAlertManager

Properties

ActiveScreen

Gets an instance of the System.Windows.Forms.Screenclass that represents the screen onto which the DesktopAlertManager positions the alert popups.

Declaration
public Screen ActiveScreen { get; }
Property Value
System.Windows.Forms.Screen

Instance

Gets the only instance of the DesktopAlertManager class.

Declaration
public static DesktopAlertManager Instance { get; }
Property Value
DesktopAlertManager

Methods

AddAlert(RadDesktopAlert)

Registers an instance of the RadDesktopAlertand displays it on the screen according to its

Declaration
public void AddAlert(RadDesktopAlert alert)
Parameters
RadDesktopAlert alert

ContainsAlert(RadDesktopAlert)

Evaluates whether a given RadDesktopAlert is registered with the DesktopAlertManager.

Declaration
public bool ContainsAlert(RadDesktopAlert alert)
Parameters
RadDesktopAlert alert

The RadDesktopAlert to check.
Returns
System.Boolean

GetAlertPopupLocation(RadDesktopAlert)

Gets an instance of the System.Drawing.Pointstruct that represents the location of the current alert according to its screen position setting and the currently opened alerts.

Declaration
public Point GetAlertPopupLocation(RadDesktopAlert alert)
Parameters
RadDesktopAlert alert

An instance of the RadDesktopAlert class that represents the alert which position to define.
Returns
System.Drawing.Point

The evaluated position in screen coordinates.

GetRegisteredAlerts()

Gets an enumerator for the currently shown dekstop alerts.

Declaration
public IEnumerator<RadDesktopAlert> GetRegisteredAlerts()
Returns
System.Collections.Generic.IEnumerator<RadDesktopAlert>

RemoveAlert(RadDesktopAlert)

Unregisters a desktop alert from the manager.

Declaration
public void RemoveAlert(RadDesktopAlert alert)
Parameters
RadDesktopAlert alert

The alert to unregister.

SetActiveScreen(Screen)

Sets the active screen. The active screen is used to calculate the positioning of all desktop alerts.

Declaration
public void SetActiveScreen(Screen activeScreen)
Parameters
System.Windows.Forms.Screen activeScreen

An instance of the System.Windows.Forms.Screen class that is the active screen to set.

UpdateAlertsOrder()

Recalculates the location of all opened alerts based on their screen position.

Declaration
public void UpdateAlertsOrder()

Events

AlertAdded

Fires when an instance of the RadDesktopAlert class is registered with this DesktopAlertManager.

Declaration
public event DesktopAlertManagerEventHandler AlertAdded
Event Type
DesktopAlertManagerEventHandler

AlertRemoved

Fires when an instance of the RadDesktopAlert class is removed from this DesktopAlertManager.

Declaration
public event DesktopAlertManagerEventHandler AlertRemoved
Event Type
DesktopAlertManagerEventHandler

Extension Methods