Built-in Progress Bar

• Aug 03, 2020
• 4 minutes to read

Note

You are viewing documentation for the legacy DXSplashScreen. We recommend that you use the Splash Screen Manager or the SplashScreenManagerService to add the splash screen functionality to your applications.

Built-in Progress Bar

A default splash screen contains a marquee progress bar, which continuously changes its progress. When you manually display/close DXSplashScreen, you can set its display mode to regular where the progress changes between 0 and 100. To change a display mode to regular and to step through progress, use the static DXSplashScreen.Progress(double value) method.

C#

for(int i = 0; i <= 100; i++) {
    DXSplashScreen.Progress(i);
    //...
}

You can use the DXSplashScreen.SetState method to pass custom information to a splash screen. The example below demonstrates how to use this method.

Example

This example shows how to manually invoke and close DXSplashScreen.By default, DXSplashScreen contains a progress bar, indicating the progress of the application load. This example also shows how you can manually change the progress in code.

View Example

SplashScreenView.xaml

<UserControl x:Class="DXSplashScreenSample.SplashScreenView"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
             xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
             mc:Ignorable="d" 
             d:DataContext="{x:Static dx:SplashScreenViewModel.DesignTimeData}"
             >
    <Grid x:Name="LayoutRoot">
        <Grid x:Name="Splash" Width="450" HorizontalAlignment="Center" VerticalAlignment="Top" Margin="0">
            <Grid x:Name="Back">
                <Border Background="Black" CornerRadius="3" Opacity="0.15"/>
                <Border CornerRadius="2" Margin="1" Background="White"/>
            </Grid>
            <Grid x:Name="Content_Area" Margin="12">
                <Grid.RowDefinitions>
                    <RowDefinition Height="Auto"/>
                    <RowDefinition Height="Auto"/>
                    <RowDefinition Height="*"/>
                    <RowDefinition Height="Auto"/>
                </Grid.RowDefinitions>
                <Image x:Name="Image" Source="Image.png" Stretch="None"/>
                <TextBlock x:Name="Info" TextWrapping="Wrap" Text="{Binding State}" Grid.Row="1" Margin="12,12,12,0" Foreground="#FF2D2D2D"/>
                <ProgressBar x:Name="progressBar" 
                             Height="12" 
                             Grid.Row="2" 
                             Margin="12"
                             IsIndeterminate="{Binding IsIndeterminate}"
                             Value="{Binding Progress}"
                             Maximum="{Binding MaxProgress}"/>
                <DockPanel x:Name="Footer" Grid.Row="3" Margin="12,20,12,4">
                    <TextBlock x:Name="Footer_Text" TextWrapping="Wrap" Text="Copyright © 1998-2015" Opacity="0.5" Foreground="#FF2D2D2D" HorizontalAlignment="Left" VerticalAlignment="Center"/>
                    <Image x:Name="Logotype" DockPanel.Dock="Right" Source="Logo.png" Stretch="None" HorizontalAlignment="Right"  />
                </DockPanel>
            </Grid>
        </Grid>
    </Grid>
</UserControl>

App.xaml.cs

// Developer Express Code Central Example:
// How to manually invoke and close DXSplashScreen
// 
// This example shows how to manually invoke and close DXSplashScreen. By default,
// DXSplashScreen contains a progress bar, indicating the progress of the
// application load. This example also shows how you can manually change the
// progress in code.
// 
// You can find sample updates and versions for different programming languages here:
// https://supportcenter.devexpress.com/ticket/details/e3243/how-to-manually-invoke-and-close-dxsplashscreen

using DevExpress.Xpf.Core;
using System.Windows;

namespace DXSplashScreenSample {
    public partial class App : Application {
        protected override void OnStartup(StartupEventArgs e) {
            base.OnStartup(e);
            DXSplashScreen.Show<SplashScreenView>();
        }
    }
}

MainWindow.xaml.cs

// Developer Express Code Central Example:
// How to manually invoke and close DXSplashScreen
// 
// This example shows how to manually invoke and close DXSplashScreen. By default,
// DXSplashScreen contains a progress bar, indicating the progress of the
// application load. This example also shows how you can manually change the
// progress in code.
// 
// You can find sample updates and versions for different programming languages here:
// https://supportcenter.devexpress.com/ticket/details/e3243/how-to-manually-invoke-and-close-dxsplashscreen

using DevExpress.Xpf.Core;
using System.Windows;

namespace DXSplashScreenSample {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            Loaded += OnLoaded;
            for(int i = 0; i < 100; i++) {
                DXSplashScreen.Progress(i);
                DXSplashScreen.SetState(string.Format("{0} %", (i + 1)));
                System.Threading.Thread.Sleep(40);
            }
        }

        void OnLoaded(object sender, RoutedEventArgs e) {
            DXSplashScreen.Close();
        }
    }
}

MainWindow.xaml.vb

' Developer Express Code Central Example:
' How to manually invoke and close DXSplashScreen
' 
' This example shows how to manually invoke and close DXSplashScreen. By default,
' DXSplashScreen contains a progress bar, indicating the progress of the
' application load. This example also shows how you can manually change the
' progress in code.
' 
' You can find sample updates and versions for different programming languages here:
' https://supportcenter.devexpress.com/ticket/details/e3243/how-to-manually-invoke-and-close-dxsplashscreen

Imports System.Threading
Imports System.Windows
Imports DevExpress.Xpf.Core

Namespace DXSplashScreenSample
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            Me.WindowStartupLocation = WindowStartupLocation.CenterScreen
            AddHandler Me.Loaded, AddressOf OnLoaded
            For i As Integer = 0 To 99
                DXSplashScreen.Progress(i)
                DXSplashScreen.SetState(String.Format("{0} %", (i + 1)))
                Thread.Sleep(40)
            Next i
        End Sub
        Private Sub OnLoaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            DXSplashScreen.Close()
        End Sub
    End Class
End Namespace

Application.xaml.vb

' Developer Express Code Central Example:
' How to manually invoke and close DXSplashScreen
' 
' This example shows how to manually invoke and close DXSplashScreen. By default,
' DXSplashScreen contains a progress bar, indicating the progress of the
' application load. This example also shows how you can manually change the
' progress in code.
' 
' You can find sample updates and versions for different programming languages here:
' https://supportcenter.devexpress.com/ticket/details/e3243/how-to-manually-invoke-and-close-dxsplashscreen

Imports System.Windows
Imports DevExpress.Xpf.Core

Namespace DXSplashScreenSample
    Partial Public Class App
        Inherits Application
        Protected Overrides Sub OnStartup(ByVal e As StartupEventArgs)
            MyBase.OnStartup(e)
            DXSplashScreen.Show(Of SplashScreenView)()
        End Sub
    End Class
End Namespace