DXSplashScreen Class

Uses the WinForms Splash Screen Manager and enables a Splash Screen, a Wait Form, a Splash Image, and an Overlay Form in XAF Win applications.

Namespace: DevExpress.ExpressApp.Win.Utils

Assembly: DevExpress.ExpressApp.Win.v24.1.dll

NuGet Packages: DevExpress.ExpressApp.Win, DevExpress.ExpressApp.Win.Design

NuGet Package: DevExpress.ExpressApp.Win

public class DXSplashScreen :
    ISplash,
    ISupportUpdateSplash,
    ISupportSplashTypes,
    ISupportOverlayForm

Public Class DXSplashScreen
    Implements ISplash,
               ISupportUpdateSplash,
               ISupportSplashTypes,
               ISupportOverlayForm

Remarks

The DXSplashScreen class uses the WinForms Splash Screen Manager to show, update, and close splash forms. You can use the following forms in XAF applications:

You can pass custom form types, an image, and Overlay From options to a DXSplashScreen constructor and assign the initialized DXSplashScreen instance to the WinApplication.SplashScreen property. The WinApplication object uses DXSplashScreen methods to show splashes where required.

For example, you can add the following code to the WinApplication.cs (WinApplication.vb) file in the WinForms Application project to enable all four splash forms:

C#
VB.NET

namespace MySolution.Win {
    public partial class MySolutionWindowsFormsApplication : WinApplication {
        public MySolutionWindowsFormsApplication() {
            // ...
            SplashScreen = new DXSplashScreen(typeof(MyCustomSplashScreen), typeof(WaitForm), mySvgImage, 
                new DefaultOverlayFormOptions());
            ExecuteStartupLogicBeforeClosingLogonWindow = true;
        }
        // ...
    }
}

Namespace MySolution.Win
    Partial Public Class MySolutionWindowsFormsApplication
        Inherits WinApplication
        Public Sub New()
            ' ...
            SplashScreen = SplashScreen = New DXSplashScreen(GetType(SplashScreen1), GetType(WaitForm1), svgImage, _
                New DefaultOverlayFormOptions())
            ExecuteStartupLogicBeforeClosingLogonWindow = True
        End Sub
        ' ...
    End Class
End Namespace

You can also use WinApplication methods to show, update and close splash forms. See the Loading Panels / Splash Forms (WinForms) article for details.