Class SfBusyIndicator

Represents a control that allows to display a busy activity animation, which indicates the application is busy with an asynchronous operation.

Inheritance
System.Object
SfBusyIndicator
Namespace: Syncfusion.SfBusyIndicator.XForms
Assembly: Syncfusion.SfBusyIndicator.XForms.dll
Syntax
public class SfBusyIndicator : View, IParentThemeElement, IThemeElement

Constructors

SfBusyIndicator()

Initializes a new instance of the SfBusyIndicator class. Constructor field.

Declaration
public SfBusyIndicator()

Fields

AnimationTypeProperty

Identifies AnimationType. It is used to change various types of animation in busy indicator Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty AnimationTypeProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

DurationProperty

Identifies the duration of animation. It is used to change the speed of animation to finish a cycle Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty DurationProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

EnableAnimationProperty

Identifies the EnableAnimation property of busy indicator. It is used to determine whether the graphical path to be animated or frozen Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty EnableAnimationProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

FontAttributesProperty

Identifies font attribute of the title. It is used to change the font attribute of the title in busy indicator. Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty FontAttributesProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

FontFamilyProperty

Identifies the font family of title. It is used to set the font family of the title in busy indicator. Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty FontFamilyProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

IsBusyProperty

Identifies the IsBusy property of busy indicator. It is used to determine whether the animation of indiacator to be shown or not Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty IsBusyProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

TextColorProperty

Identifies the TextColor. It is used to change the text color of both the default text and animation graphics Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty TextColorProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

TextSizeProperty

Identifies the TextSize. It is used to change the text size of both the default text Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty TextSizeProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

TitlePlacementProperty

Identifies the poition of title. It is used to set the position of title in busy indicator. Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty TitlePlacementProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

TitleProperty

Identifies the title of busy indicator. It is used to customize the title of busy indicator Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty TitleProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

ViewBoxHeightProperty

Identifies the ViewBoxHeight. It is used to change the height of the view box Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty ViewBoxHeightProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

ViewBoxWidthProperty

Identifies ViewBoxWidth. It is used to change the width of the view box Xamarin.Forms.BindableProperty.

Declaration
public static readonly BindableProperty ViewBoxWidthProperty
Field Value
Type Description
Xamarin.Forms.BindableProperty
Remarks

This Xamarin.Forms.BindableProperty is read-only.

Properties

AnimationType

Gets or sets the animation types of busyindicator. It is used to change the various types of animation.

Declaration
public AnimationTypes AnimationType { get; set; }
Property Value
Type Description
AnimationTypes

The type of the animation.

Duration

Gets or sets the value of the Duration property. It used to change the speed of animation to finish a cycle.

Declaration
public float Duration { get; set; }
Property Value
Type Description
System.Single

The Duration of the Animation.

EnableAnimation

Gets or sets a value indicating whether gets or sets the value of EnableAnimation. It determines whether the graphical path to be animated or frozen.

Declaration
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is Animated or not; otherwise, false.

FontAttributes

Gets or sets the value of FontAttributes. This property is used to change the font attribute of the title in busy indicator.

Declaration
public FontAttributes FontAttributes { get; set; }
Property Value
Type Description
Xamarin.Forms.FontAttributes

FontFamily

Gets or sets the value of FontFamily. This property is used to set the font family of the title in busy indicator.

Declaration
public string FontFamily { get; set; }
Property Value
Type Description
System.String

IsBusy

Gets or sets a value indicating whether gets or sets the value of the IsBusy property in busy indicator. It determines whether the animation of indicator to be shown or not.

Declaration
public bool IsBusy { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is busy; otherwise, false.

TextColor

Gets or sets the text color of busy indicator. TextColor is applied to the default text and animation graphics.

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
Xamarin.Forms.Color

The color of the text.

TextSize

Gets or sets the value of TextSize. It is used to change font size of the default text in busy indicator.

Declaration
public float TextSize { get; set; }
Property Value
Type Description
System.Single

The size of the text.

Title

Gets or sets the text of the title of the indicator. It is used to customize the title of busy indicator.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

The title.

TitlePlacement

Gets or sets the value of TitlePlacement. This property is used to set the position of title in busy indicator.

Declaration
public TitlePlacement TitlePlacement { get; set; }
Property Value
Type Description
TitlePlacement

ViewBoxHeight

Gets or sets the value of view box height. It is used to customize the display height of the graphics drawn.

Declaration
public int ViewBoxHeight { get; set; }
Property Value
Type Description
System.Int32

The height of the view box.

ViewBoxWidth

Gets or sets the value of view box width. It is used to customize the display width of the graphics drawn.

Declaration
public int ViewBoxWidth { get; set; }
Property Value
Type Description
System.Int32

The width of the view box.

Methods

OnSizeRequest(Double, Double)

Raises the size request event.

Declaration
protected override SizeRequest OnSizeRequest(double widthConstraint, double heightConstraint)
Parameters
Type Name Description
System.Double widthConstraint

Width constraint.
System.Double heightConstraint

Height constraint.
Returns
Type Description
Xamarin.Forms.SizeRequest

The return value.