LoadingIndicatorButtonInfo Class

Represents a loading indicator displayed within the ButtonEdit and its descendants.

Assembly: DevExpress.Xpf.Core.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core

Declaration

C#
VB.NET

public class LoadingIndicatorButtonInfo :
    ButtonInfoBase

Public Class LoadingIndicatorButtonInfo
    Inherits ButtonInfoBase

Remarks

The LoadingIndicatorButtonInfo class implements the functionality of a loading indicator displayed within the button editors (e.g., ButtonEdit, DateEdit, etc.).

How to Add the Loading Indicator

Add a LoadingIndicatorButtonInfo class instance to the editor’s ButtonEdit.Buttons (ButtonEditSettings.Buttons for the in-place ButtonEdit) collection.

To display and hide the loading indicator, use its Visibility property.

Example

The code sample below illustrates how to show the LoadingIndicatorButtonInfo during the long running operation and hide the loading indicator when the operation is complete.

Xaml

<dxe:ButtonEdit
    AllowDefaultButton="False">
    <dxe:ButtonEdit.Buttons>
        <dxe:LoadingIndicatorButtonInfo Visibility="Collapsed" x:Name="loadingIndicator"/>
        <dxe:ButtonInfo GlyphKind="Refresh" Click="ButtonInfo_Click"/>
    </dxe:ButtonEdit.Buttons>
</dxe:ButtonEdit>

C#
VB.NET

private async void ButtonInfo_Click(object sender, RoutedEventArgs e) {
    loadingIndicator.Visibility = Visibility.Visible;
    // Perform a long running operation instead of Task.Delay
    await Task.Delay(2000);
    loadingIndicator.Visibility = Visibility.Collapsed;
    e.Handled = true;
}

Private Async Sub ButtonInfo_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    loadingIndicator.Visibility = Visibility.Visible
    ' Perform a long running operation instead of Task.Delay
    Await Task.Delay(2000)
    loadingIndicator.Visibility = Visibility.Collapsed
    e.Handled = True
End Sub

The animation below illustrates the result: