New to Telerik UI for WinForms? Start a free 30-day trial

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

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class DesktopAlertPopup : RadPopupControlBase, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, IPopupControl

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadPopupControlBaseDesktopAlertPopup...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedIPopupControlISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadPopupControlBase.lastAlignmentRectangleRadPopupControlBase.dpiScaleFactorRadPopupControlBase.AnimationPropertiesRadPopupControlBase.GetMonitorDpiScaleFactor(Control)RadPopupControlBase.Show()RadPopupControlBase.Show(Point)RadPopupControlBase.Show(Control)RadPopupControlBase.Hide()RadPopupControlBase.ProcessFocusRequested(RadElement)RadPopupControlBase.WndProc(ref Message)RadPopupControlBase.OnPopupOpened()RadPopupControlBase.OnPopupClosed(RadPopupClosedEventArgs)RadPopupControlBase.OnPopupClosing(RadPopupClosingEventArgs)RadPopupControlBase.InitializeDropDownAnimation(Point)RadPopupControlBase.GetBackupSize()RadPopupControlBase.UpdateAeroEffectState()RadPopupControlBase.UpdateLocation(Rectangle)RadPopupControlBase.UpdateLocation()RadPopupControlBase.GetCorrectedLocation(Rectangle)RadPopupControlBase.GetCorrectedLocation(Screen, Rectangle)RadPopupControlBase.GetCorrectedLocation(Screen, Rectangle, Size)RadPopupControlBase.ApplySizingConstraints(Size, Screen)RadPopupControlBase.GetCurrentScreen(Rectangle)RadPopupControlBase.GetCurrentScreen()RadPopupControlBase.GetAvailableBoundsFromScreen(Screen)RadPopupControlBase.GetCorrectedHorizontalLocation(Screen, Rectangle, Point)RadPopupControlBase.GetCorrectedHorizontalLocation(Screen, Rectangle, Point, Size)RadPopupControlBase.GetCorrectedVerticalLocation(Screen, Rectangle, Point)RadPopupControlBase.GetCorrectedVerticalLocation(Screen, Rectangle, Point, Size)RadPopupControlBase.GetVerticalPopupLocation(Rectangle)RadPopupControlBase.AnimationStarting()RadPopupControlBase.OnAlternativeXLocationNeeded(Rectangle, Point, Rectangle)RadPopupControlBase.CheckMakeLastLocationCorrection(Rectangle, Point, Rectangle)RadPopupControlBase.CheckMakeLastLocationCorrection(Rectangle, Point, Rectangle, Size)RadPopupControlBase.OnAlternativeYLocationNeeded(Rectangle, Point, Rectangle)RadPopupControlBase.ShowPopup(Rectangle)RadPopupControlBase.ClosePopup(PopupCloseInfo)RadPopupControlBase.OnPopupClosing(PopupCloseInfo)RadPopupControlBase.OnPopupClosed(PopupCloseInfo)RadPopupControlBase.ClosePopup(RadPopupCloseReason)RadPopupControlBase.OnMouseWheel(Control, int)RadPopupControlBase.CallMouseWheel(MouseEventArgs)RadPopupControlBase.OnAnimationFinished(AnimationEventArgs)RadPopupControlBase.OnAnimating(AnimationEventArgs)RadPopupControlBase.ShouldRestoreAutoSizeRadPopupControlBase.DropDownAnimationDirectionRadPopupControlBase.EasingTypeRadPopupControlBase.AnimationFramesRadPopupControlBase.AnimationEnabledRadPopupControlBase.AnimationTypeRadPopupControlBase.NonAnimatedSizeRadPopupControlBase.FadeAnimationFramesRadPopupControlBase.FadeAnimationSpeedRadPopupControlBase.OpacityRadPopupControlBase.DropShadowRadPopupControlBase.EnableAeroEffectsRadPopupControlBase.FadeAnimationTypeRadPopupControlBase.FitToScreenModeRadPopupControlBase.ScreenSpaceModeRadPopupControlBase.AlignmentRectangleOverlapModeRadPopupControlBase.HorizontalAlignmentCorrectionModeRadPopupControlBase.VerticalAlignmentCorrectionModeRadPopupControlBase.VerticalPopupAlignmentRadPopupControlBase.HorizontalPopupAlignmentRadPopupControlBase.CreateParamsRadPopupControlBase.OwnerElementRadPopupControlBase.OwnerPopupRadPopupControlBase.LastShowDpiScaleFactorRadPopupControlBase.WindowsSettingsRadPopupControlBase.ChildrenRadPopupControlBase.MouseWheelRadPopupControlBase.FadeAnimationFinishedRadPopupControlBase.PopupOpeningRadPopupControlBase.PopupOpenedRadPopupControlBase.PopupClosingRadPopupControlBase.PopupClosedRadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.OnInvalidated(RadElement)RadControl.OnLoad(Size)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.ProcessAutoSizeChanged(bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.GetPreferredSize(Size)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.FontRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

Creates an instance of the DesktopAlertPopupclass.

C#
public DesktopAlertPopup(RadDesktopAlert owner)
Parameters:ownerRadDesktopAlert

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

Creates an instance of the DesktopAlertPopupclass with specified owner.

C#
public DesktopAlertPopup(RadElement element, RadDesktopAlert owner)
Parameters:elementRadElement

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

ownerRadDesktopAlert

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

Properties

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

C#
public RadDesktopAlertElement AlertElement { get; }

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

C#
public bool AutoClose { get; set; }

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

C#
public int AutoCloseDelay { get; set; }

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

C#
public RadItemCollection ButtonItems { get; }

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

C#
public bool CanMove { get; set; }

Gets or sets the caption text of the alert.

C#
public virtual string CaptionText { get; set; }

Gets or sets the content text of the alert.

C#
public virtual string ContentText { get; set; }

Gets or sets the content image of the alert.

C#
public virtual Image Image { get; set; }

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

C#
public bool IsPinned { get; set; }

Gets the items displayed by the caption's options drop-down button.

C#
public RadItemCollection OptionItems { get; }

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

C#
public bool ShowCloseButton { get; set; }

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

C#
public bool ShowOptionsButton { get; set; }

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

C#
public bool ShowPinButton { get; set; }

Gets the type name used to resolve this popup's theme.

C#
public override string ThemeClassName { get; set; }

Overrides: RadControl.ThemeClassName

Methods

Prevents the popup manager from closing the alert through its close-eligibility check.

C#
public override bool CanClosePopup(RadPopupCloseReason reason)
Parameters:reasonRadPopupCloseReason

The reason the popup might be closed.

Returns:

bool

Always false.

Overrides: RadPopupControlBase.CanClosePopup(RadPopupCloseReason)

Reports the popup as defining the theme for standard button, drop-down button, and toggle button elements; delegates other elements to the base implementation.

C#
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters:elementRadElement

The element whose theme ownership is being checked.

Returns:

bool

true for button elements handled by the popup or when the base implementation claims the element.

Overrides: RadControl.ControlDefinesThemeForElement(RadElement)

Creates the alert element, connects its close and pin buttons, and adds it to the popup.

C#
protected override void CreateChildItems(RadElement parent)
Parameters:parentRadElement

The parent element that hosts the alert element.

Overrides: RadControl.CreateChildItems(RadElement)

Detaches button handlers and disposes the auto-close timer when disposing the popup.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

true when managed resources should be released.

Overrides: RadPopupControlBase.Dispose(bool)

Calculates the popup's horizontal position from its configured alignment and the target rectangle.

C#
protected override int GetHorizontalPopupLocation(Rectangle alignmentRectangle)
Parameters:alignmentRectangleRectangle

The rectangle used as the popup's alignment reference.

Returns:

int

The horizontal coordinate for the popup.

Overrides: RadPopupControlBase.GetHorizontalPopupLocation(Rectangle)

Leaves Enter, Escape, and Back unprocessed by this popup; delegates other keys to the base implementation.

C#
public override bool OnKeyDown(Keys keyData)
Parameters:keyDataKeys

The key and modifier data.

Returns:

bool

false for Enter, Escape, and Back; otherwise, the base implementation's result.

Overrides: RadPopupControlBase.OnKeyDown(Keys)

Stores the mouse-down location used to determine whether a subsequent drag began on the caption grip.

C#
protected override void OnMouseDown(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Overrides: RadControl.OnMouseDown(MouseEventArgs)

Suspends auto-close and temporarily raises the opacity while the pointer is over an active popup.

C#
protected override void OnMouseEnter(EventArgs e)
Parameters:eEventArgs

The event data.

Overrides: RadControl.OnMouseEnter(EventArgs)

Resumes auto-close and restores the opacity saved when the pointer entered an active popup.

C#
protected override void OnMouseLeave(EventArgs e)
Parameters:eEventArgs

The event data.

Overrides: RadControl.OnMouseLeave(EventArgs)

Moves the popup while the left mouse button is held after a drag begins on the caption grip. The first drag move marks its location as user-modified and updates the manager's alert positions.

C#
protected override void OnMouseMove(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Overrides: RadControl.OnMouseMove(MouseEventArgs)

Synchronizes the pin button with IsPinned and initializes the DPI scale baseline when animation is enabled.

C#
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters:propertyNamestring

The name of the changed property.

Overrides: RadControl.OnNotifyPropertyChanged(string)

Resets the auto-close suspension count and evaluates the auto-close timer as the popup begins opening.

C#
protected override void OnPopupOpening(CancelEventArgs args)
Parameters:argsCancelEventArgs

The event data for the opening operation.

Overrides: RadPopupControlBase.OnPopupOpening(CancelEventArgs)

Restarts the auto-close timer.

C#
public void ResumeAutoClose()

Applies the requested bounds, using the element tree's desired size for a loaded control whose bounds are changing.

C#
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters:xint

The requested left coordinate.

yint

The requested top coordinate.

widthint

The requested width.

heightint

The requested height.

specifiedBoundsSpecified

The bounds components to apply.

Overrides: RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)

Applies DPI scaling and popup bounds, configures rounded corners, shows the popup without activation, and updates Aero effects when supported.

C#
protected override void ShowPopupCore(Size size, Point location)
Parameters:sizeSize

The popup size to display.

locationPoint

The popup's screen location.

Overrides: RadPopupControlBase.ShowPopupCore(Size, Point)

Stops the auto-close timer.

C#
public void SuspendAutoClose()