Class ProgressBarBase

Serves as a base class for all the progress bar types.

Inheritance

System.Object

ProgressBarBase

SfCircularProgressBar

SfLinearProgressBar

Namespace: Syncfusion.XForms.ProgressBar

Assembly: Syncfusion.SfProgressBar.XForms.dll

Syntax

public abstract class ProgressBarBase : View, IParentThemeElement, IThemeElement

Examples

SfProgressBar progress = new SfProgressBar();
progress.ProgressValue = 12;
progress.Minimum = 20;

Constructors

ProgressBarBase()

Initializes a new instance of the ProgressBarBase class.

Declaration

public ProgressBarBase()

Fields

AnimationDurationProperty

Identifies the AnimationDuration bindable property. This property can be used to change the duration of animation.

Declaration

public static readonly BindableProperty AnimationDurationProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

EasingEffectProperty

Identifies the EasingEffect bindable property. This property allows to specify the transfer function that controls animation speed when they run.

Declaration

public static readonly BindableProperty EasingEffectProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

GapWidthProperty

Identifies the GapWidth bindable property. This can be used to customize the default spacing between the segments using the GapWidth property.

Declaration

public static readonly BindableProperty GapWidthProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

IndeterminateAnimationDurationProperty

Identifies the IndeterminateAnimationDuration bindable property. The duration of animation takes to complete one cycle for the indicator.

Declaration

public static readonly BindableProperty IndeterminateAnimationDurationProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

IndeterminateEasingEffectProperty

Identifies the EasingEffect bindable property. This property allows to specify a transfer function for indeterminate state, which controls animation speed when they run.

Declaration

public static readonly BindableProperty IndeterminateEasingEffectProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

IndeterminateIndicatorWidthProperty

Identifies the IndeterminateIndicatorWidth bindable property. This property can be used to change an indeterminate indicator width value of ProgressBar.

Declaration

public static readonly BindableProperty IndeterminateIndicatorWidthProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

IsIndeterminateProperty

Identifies the IsIndeterminate bindable property. It indicates whether the state of control is enabled or not.

Declaration

public static readonly BindableProperty IsIndeterminateProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

MaximumProperty

Identifies the Maximum bindable property. This property can be used to set the maximum of range to the entire span of the progress bar.

Declaration

public static readonly BindableProperty MaximumProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

MinimumProperty

Identifies the Minimum bindable property. This property can be used to set the minimum of range to the entire span of the progress bar.

Declaration

public static readonly BindableProperty MinimumProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

ProgressColorProperty

Identifies the ProgressColor bindable property. This property can be used to change the color of progress in the ProgressBar control.

Declaration

public static readonly BindableProperty ProgressColorProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

ProgressProperty

Identifies the Progress bindable property. This property can be used to change the progress value of the control.

Declaration

public static readonly BindableProperty ProgressProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

RangeColorsProperty

Identifies the RangeColors bindable property. This property can be used to visualize the multiple ranges with different colors.

Declaration

public static readonly BindableProperty RangeColorsProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

SegmentCountProperty

Identifies the SegmentCount bindable property. This property can be used to split the progress bar into multiple segments.

Declaration

public static readonly BindableProperty SegmentCountProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

TrackColorProperty

Identifies the TrackColor bindable property. This property can be used to change the track color of the ProgressBar control.

Declaration

public static readonly BindableProperty TrackColorProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

Properties

AnimationDuration

Gets or sets the duration an animation takes to complete a cycle for the progress indicator.

Declaration

public int AnimationDuration { get; set; }

Property Value

Type	Description
System.Int32	The duration of the animation.

EasingEffect

Gets or sets a Xamarin.Forms.Easing value to specify a transfer function that controls how animations speed up or slow down as they're running.

Declaration

public EasingEffects EasingEffect { get; set; }

Property Value

Type	Description
EasingEffects	The easing effects.

GapWidth

Gets or sets the value of the GapWidth. This property can be used to change the gap between the segments in ProgressBar.

Declaration

public double GapWidth { get; set; }

Property Value

Type	Description
System.Double	The width of the gap.

IndeterminateAnimationDuration

Gets or sets the duration an animation takes to complete a cycle for the indicator in the ProgressBar control.

Declaration

public int IndeterminateAnimationDuration { get; set; }

Property Value

Type	Description
System.Int32	The duration of the animation.

IndeterminateEasingEffect

Gets or sets a IndeterminateEasingEffects value to specify a transfer function that controls how animations speed up or slow down as they're running.

Declaration

public IndeterminateEasingEffects IndeterminateEasingEffect { get; set; }

Property Value

Type	Description
IndeterminateEasingEffects	The easing effects.

IndeterminateIndicatorWidth

Gets or sets the value of the IndeterminateIndicatorWidth. This property can be used to change the level of indicator in indeterminate state.

Declaration

public double IndeterminateIndicatorWidth { get; set; }

Property Value

Type	Description
System.Double

IsIndeterminate

Gets or sets a value indicating whether the progress bar is in indeterminate state or not in the ProgressBar control.

Declaration

public bool IsIndeterminate { get; set; }

Property Value

Type	Description
System.Boolean	true if is indeterminate; otherwise, false.

Maximum

Gets or sets the value of Maximum. This property can be used to change the Maximum range value of ProgressBar.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double	The maximum.

Minimum

Gets or sets the value of Minimum. This property can be used to change the minimum range value of ProgressBar.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double	The minimum.

Progress

Gets or sets the value of Progress. This property can be used to change the progress value of the SProgressBar Control.

Declaration

public double Progress { get; set; }

Property Value

Type	Description
System.Double	The progress.

ProgressColor

Gets or sets the value of ProgressColor. This property can be used to change the color of the progress in ProgressBar.

Declaration

public Color ProgressColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The color of the stroke.

RangeColors

Gets or sets a collection of colors to the progress indicator based on the range constraint in the ProgressBar control.

Declaration

public RangeColorCollection RangeColors { get; set; }

Property Value

Type	Description
RangeColorCollection	The color of the stroke.

SegmentCount

Gets or sets the value of SegmentCount. This property can be used to change the count of the segments in ProgressBar.

Declaration

public int SegmentCount { get; set; }

Property Value

Type	Description
System.Int32	The segment count.

TrackColor

Gets or sets the value of TrackColor. This property can be used to change the track color of the ProgressBar Control.

Declaration

public Color TrackColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The color of the progress bar background.

Methods

Dispose(Boolean)

This method is used to release unmanaged resources used by the Syncfusion.XForms.ProgressBar control.

Declaration

public virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Indicates whether to dispose or not.

OnBindingContextChanged()

Invoked whenever the binding context of the Xamarin.Forms.View changes. Override this method to add class handling for this event.

Declaration

protected override void OnBindingContextChanged()

OnProgressCompleted(ProgressValueEventArgs)

Called when ProgressCompleted event occurs.

Declaration

protected virtual void OnProgressCompleted(ProgressValueEventArgs args)

Parameters

Type	Name	Description
ProgressValueEventArgs	args	Contains arguments relevant to progress value changed event.

OnValueChanged(ProgressValueEventArgs)

Called when ValueChanged event occurs.

Declaration

protected virtual void OnValueChanged(ProgressValueEventArgs args)

Parameters

Type	Name	Description
ProgressValueEventArgs	args	Contains arguments relevant to progress value changed event.

SetProgress(Double, Int32, Easing)

Sets Progress with corresponding animation duration and easing effects.

Declaration

public void SetProgress(double progress, int animationDuration, Easing easingEffect)

Parameters

Type	Name	Description
System.Double	progress	Progress value.
System.Int32	animationDuration	Duration to animate the progress.
Xamarin.Forms.Easing	easingEffect	Easing effect for the animation.

Events

ProgressCompleted

The progress completed event occurs when Progress value attains Maximum value in ProgressBar.

Declaration

public event EventHandler<ProgressValueEventArgs> ProgressCompleted

Event Type

Type	Description
System.EventHandler<ProgressValueEventArgs>

ValueChanged

The value change event occurs when Progress value is changed in Syncfusion.XForms.ProgressBar.

Declaration

public event EventHandler<ProgressValueEventArgs> ValueChanged

Event Type

Type	Description
System.EventHandler<ProgressValueEventArgs>