Documentation

Class DesktopAlertPopup

This class represents the popup of a RadDesktopAlertcomponent. This popup hosts an instance of the RadDesktopAlertElementclass which represents the element hierarchy of the alert.

Inheritance
System.Object
RadControl
RadPopupControlBase
DesktopAlertPopup
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class DesktopAlertPopup : RadPopupControlBase, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, IPopupControl

Constructors

DesktopAlertPopup(RadElement, RadDesktopAlert)

Creates an instance of the DesktopAlertPopupclass with specified owner.

Declaration
public DesktopAlertPopup(RadElement element, RadDesktopAlert owner)
Parameters
RadElement element

An instance of the RadElementclass that represents the owner element of the DesktopAlertPopup
RadDesktopAlert owner

An instance of the RadDesktopAlertclass that represents the owner alert of the DesktopAlertPopup

DesktopAlertPopup(RadDesktopAlert)

Creates an instance of the DesktopAlertPopupclass.

Declaration
public DesktopAlertPopup(RadDesktopAlert owner)
Parameters
RadDesktopAlert owner

An instance of the RadDesktopAlertclass that represents the owner alert of the DesktopAlertPopup

Properties

AlertElement

Gets an instance of the RadDesktopAlertElementwhich represents the main alert element.

Declaration
public RadDesktopAlertElement AlertElement { get; }
Property Value
RadDesktopAlertElement

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

ButtonItems

Gets an instance of the RadItemCollectionthat holds the buttons items added to the alert component.

Declaration
public RadItemCollection ButtonItems { get; }
Property Value
RadItemCollection

CanMove

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

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

CaptionText

Gets or sets the caption text of the alert.

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

ContentText

Gets or sets the content text of the alert.

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

Image

Gets or sets the content image of the alert.

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

IsPinned

Gets or sets a boolean value determining whether the popup is pinned on the screen.

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

OptionItems

Declaration
public RadItemCollection OptionItems { get; }
Property Value
RadItemCollection

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

ThemeClassName

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

Overrides

Methods

CanClosePopup(RadPopupCloseReason)

Declaration
public override bool CanClosePopup(RadPopupCloseReason reason)
Parameters
RadPopupCloseReason reason

Returns
System.Boolean

Overrides

ControlDefinesThemeForElement(RadElement)

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

GetHorizontalPopupLocation(Rectangle)

Declaration
protected override int GetHorizontalPopupLocation(Rectangle alignmentRectangle)
Parameters
System.Drawing.Rectangle alignmentRectangle

Returns
System.Int32

Overrides

OnKeyDown(Keys)

Declaration
public override bool OnKeyDown(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Overrides

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseEnter(EventArgs)

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnNotifyPropertyChanged(String)

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

Overrides

OnPopupOpening(CancelEventArgs)

Declaration
protected override void OnPopupOpening(CancelEventArgs args)
Parameters
System.ComponentModel.CancelEventArgs args

Overrides

ResumeAutoClose()

Restarts the auto-close timer.

Declaration
public void ResumeAutoClose()

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
System.Int32 x

System.Int32 y

System.Int32 width

System.Int32 height

System.Windows.Forms.BoundsSpecified specified

Overrides

ShowPopupCore(Size, Point)

Declaration
protected override void ShowPopupCore(Size size, Point location)
Parameters
System.Drawing.Size size

System.Drawing.Point location

Overrides

SuspendAutoClose()

Stops the auto-close timer.

Declaration
public void SuspendAutoClose()

Extension Methods