ClassRadDesktopAlertManager
Provides management for desktop alerts, allowing registration, display, animation, and positioning of alerts on the screen. The class supports multiple constructors for customizing the alerts' screen position, offset, and distance between alerts. It includes animation functionalities for showing and hiding alerts, as well as customizing those animations' duration and behavior. The manager facilitates adding and removing alerts, controlling their visibility, and ensuring they are displayed in an organized manner according to user-defined settings. This class also manages alert positioning, enables attachment to specific windows for context-sensitive display, and provides functionality to detach alerts from those windows, restoring default behavior. The built-in event handling for alert windows allows for seamless interaction and management of alert lifecycle events.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.Navigation.dll
Syntax:
public class RadDesktopAlertManagerInheritance: objectRadDesktopAlertManager
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
screenPosition
The position on the screen used to display the alerts on.
RadDesktopAlertManager(AlertScreenPosition, Point)
Initializes a new instance of the RadDesktopAlertManager class.
Declaration
public RadDesktopAlertManager(AlertScreenPosition screenPosition, Point screenPositionOffset)Parameters
screenPosition
The position on the screen used to display the alerts on.
screenPositionOffset
Point
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
screenPosition
The position on the screen used to display the alerts on.
screenPositionOffset
Point
Offset of the used screen position.
alertsDistance
Distance between the opened alerts.
RadDesktopAlertManager(AlertScreenPosition, double)
Initializes a new instance of the RadDesktopAlertManager class.
Declaration
public RadDesktopAlertManager(AlertScreenPosition screenPosition, double alertsDistance)Parameters
screenPosition
The position on the screen used to display the alerts on.
alertsDistance
Distance between the opened alerts.
Properties
AlertsDistance
Gets or sets the distance between the opened alerts.
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
HideAnimation
Gets or sets the animation used for hiding all instances of RadDesktopAlert.
Declaration
public RadAnimation HideAnimation { get; set; }Property Value
ScreenPosition
Gets the position on the screen used to display all instances of RadDesktopAlert.
Declaration
public AlertScreenPosition ScreenPosition { get; }Property Value
ShowAnimation
Gets or sets the animation used for showing all instances of RadDesktopAlert.
Declaration
public RadAnimation ShowAnimation { get; set; }Property Value
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
element
DependencyObject
CloseAlert(RadDesktopAlert, bool)
Unregisters a desktop alert from the manager and close it.
Declaration
public void CloseAlert(RadDesktopAlert alert, bool useAnimations = true)Parameters
alert
The alert to close.
useAnimations
Indicates whether the Close animation should be used. By default is True.
CloseAllAlerts(bool)
Unregisters all desktop alerts from the manager and close them.
Declaration
public void CloseAllAlerts(bool useAnimations = true)Parameters
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
alert
The RadDesktopAlert to check.
Returns
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
ShowAlert(DesktopAlertParameters, bool)
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
parameters
The alert to show.
useAnimations
Indicates whether the Show animation should be used. By default is True.
ShowAlert(RadDesktopAlert, bool)
Registers an instance of the RadDesktopAlert and displays it on the screen.
Declaration
public void ShowAlert(RadDesktopAlert alert, bool useAnimations = true)Parameters
alert
The alert to show.
useAnimations
Indicates whether the Show animation should be used. By default is True.