DXSplashScreenService (legacy)

• Aug 03, 2020
• 5 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.

DXSplashScreenService is an ISplashScreenService implementation that allows you to display a splash screen with a custom view. This splash screen is being processed in a separate thread.

• Getting Started with DXSplashScreenService
• Injecting Custom Data to the shown DXSplashScreen
• Customizing DXSplashScreen Appearance and Location
• Example

Getting Started with DXSplashScreenService

Assume that you need to show a complex splash screen view with several images, a progress bar and other elements, while a heavy and resource-intensive operation is being performed. This functionality is already built-in to the DXSplashScreen class. Designing an MVVM-compliant application must be accomplished without calling the DXSplashScreen methods from a View Model. For this purpose, utilize the DXSplashScreenService.

To use the DXSplashScreenService, add it to the Interaction.Behaviors collection. You can accomplish this task using Smart Tag as described in the Attaching MVVM Behaviors and Services or manually as shown in the code snippet below.

XAML

<UserControl x:Class="DXSampleSplashScreenService.View.MainView" 
    ...
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core" 
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm">
    <dxmvvm:Interaction.Behaviors>
        <dx:DXSplashScreenService/>
    </dxmvvm:Interaction.Behaviors>
    ...
</UserControl>

To specify a splash screen view, add a default view from the Template Gallery (see How to: Add DXSplashScreen to Your Project for details) or implement your own based on a UserControl.

When a splash screen view is added, set the DXSplashScreenService.SplashScreenType property to the view’s type.

XAML

<dxmvvm:Interaction.Behaviors>
    <dx:DXSplashScreenService SplashScreenType="View:SplashScreenView"/>
</dxmvvm:Interaction.Behaviors>

Alternatively, you can define the splash screen view layout directly by using the ViewServiceBase.ViewTemplate property.

XAML

<dxmvvm:Interaction.Behaviors>
    <dx:DXSplashScreenService>
        <dx:DXSplashScreenService.ViewTemplate>
            <DataTemplate>
                <View:SplashScreenView/>
            </DataTemplate>
        </dx:DXSplashScreenService.ViewTemplate>
    </dx:DXSplashScreenService>
</dxmvvm:Interaction.Behaviors>

To show and hide the splash screen from your View Model, use the ISplashScreenService.ShowSplashScreen and ISplashScreenService.HideSplashScreen methods accordingly.

C#

[POCOViewModel]
public class MainViewModel {
    protected ISplashScreenService SplashScreenService { get { return this.GetService<ISplashScreenService>(); } }
    public void Calculate() {
        SplashScreenService.ShowSplashScreen();
        ...
        SplashScreenService.HideSplashScreen();
    }
}

VB.NET

<POCOViewModel> _
Public Class MainViewModel
    Protected ReadOnly Property SplashScreenService() As ISplashScreenService
        Get
            Return Me.GetService(Of ISplashScreenService)()
        End Get
    End Property

    Public Sub Calculate()
        SplashScreenService.ShowSplashScreen()
        ...
        SplashScreenService.HideSplashScreen()
    End Sub
End Class

A detailed description on how to obtain a service from a View Model (which is a POCO object or a ViewModelBase descendant) is available here: Services in POCO objects and Services in ViewModelBase descendants.

Note

DXSplashScreenService does not support the simultaneous display of multiple splash screens.

If you need to show the splash screen automatically whenever a view is loading, set the DXSplashScreenService.ShowSplashScreenOnLoading property to True.

Injecting Custom Data to the shown DXSplashScreen

The DXSplashScreenService provides methods to inject your custom data into the splash screen: ISplashScreenService.SetSplashScreenState and ISplashScreenService.SetSplashScreenProgress. The ISplashScreenService.SetSplashScreenState method allows you to pass a secondary view model to the splash screen. By using the ISplashScreenService.SetSplashScreenProgress method, you can specify the splash screen bar progress value.

C#

[POCOViewModel]
public class MainViewModel {
    protected ISplashScreenService SplashScreenService { get { return this.GetService<ISplashScreenService>(); } }
    public void Calculate() {
        SplashScreenService.ShowSplashScreen();
        SplashScreenService.SetSplashScreenState("Calculating...");
        ...
        SplashScreenService.SetSplashScreenState("Finished.");
        Thread.Sleep(TimeSpan.FromSeconds(2));
        SplashScreenService.HideSplashScreen();
    }
}

VB.NET

<POCOViewModel> _
Public Class MainViewModel
    Protected Overridable ReadOnly Property SplashScreenService() As ISplashScreenService
        Get
            Return Me.GetService(Of ISplashScreenService)()
        End Get
    End Property

    Public Sub Calculate()
        SplashScreenService.ShowSplashScreen()
        SplashScreenService.SetSplashScreenState("Calculating...")
        ...
        SplashScreenService.SetSplashScreenState("Finished.")
        Thread.Sleep(TimeSpan.FromSeconds(2))
        SplashScreenService.HideSplashScreen()
    End Sub
End Class

These methods pass data to the predefined SplashScreenViewModel instance located in the DXSplashScreen’s DataContext which has a set of properties that you can use in your splash screen with bindings.

C#

public class SplashScreenViewModel : ViewModelBase, ISupportSplashScreen {
    public bool IsIndeterminate { ... }
    public double MaxProgress { ... }
    public double Progress { ... }
    public object State { ... }
}

For example, you can bind the splash screen View’s elements in the followings manner.

XAML

<UserControl x:Class="DXSampleSplashScreenService.View.SplashScreenView" ... >
    <Grid>
        <Border BorderBrush="#FF0072C6" BorderThickness="1" Margin="2">
            <Grid>
                <ProgressBar BorderThickness="0" Value="{Binding Progress}" Maximum="{Binding MaxProgress}" IsIndeterminate="{Binding IsIndeterminate}" Height="12" />
                <TextBlock Text="{Binding State}" HorizontalAlignment="Center" VerticalAlignment="Center"/>
            </Grid>
        </Border>
    </Grid>
</UserControl>

Customizing DXSplashScreen Appearance and Location

In addition to the capability to define a custom layout, you can customize the splash screen window by overriding the DXSplashScreenService.SplashScreenWindowStyle property. To change the splash screen location, use the DXSplashScreenService.SplashScreenStartupLocation property.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-use-dxsplashscreenservice-e4858.

MainViewModel.vb

Imports DevExpress.Mvvm
Imports DevExpress.Mvvm.POCO
Imports DevExpress.Mvvm.DataAnnotations
Imports System
Imports System.Threading

Namespace DXSampleSplashScreenService.ViewModel
    <POCOViewModel> _
    Public Class MainViewModel
        Public Overridable Property Delay() As Integer
        Protected ReadOnly Property SplashScreenService() As ISplashScreenService
            Get
                Return Me.GetService(Of ISplashScreenService)()
            End Get
        End Property

        Public Sub New()
            Delay = 10
        End Sub

        Public Sub Calculate()
            SplashScreenService.ShowSplashScreen()
            SplashScreenService.SetSplashScreenState("Calculating...")
            Thread.Sleep(TimeSpan.FromSeconds(Delay))
            SplashScreenService.SetSplashScreenState("Finished.")
            Thread.Sleep(TimeSpan.FromSeconds(2))
            SplashScreenService.HideSplashScreen()
        End Sub
    End Class
End Namespace

MainView.xaml

<UserControl x:Class="DXSampleSplashScreenService.View.MainView" 
    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" 
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm"
    xmlns:View="clr-namespace:DXSampleSplashScreenService.View"
    xmlns:ViewModel="clr-namespace:DXSampleSplashScreenService.ViewModel"    
    mc:Ignorable="d" d:DesignHeight="300" d:DesignWidth="300" 
    DataContext="{dxmvvm:ViewModelSource Type={x:Type ViewModel:MainViewModel}}">
    <dxmvvm:Interaction.Behaviors>
        <dx:DXSplashScreenService SplashScreenStartupLocation="CenterOwner">
            <dx:DXSplashScreenService.ViewTemplate>
                <DataTemplate>
                    <View:SplashScreenView/>
                </DataTemplate>
            </dx:DXSplashScreenService.ViewTemplate>
        </dx:DXSplashScreenService>
    </dxmvvm:Interaction.Behaviors>
    <Grid x:Name="LayoutRoot" Background="White">
        <Grid.RowDefinitions>
            <RowDefinition/>
            <RowDefinition/>
        </Grid.RowDefinitions>
        <Button Grid.Row="1" Content="Calculate"  HorizontalAlignment="Center" VerticalAlignment="Center" Command="{Binding CalculateCommand}"/>
        <StackPanel Margin="10">
            <StackPanel Orientation="Horizontal">
                <TextBlock Text="Delay: "/>
                <TextBlock Text="{Binding Path=Delay}"/>
            </StackPanel>
            <Slider Minimum="0" Maximum="20" Value="{Binding Path=Delay, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" />
        </StackPanel>
    </Grid>
</UserControl>

SplashScreenView.xaml

<UserControl x:Class="DXSampleSplashScreenService.View.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"  Width="450"
    d:DesignHeight="300" d:DesignWidth="300">
    <Grid>
        <Border Background="LightGray" CornerRadius="5">
            <Border BorderBrush="#FF0072C6" BorderThickness="1" Margin="15" CornerRadius="5">
                <Grid>
                    <ProgressBar BorderThickness="0" Value="{Binding Progress}" Maximum="{Binding MaxProgress}" IsIndeterminate="{Binding IsIndeterminate}" Height="12" />
                    <TextBlock Text="{Binding State, UpdateSourceTrigger=PropertyChanged}" HorizontalAlignment="Center" VerticalAlignment="Center"/>
                </Grid>
            </Border>
        </Border>
    </Grid>
</UserControl>

MainView.xaml.vb

Imports System.Windows.Controls

Namespace DXSampleSplashScreenService.View
    Partial Public Class MainView
        Inherits UserControl

        Public Sub New()
            InitializeComponent()
        End Sub
    End Class
End Namespace

MainViewModel.cs

using DevExpress.Mvvm;
using DevExpress.Mvvm.POCO;
using DevExpress.Mvvm.DataAnnotations;
using System;
using System.Threading;

namespace DXSampleSplashScreenService.ViewModel {
    [POCOViewModel]
    public class MainViewModel {
        public virtual int Delay { get; set; }
        protected ISplashScreenService SplashScreenService { get { return this.GetService<ISplashScreenService>(); } }

        public MainViewModel() {
            Delay = 10;
        }

        public void Calculate() {
            SplashScreenService.ShowSplashScreen();
            SplashScreenService.SetSplashScreenState("Calculating...");
            Thread.Sleep(TimeSpan.FromSeconds(Delay));
            SplashScreenService.SetSplashScreenState("Finished.");
            Thread.Sleep(TimeSpan.FromSeconds(2));
            SplashScreenService.HideSplashScreen();
        }
    }
}