Class SfProgressBar
The progress bar control is used to indicates the progress of a task with built-in features like rectangular and circular shapes, determinate and indeterminate states, segments, and more.
Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfProgressBar
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfProgressBar : SfBaseComponent
Constructors
SfProgressBar()
Declaration
Properties
ChildContent
Sets and gets the content of the UI element.
Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment |
|
CornerRadius
Sets and gets the corner radius type of the progress bar.
Declaration
public CornerType CornerRadius { get; set; }
Property Value
EnablePieProgress
Enable or disable whether the progress bar component appear in the pie visualization.
Declaration
public bool EnablePieProgress { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableProgressSegments
Enable or disable whether the progress bar component appear as segments.
Declaration
public bool EnableProgressSegments { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableRtl
Enable or disable whether the progress bar component rendering in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EndAngle
Gets and sets the value of the end angle for circular progress bar component.
Declaration
public int EndAngle { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
GapWidth
Gets and sets the segment gap width of the progress bar component.
Declaration
public double GapWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
Height
Gets and sets the height of the progress bar component.
Declaration
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
ID
Set the id string for the progress bar component.
Declaration
public string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
InnerRadius
Gets and sets a value of the progress radius for circular progress bar component.
Declaration
public string InnerRadius { get; set; }
Property Value
Type |
Description |
System.String |
|
IsActive
Gets and sets the active state of the progress bar component.
Declaration
public bool IsActive { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsGradient
Gets and sets whether the progress bar in gradient visualization.
Declaration
public bool IsGradient { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsIndeterminate
Gets and sets whether the progress bar value indicating in indeterminate state.
Declaration
public bool IsIndeterminate { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsStriped
Get and sets whether the linear progress bar component to be visualized as a striped.
Declaration
public bool IsStriped { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Maximum
Get and sets the maximum progress value of the progress bar component.
Declaration
public double Maximum { get; set; }
Property Value
Type |
Description |
System.Double |
|
Minimum
Get and sets the minimum progress value of the progress bar component.
Declaration
public double Minimum { get; set; }
Property Value
Type |
Description |
System.Double |
|
ProgressColor
Gets and sets the progress color of the progress bar component.
Declaration
public string ProgressColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ProgressThickness
Gets and sets the progress height of the progress bar component.
Declaration
public double ProgressThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
Radius
Gets and sets a value of the track radius for circular progress bar component.
Declaration
public string Radius { get; set; }
Property Value
Type |
Description |
System.String |
|
Role
Gets and sets the modes of progress indication of the progress bar component.
Declaration
public ModeType Role { get; set; }
Property Value
SecondaryProgress
Gets and sets the secondary progress value of the progress bar component.
Declaration
public double SecondaryProgress { get; set; }
Property Value
Type |
Description |
System.Double |
|
SegmentColor
Gets and sets a segment color of the progress bar component.
Declaration
public string[] SegmentColor { get; set; }
Property Value
Type |
Description |
System.String[] |
|
SegmentCount
Gets and sets a segment count of the progress bar component.
Declaration
public int SegmentCount { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
ShowProgressValue
Gets and sets whether to show the progress value of the progress bar component.
Declaration
public bool ShowProgressValue { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
StartAngle
Sets and get the start angle for circular progress bar component.
Declaration
public int StartAngle { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Theme
Sets and gets the options for customizing the theme of the progress bar component.
Declaration
public Theme Theme { get; set; }
Property Value
TrackColor
Gets and sets the track color of the progress bar component.
Declaration
public string TrackColor { get; set; }
Property Value
Type |
Description |
System.String |
|
TrackThickness
Gets and sets the track height of the progress bar component.
Declaration
public double TrackThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
Type
Gets and sets the type (Linear or Circular) of the progress bar component.
Declaration
public ProgressType Type { get; set; }
Property Value
Value
Gets and sets the progress value of the progress bar component.
Declaration
public double Value { get; set; }
Property Value
Type |
Description |
System.Double |
|
Width
Gets and sets the width of the progress bar component.
Declaration
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type |
Name |
Description |
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder |
__builder |
|
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type |
Name |
Description |
System.Boolean |
firstRender |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Overrides
Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)
OnInitialized()
Declaration
protected override void OnInitialized()
Declaration
protected override Task OnParametersSetAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|