[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Collapse]Forms and User Controls
    XtraForm
    Ribbon Form
    Tabbed Form
    Fluent Design Form
    XtraUserControl
    Form Assistant
    Taskbar Assistant
   [Collapse]Splash Screen Manager
    [Expand]Examples
     Splash Screen Manager Overview
     Splash Screen
     Splash Image
     Wait Form
     Splash Form Position
     Splash Screen Manager Serialization Specifics
     Overlay Form
   [Expand]Adorner UI Manager
   [Expand]Examples
  [Expand]Messages, Notifications and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Property Grid
  [Expand]Pivot Grid
  [Expand]Tree List
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Overlay Form

An Overlay Form is a semi-transparent splash screen that:

  • overlapps a control or form;
  • prevents users from interacting with the overlapped control;
  • overlapps the control even if it changes its size or position on the screen;
  • runs in a separate thread and does not lock the main and operation threads;
  • can be custom drawn.

Expanded Show Overlay Form

Call the SplashScreenManager.ShowOverlayForm method to display an Overlay Form over a control or form. The method returns the Overlay Form’s handle . To close the Overlay Form, pass this handle to the SplashScreenManager.CloseOverlayForm method. The example below shows how to display an Overlay Form over the current form.

The wait indicator, fade animation and colors depend on the control's skin. The SplashScreenManager.ShowOverlayForm method overload with additional parameters allows you to customize the wait indicator, fade animation, form opacity, background and foreground colors.

Note

You cannot create an Overlay Form at design time, but you can custom draw it.

Expanded Custom Painter

You can implement a painter to custom draw an Overlay Form as follows:

  • inherit from the OverlayWindowPainterBase class;
  • override the Draw method;
  • pass the created object as a parameter to the ShowOverlayForm method.

The code snippet below shows how to display a custom message as in the following figure:

Note

You cannot change properties of controls created in the Overlay Form’s main (UI) thread.

Expanded See Also

Is this topic helpful?​​​​​​​