Class SfCircularProgressBar
Represents SfCircularProgressBar class.
Implements
Inherited Members
Namespace: Syncfusion.Maui.ProgressBar
Assembly: Syncfusion.Maui.ProgressBar.dll
Syntax
public class SfCircularProgressBar : ProgressBarBase, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider, IParentThemeElement, IThemeElement
Examples
<progressBar:SfCircularProgressBar Minimum="0"
Maximum="100"
TrackFill="Blue"
Progress="70"
ProgressFill="Yellow"
SegmentCount="1"
SegmentGapWidth="10"
IsIndeterminate="False"
IndeterminateIndicatorWidthFactor="0.2"
IndeterminateAnimationEasing="{x:Static Easing.SpringIn}"
IndeterminateAnimationDuration="1500"
AnimationEasing="{x:Static Easing.SpringOut}"
AnimationDuration="4000"
StartAngle="0"
EndAngle="0"
TrackRadiusFactor="0.9"
TrackThickness="1"
ThicknessUnit="Factor"
ProgressRadiusFactor="0.7"
ProgressThickness="0.7"
ProgressCompleted="SfCircularProgressBar_ProgressCompleted"
ProgressChanged="SfCircularProgressBar_ProgressChanged">
<progressBar:SfCircularProgressBar.Content>
<Label Text = "{Binding Source={x:Reference circularProgressBar}, Path=Progress}" />
</progressBar:SfCircularProgressBar.Content>
<progressBar:SfCircularProgressBar.GradientStops>
<progressBar:ProgressGradientStop Color="Yellow" Value="30" />
<progressBar:ProgressGradientStop Color="Green" Value="60" />
</progressBar:SfCircularProgressBar.GradientStops>
</progressBar:SfCircularProgressBar>
Constructors
SfCircularProgressBar()
Initializes a new instance of the SfCircularProgressBar class.
Declaration
public SfCircularProgressBar()
Examples
<progressBar:SfCircularProgressBar Minimum="0"
Maximum="100"
TrackFill="Blue"
Progress="70"
ProgressFill="Yellow"
SegmentCount="1"
SegmentGapWidth="10"
IsIndeterminate="False"
IndeterminateIndicatorWidthFactor="0.2"
IndeterminateAnimationEasing="{x:Static Easing.SpringIn}"
IndeterminateAnimationDuration="1500"
AnimationEasing="{x:Static Easing.SpringOut}"
AnimationDuration="4000"
StartAngle="0"
EndAngle="0"
TrackRadiusFactor="0.9"
TrackThickness="1"
ThicknessUnit="Factor"
ProgressRadiusFactor="0.7"
ProgressThickness="0.7"
ProgressCompleted="SfCircularProgressBar_ProgressCompleted"
ProgressChanged="SfCircularProgressBar_ProgressChanged">
<progressBar:SfCircularProgressBar.Content>
<Label Text = "{Binding Source={x:Reference circularProgressBar}, Path=Progress}" />
</progressBar:SfCircularProgressBar.Content>
<progressBar:SfCircularProgressBar.GradientStops>
<progressBar:ProgressGradientStop Color="Yellow" Value="30"/>
<progressBar:ProgressGradientStop Color="Green" Value="60"/>
</progressBar:SfCircularProgressBar.GradientStops>
</progressBar:SfCircularProgressBar>
Fields
ContentProperty
Identifies the Content bindable property.
Declaration
public static readonly BindableProperty ContentProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for Content bindable property. |
EndAngleProperty
Identifies the EndAngle bindable property.
Declaration
public static readonly BindableProperty EndAngleProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for EndAngle bindable property. |
ProgressCornerStyleProperty
Identifies the ProgressCornerStyle bindable property.
Declaration
public static readonly BindableProperty ProgressCornerStyleProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for ProgressCornerStyle bindable property. |
ProgressRadiusFactorProperty
Identifies the ProgressRadiusFactor bindable property.
Declaration
public static readonly BindableProperty ProgressRadiusFactorProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for ProgressRadiusFactor bindable property. |
ProgressThicknessProperty
Identifies the ProgressThickness bindable property.
Declaration
public static readonly BindableProperty ProgressThicknessProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for ProgressThickness bindable property. |
StartAngleProperty
Identifies the StartAngle bindable property.
Declaration
public static readonly BindableProperty StartAngleProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for StartAngle bindable property. |
ThicknessUnitProperty
Identifies the ThicknessUnit bindable property.
Declaration
public static readonly BindableProperty ThicknessUnitProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for ThicknessUnit bindable property. |
TrackCornerStyleProperty
Identifies the TrackCornerStyle bindable property.
Declaration
public static readonly BindableProperty TrackCornerStyleProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for TrackCornerStyle bindable property. |
TrackRadiusFactorProperty
Identifies the TrackRadiusFactor bindable property.
Declaration
public static readonly BindableProperty TrackRadiusFactorProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for TrackRadiusFactor bindable property. |
TrackThicknessProperty
Identifies the TrackThickness bindable property.
Declaration
public static readonly BindableProperty TrackThicknessProperty
Field Value
Type | Description |
---|---|
Microsoft.Maui.Controls.BindableProperty | The identifier for TrackThickness bindable property. |
Properties
Content
Gets or sets a any view to display in the center of circular progress bar.
Declaration
public View Content { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.Maui.Controls.View | An object that contains the progress bar visual content. The default value is |
Examples
<progressBar:SfCircularProgressBar x:Name="progressBar"
Progress="50">
<progressBar:SfCircularProgressBar.Content>
<Label Text="{Binding Source={x:Reference progressBar}, Path=Progress, Mode=TwoWay}" />
</progressBar:SfCircularProgressBar.Content>
</progressBar:SfCircularProgressBar>
EndAngle
Gets or sets a value that specifies the EndAngle of the progress bar.
Declaration
public double EndAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double | It defines the end angle of the progress bar. The default value is |
Examples
ProgressCornerStyle
Gets or sets the value that specifies the corner style of the progress.
Declaration
public CornerStyle ProgressCornerStyle { get; set; }
Property Value
Type | Description |
---|---|
CornerStyle | One of the enumeration values that specifies the corner style of the progress in progress bar. The default is BothFlat. |
Examples
ProgressRadiusFactor
Gets or sets a value that specifies the outer radius factor of the progress.
Declaration
public double ProgressRadiusFactor { get; set; }
Property Value
Type | Description |
---|---|
System.Double | It defines the radius factor of the progress. The default value is |
Examples
ProgressThickness
Gets or sets a value that specifies the thickness for the progress. You can specify value either in logical pixel or radius factor using the ThicknessUnit property.
Declaration
public double ProgressThickness { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is |
Examples
StartAngle
Gets or sets a value that specifies the StartAngle of the progress bar.
Declaration
public double StartAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double | It defines the start angle of the progress bar. The default value is |
Examples
ThicknessUnit
Gets or sets enum value that indicates to calculate the track and progress thickness either in logical pixel or radius factor.
Declaration
public SizeUnit ThicknessUnit { get; set; }
Property Value
Type | Description |
---|---|
SizeUnit | One of the SizeUnit enumeration that specifies how the thickness unit value is considered. The default mode is Pixel. |
Examples
<progressBar:SfCircularProgressBar ThicknessUnit="Factor"
Progress="100"
TrackThickness="0.05"
ProgressRadiusFactor="0.85"
ProgressThickness="1" />
TrackCornerStyle
Gets or sets the value that specifies the corner style of the track.
Declaration
public CornerStyle TrackCornerStyle { get; set; }
Property Value
Type | Description |
---|---|
CornerStyle | One of the enumeration values that specifies the corner style of the track in progress bar. The default is BothFlat. |
Examples
<progressBar:SfCircularProgressBar StartAngle="180"
EndAngle="360"
TrackCornerStyle="BothCurve" />
TrackRadiusFactor
Gets or sets a value that specifies the outer radius factor of the track.
Declaration
public double TrackRadiusFactor { get; set; }
Property Value
Type | Description |
---|---|
System.Double | This value ranges from 0 to 1. It defines the radius factor of the track. The default value is |
Examples
TrackThickness
Gets or sets a value that specifies the thickness of track in circular progress bar. You can specify value either in logical pixel or radius factor using the ThicknessUnit property.
Declaration
public double TrackThickness { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is |
Examples
Methods
ArrangeContent(Rect)
Arrange the child elements.
Declaration
protected override Size ArrangeContent(Rect bounds)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.Maui.Graphics.Rect | bounds | The bounds. |
Returns
Type | Description |
---|---|
Microsoft.Maui.Graphics.Size | Return child element size. |
Overrides
MeasureContent(Double, Double)
Measures the size of layout required for child elements.
Declaration
protected override Size MeasureContent(double widthConstraint, double heightConstraint)
Parameters
Type | Name | Description |
---|---|---|
System.Double | widthConstraint | The widthConstraint. |
System.Double | heightConstraint | The heightConstraint. |
Returns
Type | Description |
---|---|
Microsoft.Maui.Graphics.Size | Return child element size. |