SplashScreenManager.Show(DependencyObject, WindowStartupLocation, Boolean, InputBlockMode, Int32) Method

Shows the splash screen.

Namespace: DevExpress.Xpf.Core

Assembly: DevExpress.Xpf.Core.v24.1.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public void Show(
    DependencyObject owner = null,
    WindowStartupLocation startupLocation = WindowStartupLocation.CenterOwner,
    bool trackOwnerPosition = true,
    InputBlockMode inputBlock = InputBlockMode.None,
    int timeout = 700
)

VB.NET

Public Sub Show(
    owner As DependencyObject = Nothing,
    startupLocation As WindowStartupLocation = WindowStartupLocation.CenterOwner,
    trackOwnerPosition As Boolean = True,
    inputBlock As InputBlockMode = InputBlockMode.None,
    timeout As Integer = 700
)

Optional Parameters

Name	Type	Default	Description
owner	DependencyObject	null	A UI element that is the owner of the splash screen.
startupLocation	WindowStartupLocation	CenterOwner	A System.Windows.WindowStartupLocation enumeration value that specifies the initial location of the splash screen.
trackOwnerPosition	Boolean	True	true, to change the splash screen position corresponding to the current owner’s position when the user moves the owner window around; otherwise, false.
inputBlock	InputBlockMode	None	A DevExpress.Xpf.Core.InputBlockMode enumeration value that specifies the input restriction mode.
timeout	Int32	700	A time interval for which the splash screen initialization process is prioritized over the main application, in milliseconds.

Remarks

The example below illustrates how to create and display a predefined acrylic splash screen with default settings.

C#

 SplashScreenManager.CreateFluent().Show();

VB.NET

 SplashScreenManager.CreateFluent().Show()

You can also use the ShowOnStartup method to show the splash screen at the application startup. It calls the Show method with the following parameters:

C#

 Show(
   owner:null,
   startupLocation:WindowStartupLocation.CenterScreen,
   trackOwnerPosition:true,
   inputBlock:InputBlockMode.None);

VB.NET

 Show(
   owner:=Nothing,
   startupLocation:=WindowStartupLocation.CenterScreen,
   trackOwnerPosition:=true,
   inputBlock:=InputBlockMode.None)

To display a splash screen on top of a UI element, pass the element as the owner parameter and set the startupLocation parameter to CenterOwner. Set the trackOwnerPosition parameter to true to keep the splash screen above the owner when the user drags the owner.

Use the State property to determine the current state of the splash screen.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Show(DependencyObject, WindowStartupLocation, Boolean, InputBlockMode, Int32) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-spreadsheet-create-custom-progress-indicator/CS/WpfSpreadsheetProgressSample/MainWindow.xaml.cs#L36

    // Display the splash screen.
    splashScreenManager.Show();
}

VB.NET

wpf-spreadsheet-create-custom-progress-indicator/VB/WpfSpreadsheetProgressSample/MainWindow.xaml.vb#L39

    ' Display the splash screen.
    splashScreenManager.Show()
End Sub