ISplash Interface

Declares members implemented by a splash screen which is displayed when a Windows Forms application starts.

Namespace: DevExpress.ExpressApp.Win

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

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

NuGet Package: DevExpress.ExpressApp.Win

Declaration

C#

public interface ISplash

VB.NET

Public Interface ISplash

Related API Members

The following members return ISplash objects:

• WinApplication.SplashScreen

Remarks

When a Windows Forms application starts, a splash screen is displayed. Usually, it shows basic information on the starting application, its logo and/or version, while the application is being initialized (see Windows Forms Application Creation and Initialization). In XAF, the splash screen represents an object that implements the ISplash interface. This interface exposes the Start and Stop methods. The Start method is invoked by the XafApplication.Setup method before initializing the application’s service objects. In the Start method, a splash form must be shown. This form must be closed by the Stop method, which is called when the main form is invoked.

In XAF applications, a default splash screen form is shown automatically. This form contains a label, whose text is set to “Loading…”. You can change this text by calling the ISplash.SetDisplayText method before the application’s Setup method is called. To access the splash screen currently set to the application, use the WinApplication.SplashScreen property.

To replace the default splash screen with a custom one, assign an instance of your Splash class that implements the ISplash interface to the application’s SplashScreen property:

C#

static class Program {
    static void Main() {
        //..
        MySolutionWindowsFormsApplication application = new MySolutionWindowsFormsApplication();
        try {
            application.SplashScreen = new MySplash();
            application.Setup();
            application.Start();
        }
        //...
    }
}

VB.NET

Friend Class Program
    Shared Sub Main()
        '..
        Dim application As MySolutionWindowsFormsApplication = _
        New MySolutionWindowsFormsApplication()
        Try
            application.SplashScreen = New MySplash()
            application.Setup()
            application.Start()
        End Try
        '...
    End Sub
End Class

Note that you should perform the assignment before the Setup method call. Otherwise, a form of the default splash screen will be shown.

To see an example of a custom splash screen, refer to the Splash Forms topic.