Class

RadDesktopAlert

Initializes a new instance of the RadDesktopAlert class.

Declaration

public RadDesktopAlert()

Initializes a new instance of the RadDesktopAlert class with the specified container.

Declaration

public RadDesktopAlert(IContainer container)

Parameters

Gets or 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

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

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

Declaration

[Browsable(true)]
public virtual bool AutoSize { get; set; }

Property Value

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

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

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

Gets or sets the content image of the RadDesktopAlert.

Declaration

public Image ContentImage { get; set; }

Property Value

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

Declaration

public string ContentText { get; set; }

Property Value

Gets the element used for storing the current DPI scale.

Declaration

public RadElement DpiScaleElement { get; }

Property Value

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

Declaration

public int FadeAnimationFrames { get; set; }

Property Value

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

Declaration

public int FadeAnimationSpeed { get; set; }

Property Value

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

Gets or sets the fixed size for the alert's popup. If the value is Size.Empty, 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

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

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

Declaration

public float Opacity { get; set; }

Property Value

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

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

Declaration

[Browsable(false)]
public bool PlaySound { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public DesktopAlertPopup Popup { get; }

Property Value

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

Declaration

public bool PopupAnimation { get; set; }

Property Value

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

Declaration

public RadDirection PopupAnimationDirection { get; set; }

Property Value

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

Declaration

public RadEasingType PopupAnimationEasing { get; set; }

Property Value

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

Declaration

public int PopupAnimationFrames { get; set; }

Property Value

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

Exceptions

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

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

Declaration

public bool ShowCloseButton { get; set; }

Property Value

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

Declaration

public bool ShowOptionsButton { get; set; }

Property Value

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

Declaration

public bool ShowPinButton { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public SystemSound SoundToPlay { get; set; }

Property Value

Creates and returns an instance of the DesktopAlertPopup class that represents the alert's popup.

Declaration

protected virtual DesktopAlertPopup CreatePopup()

Returns

Releases the managed resources used by the RadDesktopAlert and optionally releases the unmanaged resources.

Declaration

protected override void DisposeManagedResources()

Overrides RadComponent.DisposeManagedResources()

Gets a value indicating whether the location has been modified by the user.

Declaration

protected virtual bool GetLocationModifiedByUser()

Returns

Gets the component tree handler for this RadDesktopAlert.

Declaration

public override IComponentTreeHandler GetOwnedTreeHandler()

Returns

Overrides RadComponent.GetOwnedTreeHandler()

Calculates and returns the size of the popup based on the fixed size or content requirements.

Declaration

protected virtual Size GetPopupSize()

Returns

Hides the alert popup from the screen.

Declaration

public void Hide()

Handles location change requests for the alert.

Declaration

protected virtual void OnLocationChangeRequested(Point alertLocation)

Parameters

Handles property change notifications and updates the popup theme if needed.

Declaration

protected override void OnNotifyPropertyChanged(string propertyName)

Parameters

Overrides RadObject.OnNotifyPropertyChanged(string)

Raises the Closed event.

Declaration

protected virtual void OnPopupClosed(object sender, RadPopupClosedEventArgs args)

Parameters

Raises the Closing event.

Declaration

protected virtual void OnPopupClosing(object sender, RadPopupClosingEventArgs args)

Parameters

Raises the Opened event.

Declaration

protected virtual void OnPopupOpened(object sender, EventArgs args)

Parameters

Raises the Opening event.

Declaration

protected virtual void OnPopupOpening(object sender, RadPopupOpeningEventArgs args)

Parameters

Resets the explicit location modifier. 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 resets the explicit location modifier so the DesktopAlertManager will continue managing the location of the alert according to its location settings.

Declaration

public void ResetLocationModifier()

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

Declaration

public void Show()

Occurs when the alert's popup has been closed.

Declaration

public event RadPopupClosedEventHandler Closed

Event Value

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

Declaration

public event RadPopupClosingEventHandler Closing

Event Value

Occurs when the alert's popup has been opened.

Declaration

public event RadPopupOpenedEventHandler Opened

Event Value

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

Declaration

public event RadPopupOpeningEventHandler Opening

Event Value