ISplash.SetDisplayText(String) Method

Sets the text to be displayed by the label located on the default splash screen form.

Namespace: DevExpress.ExpressApp.Win

Assembly: DevExpress.ExpressApp.Win.v20.2.dll

NuGet Package: DevExpress.ExpressApp.Win

Declaration

C#

void SetDisplayText(
    string displayText
)

VB.NET

Sub SetDisplayText(
    displayText As String
)

Parameters

Name	Type	Description
displayText	String	A string value representing the text to be shown on the default splash screen form.

Remarks

The splash screen form shown by a Windows Forms XAF application, by default, contains a label. This label has the “Loading…” text assigned. You can set another text by using the SetDisplayText method of the object returned by the application’s SplashScreen property.

C#

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

VB.NET

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

The SetDisplayText method must be called before the Setup method call. Otherwise, the splash screen with the default text will be shown.

When implementing a custom splash screen, you do not have to implement the SetDisplayText method:

C#

public class MySplash : ISplash {
    //...
    public void SetDisplayText(string displayText) {}
}

VB.NET

Public Class MySplash
        Implements ISplash
    '...
    Public Sub SetDisplayText(ByVal displayText As String)
    End Sub
End Class

If your splash screen form contains a label, you can set the required text to it explicitely, without additional code.