LoadingDecorator Class

A container control for displaying long-loading content. Once the content is fully loaded, the loading indicator disappears and the content becomes visible.

Namespace: DevExpress.Xpf.Core

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

Declaration

C#

public class LoadingDecorator :
    Decorator

VB.NET

Public Class LoadingDecorator
    Inherits Decorator

Remarks

The LoadingDecorator is a container control that displays a loading indicator during data/content loading. The Loading Decorator uses the Wait Indicator control to inform that loading is in progress. The Loading Decorator disappears when the content is loaded.

Note

The Wait Indicator works within the main application’s UI thread. UI freezes may affect the Wait Indicator animation.

Wrap the content with the dx:LoadingDecorator tag to add the LoadingDecorator to an application:

XAML

<Window xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"...>
<Grid>
    ...
    <dx:LoadingDecorator>
        <!--Content-->
    </dx:LoadingDecorator>
</Grid>
</Window>

Tip

GitHub Examples:

How to add the Loading Decorator to the MVVM Application

How to build-in the ProgressBar into the LoadingDecorator

Lock Modes

Use the LoadingDecorator.OwnerLock property to specify which part of an applications is locked while the LoadingDecorator content loads:

Value	Image	Description
Full		Blocks the entire window.
InputOnly		Blocks the entire window’s input. The window’s title bar stays active, and you can move the window.
LoadingContent		Blocks only the LoadingDecorator’s content.
None		Nothing is blocked.

Tip

GitHub Example: How to use the Loading Decorator’s OwnerLock property

Customization

Content

Use LoadingDecorator.SplashScreenTemplate and LoadingDecorator.SplashScreenDataContext properties to customize the LoadingDecorator‘s content, layout, and appearance.

The following code sample sets the Loading Decorator‘s text to Loading…Please wait:

XAML

<dx:ThemedWindow 
    ...
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"/>
...
    <dx:LoadingDecorator SplashScreenDataContext="Test value" ...>
        <dx:LoadingDecorator.SplashScreenTemplate>
            <DataTemplate>
                <dx:WaitIndicator Content="{Binding}" DeferedVisibility="True">
                    <dx:WaitIndicator.ContentTemplate>
                        <DataTemplate>
                            <TextBlock Text="{Binding}" />
                        </DataTemplate>
                    </dx:WaitIndicator.ContentTemplate>
                </dx:WaitIndicator>
            </DataTemplate>
        </dx:LoadingDecorator.SplashScreenTemplate>
    </dx:LoadingDecorator>
...
</dx:ThemedWindow>

Tip

Set the WaitIndicator‘s Content property to "" (empty string) to hide the Loading Decorator‘s text.

Position

Use the LoadingDecorator.SplashScreenLocation property to specify the Loading Decorator position.

XAML

<Grid>
    ...
    <dx:LoadingDecorator SplashScreenLocation="CenterContainer">
        <!--Content-->
    </dx:LoadingDecorator>
</Grid>

You can set the LoadingDecorator.SplashScreenLocation property to the following values:

Value	Description
CenterWindow	Locates the splash screen in the window center.
CenterScreen	Locates the splash screen in the screen center.
CenterContainer	Locates the splash screen in the container center.

Border

Use the following properties to specify the border highlight effect:

• The LoadingDecorator.BorderEffect property specifies the border highlight mode.
• The LoadingDecorator.BorderEffectColor property specifies the border highlight color.

XAML

<dx:LoadingDecorator ... BorderEffect="Default" BorderEffectColor="Red">
    <!--Content-->
</dx:LoadingDecorator>

Fade Animation

Use the following properties to customize fade effects:

• Set the LoadingDecorator.UseFadeEffect property to false to disable fade animations.
• Set the LoadingDecorator.FadeInDuration and LoadingDecorator.FadeOutDuration properties to change the fade in/out duration.

The following code sample sets the Fade In and Fade Out animation time to 400 milliseconds:

XAML

<dx:LoadingDecorator FadeInDuration="0:0:0:0.4" FadeOutDuration="0:0:0:0.4">
    <!--Content-->
</dx:LoadingDecorator>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadingDecorator class.

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#

How-to-build-in-the-ProgressBar-to-LoadingDecorator/VB/LoadingIndicatorSample/MainWindow.xaml#L14

</Grid.RowDefinitions>
<dx:LoadingDecorator Grid.Row="1" Name="ld">
    <dx:LoadingDecorator.SplashScreenDataContext>

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Decorator

LoadingDecorator

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)