WindowsFormsApplicationBase.MinimumSplashScreenDisplayTime Property

Reference

Definition

Namespace:: Microsoft.VisualBasic.ApplicationServices

Assembly:: Microsoft.VisualBasic.dll

Assembly:: Microsoft.VisualBasic.Forms.dll

Source:: WindowsFormsApplicationBase.vb

Source:: WindowsFormsApplicationBase.vb

Source:: WindowsFormsApplicationBase.vb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the minimum length of time, in milliseconds, for which the splash screen is displayed.

public:
 property int MinimumSplashScreenDisplayTime { int get(); void set(int value); };

public int MinimumSplashScreenDisplayTime { get; set; }

member this.MinimumSplashScreenDisplayTime : int with get, set

Public Property MinimumSplashScreenDisplayTime As Integer

Property Value

Int32

The minimum length of time, in milliseconds, for which the splash screen is displayed.

Examples

This example demonstrates how to set the My.Application.MinimumSplashScreenDisplayTime property by overriding the OnInitialize property.

Protected Overrides Function OnInitialize(
    commandLineArgs As System.Collections.
        ObjectModel.ReadOnlyCollection(Of String)
) As Boolean
    ' Set the display time to 5000 milliseconds (5 seconds). 
    Me.MinimumSplashScreenDisplayTime = 5000
    Return MyBase.OnInitialize(commandLineArgs)
End Function

This example requires that the project have a splash screen.

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.MinimumSplashScreenDisplayTime property allows you to specify the minimum length of time you want the application's splash screen to be displayed. If the main form finishes initializing in less time than what is specified by this property, the splash screen remains until the requested amount of time passes, at which time the main form is displayed. If your application takes longer to start, the splash screen is closed once the main form becomes active.

When you add a splash screen to your application using the Project Designer, it sets the My.Application.MinimumSplashScreenDisplayTime property to 2000, giving a minimum display time of two seconds.

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

You should set the My.Application.MinimumSplashScreenDisplayTime property in a method that overrides the OnInitialize or OnCreateSplashScreen method. Code that overrides methods of the WindowsFormsApplicationBase class should be entered in the ApplicationEvents.vb file, which is hidden by default.


To access the Code Editor window for overriding members
1. With a project selected in Solution Explorer, click Properties on the Project menu. 2. Click the Application tab. 3. Click the View Application Events button to open the Code Editor. For more information, see Application Page, Project Designer (Visual Basic).

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

Applies to

Jaa