New to Telerik UI for WinFormsStart a free 30-day trial

Provides static methods and properties for managing overlay screens that display semi-transparent overlay forms on top of associated controls. An overlay creates a modal-like experience by covering the entire associated control or form with a dimmed background.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadOverlayManager : BaseSplashManager

Inheritance: objectBaseSplashManagerRadOverlayManager

Inherited Members BaseSplashManager.FormLoadBaseSplashManager.FormShown

Constructors

C#
public RadOverlayManager()

Properties

Gets or sets a value indicating whether the associated form will be activated and brought to focus when the overlay is closed. This property controls the focus behavior after the overlay disappears.

C#
public static bool ActivateAssociatedFormOnClose { get; set; }
Property Value:

true if the associated form should be activated when the overlay closes; otherwise, false.

Gets a value indicating whether an overlay screen is currently active and displayed.

C#
public static bool IsActive { get; }
Property Value:

true if an overlay screen is currently open; otherwise, false.

Gets or sets the current overlay screen instance used for displaying overlay content. If no instance exists, a new OverlayScreen will be created automatically.

C#
public static OverlayScreen OverlayInstance { get; set; }
Property Value:

The current OverlayScreen instance.

Methods

Closes the currently active overlay form and removes it from view. If no overlay is currently displayed, this method has no effect.

C#
public static void Close()

Displays an overlay form that covers the entire associated control with a semi-transparent background. The overlay provides a modal-like experience by preventing interaction with the underlying control.

C#
public static void Show(Control controlToAssociate)
Parameters:controlToAssociateControl

The control that the overlay will cover and be associated with.