Class SfBusyIndicator

The Busy Indicator control is used to display a predefined built-in animation when an operation runs in the background of your application to await completion.

Inheritance

System.Object

SfBusyIndicator

Namespace: Syncfusion.UI.Xaml.Notifications

Assembly: Syncfusion.Notifications.WinUI.dll

Syntax

public class SfBusyIndicator : Control

Examples

This example illustrates how to set the busy indicator using SfBusyIndicator.

<StackPanel>
    <syncfusion:SfBusyIndicator IsActive="True" 
                                BusyContent="Loading...">
    </syncfusion:SfBusyIndicator>
</StackPanel>

Constructors

SfBusyIndicator()

Initializes a new instance of the SfBusyIndicator class.

Declaration

public SfBusyIndicator()

Fields

AnimationTypeProperty

Identifies AnimationType dependency property.

Declaration

public static readonly DependencyProperty AnimationTypeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the AnimationType dependency property.

BusyContentPositionProperty

Identifies BusyContentPosition dependency property.

Declaration

public static readonly DependencyProperty BusyContentPositionProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the BusyContentPosition dependency property.

BusyContentProperty

Identifies BusyContent dependency property.

Declaration

public static readonly DependencyProperty BusyContentProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the BusyContent dependency property.

BusyContentTemplateProperty

Identifies BusyContentTemplate dependency property.

Declaration

public static readonly DependencyProperty BusyContentTemplateProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the BusyContentTemplate dependency property.

ColorProperty

Identifies Color dependency property.

Declaration

public static readonly DependencyProperty ColorProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the Color dependency property.

DurationFactorProperty

Identifies DurationFactor dependency property.

Declaration

public static readonly DependencyProperty DurationFactorProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the DurationFactor dependency property.

IsActiveProperty

Identifies IsActive dependency property.

Declaration

public static readonly DependencyProperty IsActiveProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the IsActive dependency property.

SizeFactorProperty

Identifies SizeFactor dependency property.

Declaration

public static readonly DependencyProperty SizeFactorProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for the SizeFactor dependency property.

Properties

AnimationType

Gets or sets the animation type of the SfBusyIndicator.

Declaration

public BusyIndicatorAnimationType AnimationType { get; set; }

Property Value

Type	Description
BusyIndicatorAnimationType	The default value is DottedCircularFluent.

BusyContent

Gets or sets the content of the SfBusyIndicator.

Declaration

public object BusyContent { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

BusyContentPosition

Gets or sets the content position of the SfBusyIndicator.

Declaration

public BusyIndicatorContentPosition BusyContentPosition { get; set; }

Property Value

Type	Description
BusyIndicatorContentPosition	The default value is Bottom.

BusyContentTemplate

Gets or sets the content template of the SfBusyIndicator.

Declaration

public DataTemplate BusyContentTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	The default value is null.

Color

Gets or sets the color of the indicator/>.

Declaration

public Brush Color { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Media.Brush	The default value is SystemAccentColor.

DurationFactor

Gets or sets the duration of the indicator animation.

Declaration

public double DurationFactor { get; set; }

Property Value

Type	Description
System.Double	It takes double value and the value is ranges from 0 to 1. The default value is 0.5, which indicates the duration of the indicator animation.

IsActive

Gets or sets a value indicating whether SfBusyIndicator is busy or not.

Declaration

public bool IsActive { get; set; }

Property Value

Type	Description
System.Boolean	It takes the boolen value. The default value is false.

SizeFactor

Gets or sets the size of the indicator.

Declaration

public double SizeFactor { get; set; }

Property Value

Type	Description
System.Double	It takes double value and the value is ranges from 0 to 1. The default value is 0.5, which indicates the size of the indicator.

Methods

OnApplyTemplate()

Builds the visual tree for the SfBusyIndicator.

Declaration

protected override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns a class-specific AutomationPeer Implementations for the Microsoft UI Automation infrasturcutre.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
Microsoft.UI.Xaml.Automation.Peers.AutomationPeer	The class-specific AutomationPeer subclass.