Class BusyIndicator

Represents a control that provides an interactive visual element to the end user when the application is performing some process.

Inheritance

System.Object

BusyIndicator

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Shared.WPF.dll

Syntax

[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class BusyIndicator : ContentControl

Constructors

BusyIndicator()

Initializes a new instance of the BusyIndicator class.

Declaration

public BusyIndicator()

Fields

CancelButtonVisibilityProperty

Using a DependencyProperty as the backing store for CancelButtonVisibility. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty CancelButtonVisibilityProperty

Field Value

Type
System.Windows.DependencyProperty

CloseButtonStyleProperty

Using a DependencyProperty as the backing store for CloseButtonTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty CloseButtonStyleProperty

Field Value

Type
System.Windows.DependencyProperty

CloseButtonVisibilityProperty

Declaration

public static readonly DependencyProperty CloseButtonVisibilityProperty

Field Value

Type
System.Windows.DependencyProperty

DelayProperty

Declaration

public static readonly DependencyProperty DelayProperty

Field Value

Type
System.Windows.DependencyProperty

DescriptionPlacementProperty

Using a DependencyProperty as the backing store for DescriptionPlacement. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DescriptionPlacementProperty

Field Value

Type
System.Windows.DependencyProperty

EnableGrayScaleEffectProperty

Using a DependencyProperty as the backing store for EnableGrayScaleEffect. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty EnableGrayScaleEffectProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderAlignmentProperty

Using a DependencyProperty as the backing store for HeaderAlignment. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HeaderAlignmentProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderProperty

Using a DependencyProperty as the backing store for Header. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderTemplateProperty

Using a DependencyProperty as the backing store for HeaderTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty HeaderTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

IsBusyProperty

Using a DependencyProperty as the backing store for IsBusy. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty IsBusyProperty

Field Value

Type
System.Windows.DependencyProperty

IsIndeterminateProperty

Declaration

public static readonly DependencyProperty IsIndeterminateProperty

Field Value

Type
System.Windows.DependencyProperty

LoadingDescriptionProperty

Declaration

public static readonly DependencyProperty LoadingDescriptionProperty

Field Value

Type
System.Windows.DependencyProperty

LoadingDescriptionTemplateProperty

Declaration

public static readonly DependencyProperty LoadingDescriptionTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

OverlayBrushProperty

Using a DependencyProperty as the backing store for ProgressBarStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty OverlayBrushProperty

Field Value

Type
System.Windows.DependencyProperty

OverlayOpacityProperty

Using a DependencyProperty as the backing store for ProgressBarStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty OverlayOpacityProperty

Field Value

Type
System.Windows.DependencyProperty

ProgressBarStyleProperty

Using a DependencyProperty as the backing store for ProgressBarStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ProgressBarStyleProperty

Field Value

Type
System.Windows.DependencyProperty

ProgressValueProperty

Declaration

public static readonly DependencyProperty ProgressValueProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

CancelButtonVisibility

Declaration

public Visibility CancelButtonVisibility { get; set; }

Property Value

Type
System.Windows.Visibility

CloseButtonStyle

Declaration

public Style CloseButtonStyle { get; set; }

Property Value

Type
System.Windows.Style

CloseButtonVisibility

Declaration

public Visibility CloseButtonVisibility { get; set; }

Property Value

Type
System.Windows.Visibility

Delay

Declaration

public TimeSpan Delay { get; set; }

Property Value

Type
System.TimeSpan

DescriptionPlacement

Declaration

public DescriptionPlacement DescriptionPlacement { get; set; }

Property Value

Type
DescriptionPlacement

EnableGrayScaleEffect

Declaration

public bool EnableGrayScaleEffect { get; set; }

Property Value

Type
System.Boolean

Header

Declaration

public object Header { get; set; }

Property Value

Type
System.Object

HeaderAlignment

Declaration

public HorizontalAlignment HeaderAlignment { get; set; }

Property Value

Type
System.Windows.HorizontalAlignment

HeaderTemplate

Declaration

public DataTemplate HeaderTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

IsBusy

Declaration

public bool IsBusy { get; set; }

Property Value

Type
System.Boolean

IsIndeterminate

Declaration

public bool IsIndeterminate { get; set; }

Property Value

Type
System.Boolean

LoadingDescription

Declaration

public object LoadingDescription { get; set; }

Property Value

Type
System.Object

LoadingDescriptionTemplate

Declaration

public DataTemplate LoadingDescriptionTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

OverlayBrush

Gets or sets the overlay brush.

Declaration

public Brush OverlayBrush { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The overlay brush.

OverlayOpacity

Gets or sets the overlay brush.

Declaration

public double OverlayOpacity { get; set; }

Property Value

Type	Description
System.Double	The overlay brush.

ProgressBarStyle

Gets or sets the ProgressBarStyle

Declaration

public Style ProgressBarStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The ProgressBarStyle.

ProgressValue

Declaration

public double ProgressValue { get; set; }

Property Value

Type
System.Double

Methods

OnApplyTemplate()

Declaration

public override void OnApplyTemplate()

OnDescriptionPlacementChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Declaration

public static void OnDescriptionPlacementChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj
System.Windows.DependencyPropertyChangedEventArgs	args

OnDescriptionPlacementChanged(DependencyPropertyChangedEventArgs)

Declaration

protected void OnDescriptionPlacementChanged(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	args

OnEnableGrayScaleEffectChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Declaration

public static void OnEnableGrayScaleEffectChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj
System.Windows.DependencyPropertyChangedEventArgs	args

OnEnableGrayScaleEffectChanged(DependencyPropertyChangedEventArgs)

Declaration

protected void OnEnableGrayScaleEffectChanged(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	args

OnIsBusyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Declaration

public static void OnIsBusyChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj
System.Windows.DependencyPropertyChangedEventArgs	args

OnIsBusyChanged(DependencyPropertyChangedEventArgs)

Declaration

protected void OnIsBusyChanged(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	args

OnProgressValueChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Declaration

public static void OnProgressValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj
System.Windows.DependencyPropertyChangedEventArgs	args

OnProgressValueChanged(DependencyPropertyChangedEventArgs)

Declaration

protected void OnProgressValueChanged(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	args

Events

CancelClick

Event that is raised when CancelButton click event occurs.

Declaration

public event CancelEventHandler CancelClick

Event Type

Type
System.ComponentModel.CancelEventHandler

Closed

Event that is raised when Closed event occurs.

Declaration

public event RoutedEventHandler Closed

Event Type

Type
System.Windows.RoutedEventHandler

Closing

Event that is raised when Closing event occurs.

Declaration

public event CancelEventHandler Closing

Event Type

Type
System.ComponentModel.CancelEventHandler

DescriptionPlacementChanged

Event that is raised when IsBusy property is changed.

Declaration

public event PropertyChangedCallback DescriptionPlacementChanged

Event Type

Type
System.Windows.PropertyChangedCallback

EnableGrayScaleEffectChanged

Event that is raised when EnableGrayScaleEffect property is changed.

Declaration

public event PropertyChangedCallback EnableGrayScaleEffectChanged

Event Type

Type
System.Windows.PropertyChangedCallback

IsBusyChanged

Event that is raised when IsBusy property is changed.

Declaration

public event PropertyChangedCallback IsBusyChanged

Event Type

Type
System.Windows.PropertyChangedCallback

ProgressValueChanged

Event that is raised when IsProgressValue property is changed.

Declaration

public event PropertyChangedCallback ProgressValueChanged

Event Type

Type
System.Windows.PropertyChangedCallback