Getting Started with Windows Forms Splash Screen

18 Nov 20185 minutes to read

This section explains how to get started with the Windows Forms Splash Screen control and its basic features.

Assembly Deployment

Refer to the Control Dependencies section for the list of assemblies and NuGet packages required to use the SplashControl.

Refer to NuGet Packages to learn how to install NuGet packages in a Windows Forms application.

To install the required NuGet package using the NuGet Package Manager Console, run the following command:

Install-Package Syncfusion.Tools.Windows

Adding Splash Screen via Designer

The SplashControl provides full support for the Windows Forms designer. When the control is dragged from the Toolbox onto the form, the following required assembly references are added automatically:

  • Syncfusion.Grid.Base.dll
  • Syncfusion.Grid.Windows.dll
  • Syncfusion.Shared.Base.dll
  • Syncfusion.Shared.Windows.dll
  • Syncfusion.Tools.Base.dll
  • Syncfusion.Tools.Windows.dll

  1. Drag the SplashControl from the Toolbox onto the form. The SplashControl is created in the component tray of the form.

    Drag and drop the Splash Screen from toolbox in Windows Forms application

  2. Set the SplashImage and TimerInterval properties in the Properties window.

  3. Set the AutoMode property. This property determines how the Splash Screen is displayed.
    • When AutoMode is set to true, the Splash Screen is displayed automatically during the parent form’s Load event.
    • When AutoMode is set to false, the splash screen must be displayed explicitly by calling the ShowSplash() method.

  4. Preview the splash screen at design time by using the Preview Splash option in the Smart Tag.

    Windows Forms Splash Screen showing in designer page

  5. Run the application to display the splash screen.

    Showing Splash Screen at run time in Windows Forms

  6. Handle the SplashClosed event to execute code after the splash screen is closed.

  7. Hide the splash screen while it is displayed by calling the HideSplash() method.

Adding Splash Screen via Code

To create a SplashControl programmatically, follow these steps:

  1. Create a new C# or VB.NET Windows Forms application in Visual Studio.

  2. Add the following required assembly references to the project:

    • Syncfusion.Grid.Base.dll
    • Syncfusion.Grid.Windows.dll
    • Syncfusion.Shared.Base.dll
    • Syncfusion.Shared.Windows.dll
    • Syncfusion.Tools.Base.dll
    • Syncfusion.Tools.Windows.dll

  3. Include the required namespace.

    using Syncfusion.Windows.Forms.Tools;
    Imports Syncfusion.Windows.Forms.Tools

  4. Declare an instance of the SplashControl.

​

private Syncfusion.Windows.Forms.Tools.SplashControl splashControl1;
Friend WithEvents SplashControl1 As Syncfusion.Windows.Forms.Tools.SplashControl
  1. Initialize the control.

​

this.splashControl1 = new Syncfusion.Windows.Forms.Tools.SplashControl();
   this.SuspendLayout();
Me.SplashControl1 = New Syncfusion.Windows.Forms.Tools.SplashControl()
   Me.SuspendLayout()

  1. Configure the required properties of the SplashControl.

    this.splashControl1.CustomSplashPanel = null;
this.splashControl1.HostForm = this;
this.splashControl1.HostFormWindowState = System.Windows.Forms.FormWindowState.Normal;
this.splashControl1.TimerInterval = 3000;
    Me.SplashControl1.CustomSplashPanel = Nothing
Me.SplashControl1.HostForm = Me
Me.SplashControl1.HostFormWindowState = System.Windows.Forms.FormWindowState.Normal
Me.SplashControl1.TimerInterval = 3000

  2. Run the application to display the splash screen.

    Windows Forms Splash Screen displayed at run time