WindowsFormsApplicationBase.SplashScreen Property

Definition

Namespace:

Microsoft.VisualBasic.ApplicationServices

Assembly:

Microsoft.VisualBasic.Forms.dll

Gets or sets the splash screen for this application.

public:
 property System::Windows::Forms::Form ^ SplashScreen { System::Windows::Forms::Form ^ get(); void set(System::Windows::Forms::Form ^ value); };

public System.Windows.Forms.Form SplashScreen { get; set; }

member this.SplashScreen : System.Windows.Forms.Form with get, set

Public Property SplashScreen As Form

Property Value

Form

The splash screen for the application.

Exceptions

ArgumentNullException

The same value is assigned to this property and the MainForm property.

Examples

This example uses the My.Application.SplashScreen property and the My.Application.Startup event to update the splash screen with status information as the application starts.

Private Sub MyApplication_Startup(
    sender As Object,
    e As Microsoft.VisualBasic.ApplicationServices.StartupEventArgs
) Handles Me.Startup
    ' Get the splash screen.
    Dim splash As SplashScreen1 = CType(My.Application.SplashScreen, SplashScreen1)
    ' Display current status information.
    splash.Status = "Current user: " & My.User.Name
End Sub

This example requires that the project have a splash screen named SplashScreen1. The splash screen needs to have a property named Status that updates its user interface.

You must enter this code in the Code Editor window for application events. For more information, see Application Page, Project Designer (Visual Basic).

Remarks

The My.Application.SplashScreen property allows you to get or set the Form object that the application uses as the splash screen, the first graphic form that is displayed while an application is being started.

This property supports the Visual Basic Application model. For more information, see Overview of the Visual Basic Application Model.

The changes to this property are not persisted when the application closes. To change the splash screen permanently, you must change the setting in the Project Designer.

Availability by Project Type

Project type	Available
Windows Forms Application	Yes
Class Library	No
Console Application	No
Windows Forms Control Library	No
Web Control Library	No
Windows Service	No
Web Site	No

See also

• MinimumSplashScreenDisplayTime
• Form
• Objects (Visual Basic)