Documentation

Class RadDesktopAlert

This class represents a Desktop Alert component which can be used to display a small window on the screen to notify the user that an event occurred. The location of the window and the way it appears can be customized.

Inheritance
System.Object
DisposableObject
RadObject
RadComponent
RadDesktopAlert
Inherited Members
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 RadDesktopAlert : RadComponent, INotifyPropertyChanged, ICustomTypeDescriptor, IComponent, IDisposable

Constructors

RadDesktopAlert()

Creates an instance of the RadDesktopAlert class.

Declaration
public RadDesktopAlert()

RadDesktopAlert(IContainer)

Creates an instance of the RadDesktopAlert class.

Declaration
public RadDesktopAlert(IContainer container)
Parameters
System.ComponentModel.IContainer container

An implementation of the System.ComponentModel.IContainer interface that holds this instance.

Properties

AutoClose

Gets a sets a boolean value determining whether the alert popup will be automatically closed after a given amount of time.

Declaration
public bool AutoClose { get; set; }
Property Value
System.Boolean

AutoCloseDelay

Gets or sets the amount of time in seconds after which the alert will be automatically closed.

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

AutoSize

Gets or sets a value indicating whether the control is automatically resized by Height to display its entire contents.

Declaration
public virtual bool AutoSize { get; set; }
Property Value
System.Boolean

ButtonItems

Gets or sets the items collection containing the button items shown at the bottom part of the desktop alert's popup.

Declaration
public RadItemCollection ButtonItems { get; }
Property Value
RadItemCollection

CanMove

Gets or sets a boolean value determining whether the popup can be moved by dragging the caption grip.

Declaration
public bool CanMove { get; set; }
Property Value
System.Boolean

CaptionText

Gets or sets the alert's caption text. The caption text is displayed below the moving grip of the alert's popup.

Declaration
public string CaptionText { get; set; }
Property Value
System.String

ContentImage

Gets or sets the content image of the RadDesktopAlert.

Declaration
public Image ContentImage { get; set; }
Property Value
System.Drawing.Image

ContentText

Gets or sets the text displayed in the alert popup. This text can be additionally HTML formatted to achieve better appearance.

Declaration
public string ContentText { get; set; }
Property Value
System.String

DpiScaleElement

This element is used for the sole purpose of storing the current DPI scale.

Declaration
public RadElement DpiScaleElement { get; }
Property Value
RadElement

FadeAnimationFrames

Gets or sets the count of animation frames for the fade animation.

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

FadeAnimationSpeed

Gets or sets the interval in milliseconds between two animation frames.

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

FadeAnimationType

Gets or sets a value from the FadeAnimationType enumerator that determines the type of fade animation performed when the alert's popup is opened/closed.

Declaration
public FadeAnimationType FadeAnimationType { get; set; }
Property Value
FadeAnimationType

FixedSize

Gets or sets an instance of the System.Drawing.Sizestruct which defines fixed size for the alert's popup. The default value is an empty size. In this case the popup adjusts its size according to its content. Otherwise the value of this property is considered.

Declaration
public Size FixedSize { get; set; }
Property Value
System.Drawing.Size

IsPinned

Gets or sets a boolean value determining whether the alert's popup will be pinned on the screen. If pinned, the alert's popup will not be automatically closed upon mouse click outside its bounds or if the AutoClose property is set to true.

Declaration
public bool IsPinned { get; set; }
Property Value
System.Boolean

Opacity

Gets or sets the initial opacity of the alert's popup.

Declaration
public float Opacity { get; set; }
Property Value
System.Single

OptionItems

Gets the items collection containing the items added to the options drop-down button of the desktop alert's popup.

Declaration
public RadItemCollection OptionItems { get; }
Property Value
RadItemCollection

PlaySound

Gets or sets a boolean value determining whether a sound is played when the alert's popup is shown.

Declaration
public bool PlaySound { get; set; }
Property Value
System.Boolean

Popup

Gets an instance of the DesktopAlertPopupclass that represents the popup of the desktop alert.

Declaration
public DesktopAlertPopup Popup { get; }
Property Value
DesktopAlertPopup

PopupAnimation

Gets or sets a boolean value determining whether the alert's popup will be animated.

Declaration
public bool PopupAnimation { get; set; }
Property Value
System.Boolean

PopupAnimationDirection

Gets or sets a value determining the direction of the alert's popup animation.

Declaration
public RadDirection PopupAnimationDirection { get; set; }
Property Value
RadDirection

PopupAnimationEasing

Gets or sets the type of the drop-down animation easing.

Declaration
public RadEasingType PopupAnimationEasing { get; set; }
Property Value
RadEasingType

PopupAnimationFrames

Gets or sets the count of the alert's drop-down animation frames.

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

RightToLeft

Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.

Declaration
public virtual RightToLeft RightToLeft { get; set; }
Property Value
System.Windows.Forms.RightToLeft

One of the System.Windows.Forms.RightToLeft values. The default is System.Windows.Forms.RightToLeft.Inherit.
Exceptions
System.ComponentModel.InvalidEnumArgumentException

The assigned value is not one of the System.Windows.Forms.RightToLeft values.

ScreenPosition

Gets or sets a value of the AlertScreenPosition enum which defines the position of the alert popup on the working area of the active screen.

Declaration
public virtual AlertScreenPosition ScreenPosition { get; set; }
Property Value
AlertScreenPosition

ShowCloseButton

Gets or sets a boolean value determining whether the close button is shown.

Declaration
public bool ShowCloseButton { get; set; }
Property Value
System.Boolean

ShowOptionsButton

Gets or sets a boolean value determining whether the options button is shown.

Declaration
public bool ShowOptionsButton { get; set; }
Property Value
System.Boolean

ShowPinButton

Gets or sets a boolean value determining whether the pin button is shown.

Declaration
public bool ShowPinButton { get; set; }
Property Value
System.Boolean

SoundToPlay

Gets or sets the sound which is played when the alert's popup is shown and the PlaySound property is set to true.

Declaration
public SystemSound SoundToPlay { get; set; }
Property Value
System.Media.SystemSound

Methods

CreatePopup()

Returns an instance of the DesktopAlertPopup class that represents the alert's popup

Declaration
protected virtual DesktopAlertPopup CreatePopup()
Returns
DesktopAlertPopup

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

GetLocationModifiedByUser()

Declaration
protected virtual bool GetLocationModifiedByUser()
Returns
System.Boolean

GetOwnedTreeHandler()

Declaration
public override IComponentTreeHandler GetOwnedTreeHandler()
Returns
IComponentTreeHandler

Overrides

GetPopupSize()

Declaration
protected virtual Size GetPopupSize()
Returns
System.Drawing.Size

Hide()

Hides the alert popup from the screen.

Declaration
public void Hide()

OnLocationChangeRequested(Point)

Declaration
protected virtual void OnLocationChangeRequested(Point alertLocation)
Parameters
System.Drawing.Point alertLocation

OnNotifyPropertyChanged(String)

Declaration
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String propertyName

Overrides

OnPopupClosed(Object, RadPopupClosedEventArgs)

Declaration
protected virtual void OnPopupClosed(object sender, RadPopupClosedEventArgs args)
Parameters
System.Object sender

RadPopupClosedEventArgs args

OnPopupClosing(Object, RadPopupClosingEventArgs)

Declaration
protected virtual void OnPopupClosing(object sender, RadPopupClosingEventArgs args)
Parameters
System.Object sender

RadPopupClosingEventArgs args

OnPopupOpened(Object, EventArgs)

Declaration
protected virtual void OnPopupOpened(object sender, EventArgs args)
Parameters
System.Object sender

System.EventArgs args

OnPopupOpening(Object, RadPopupOpeningEventArgs)

Declaration
protected virtual void OnPopupOpening(object sender, RadPopupOpeningEventArgs args)
Parameters
System.Object sender

RadPopupOpeningEventArgs args

ResetLocationModifier()

Resets the explicit location modifier. In other words, if the user has modified the location of the alert's popup, the DesktopAlertManager will not consider it when rearranging the visible alerts. This method will reset the explicit location modifier and thus the DesktopAlertManager will continue managing the location of the alert according to its location settings.

Declaration
public void ResetLocationModifier()

Show()

Displays the alert popup on the screen at the specified location.

Declaration
public void Show()

Events

Closed

Fires when the alert's popup was closed.

Declaration
public event RadPopupClosedEventHandler Closed
Event Type
RadPopupClosedEventHandler

Closing

Fires when the alert's popup is about to be closed. The closing action can be canceled by modifying the arguments of this event..

Declaration
public event RadPopupClosingEventHandler Closing
Event Type
RadPopupClosingEventHandler

Opened

Fires when the alert's popup was opened.

Declaration
public event RadPopupOpenedEventHandler Opened
Event Type
RadPopupOpenedEventHandler

Opening

Fires when the alert's popup is about to be opened. The opening action can be canceled by modifying the arguments of this event.

Declaration
public event RadPopupOpeningEventHandler Opening
Event Type
RadPopupOpeningEventHandler

Extension Methods