Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[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
    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
   [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]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]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Wait Form

Expanded Overview

The WaitForm is a small splash form that contains an animated image and two labels (by default). This form can be used to indicate the progress of operations during your application run. The creation and management of Wait Forms is performed by the Splash Screen Manager component. Below is the default appearance of the Wait Form painted using the DevExpress Style skin.

An animated image, displayed within the Wait Form, is obtained from the current skin. Here are examples of Wait Forms painted in different skins.

The Wait Form's image, caption and description are internally encapsulated by a built-in ProgressPanel control. This control can be accessed at design time (using the Wait Form's designer), at which time you can change the caption and description to custom values, modify the control's appearance and layout settings, etc. The following image illustrates some useful properties.

Expanded Displaying Wait Form

Unlike a SplashScreen, the automatic display of a Wait Form at the start of a main form is not supported. You can display and close a Wait Form manually using the following methods.

Wait Forms and Splash Screens are displayed by a Splash Screen Manager in a separate thread. So, changing splash form labels and all other appearance settings directly at runtime is not safe or even possible, since you do not have access to an instance of the splash form currently displayed. You can dynamically update any splash form setting by using the command mechanism, supported by the SplashScreenManager.SendCommand and SplashFormBase.ProcessCommand methods.

Two methods help you dynamically change a Wait Form's caption and description while the form is being displayed at runtime: SplashScreenManager.SetWaitFormCaption and SplashScreenManager.SetWaitFormDescription.

If you need to display multiple Wait Forms simultaneously, use the multiple Splash Screen Manager components.

Note

Displaying a Wait Form within an MDI child Form's Load event handler may lead to the application freezing. Instead, you can display a Wait Form within an MDI child Form's Shown event handler.

Expanded See Also

How would you rate this topic?​​​​​​​