ClassRadOverlayManager
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:
public class RadOverlayManager : BaseSplashManagerInheritance: objectBaseSplashManagerRadOverlayManager
Inherited Members
Constructors
RadOverlayManager()
Declaration
public RadOverlayManager()Properties
ActivateAssociatedFormOnClose
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.
Declaration
public static bool ActivateAssociatedFormOnClose { get; set; }Property Value
true if the associated form should be activated when the overlay closes; otherwise, false.
IsActive
Gets a value indicating whether an overlay screen is currently active and displayed.
Declaration
public static bool IsActive { get; }Property Value
true if an overlay screen is currently open; otherwise, false.
OverlayInstance
Gets or sets the current overlay screen instance used for displaying overlay content. If no instance exists, a new OverlayScreen will be created automatically.
Declaration
public static OverlayScreen OverlayInstance { get; set; }Property Value
The current OverlayScreen instance.
Methods
Close()
Closes the currently active overlay form and removes it from view. If no overlay is currently displayed, this method has no effect.
Declaration
public static void Close()Show(Control)
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.
Declaration
public static void Show(Control controlToAssociate)Parameters
controlToAssociate
The control that the overlay will cover and be associated with.