menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfProgressBar - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfProgressBar

    Specifies the progress bar rendering functionality.

    Inheritance
    System.Object
    SfBaseComponent
    SfProgressBar
    Inherited Members
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    Namespace: Syncfusion.Blazor.ProgressBar
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfProgressBar : SfBaseComponent

    Constructors

    SfProgressBar()

    Declaration
    public SfProgressBar()

    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

    Accepts a RenderFragment that defines the content of the UI element.

    CornerRadius

    Sets and gets the corner radius type of the progress bar.

    Declaration
    public CornerType CornerRadius { get; set; }
    Property Value
    Type Description
    CornerType

    A value of the CornerType enumeration that specifies the corner radius of progress bar. The default value is Auto.

    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

    true, if the pie progress can be enabled. Otherwise, false.

    EnableProgressSegments

    Enable or disable whether the progress bar component appear as segments.

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

    true, if the progress segments can be enabled. Otherwise, false.

    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

    true, if the right to left direction can be enabled for the component. Otherwise, false. The default value is false.

    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

    Accepts an integer value of end angle for circular progress bar component.

    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

    Accepts the double value. The default value is -1.

    Height

    Gets and sets the height of the progress bar component.

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

    Accepts the string value.

    ID

    Set the id string for the progress bar component.

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

    Accepts the string value.

    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

    Accepts the string value. The default value is 100%.

    IsActive

    Gets and sets the active state of the progress bar component.

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

    true, if the progress bar in active state. Otherwise, false.

    IsGradient

    Gets and sets whether the progress bar in gradient visualization.

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

    true, if the progress bar is in gradient visualization. Otherwise, false.

    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

    true, if the progress bar is indicating in indeterminate state. Otherwise, false.

    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

    true, if striped visible indicator shows in linear progress bar component. Otherwise, false.

    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

    Accepts the double value. The default value is 100.

    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

    Accepts the double value.

    ProgressColor

    Gets and sets the progress color of the progress bar component.

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

    Accepts the string value. The default value is empty.

    ProgressThickness

    Gets and sets the progress height of the progress bar component.

    Declaration
    public double ProgressThickness { get; set; }
    Property Value
    Type Description
    System.Double

    Accepts the double value that representing the progress height of component.

    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

    Accepts the string value. The default value is 100%.

    Role

    Gets and sets the modes of progress indication of the progress bar component.

    Declaration
    public ModeType Role { get; set; }
    Property Value
    Type
    ModeType

    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

    Accepts the double value that representing the secondary progress value of the component.

    SecondaryProgressColor

    Get and set the color for the secondary progress bar. By default, it takes the color of the primary progress bar with half of its opacity.

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

    Specifies secondary progress bar color. The default value is null.

    SecondaryProgressThickness

    Get and set the thickness for the secondary progress bar. By default, it takes the thickness of the primary progress bar.

    Declaration
    public double SecondaryProgressThickness { get; set; }
    Property Value
    Type Description
    System.Double

    Specifies secondary progress bar thickness. The default value is null.

    SegmentColor

    Gets and sets a segment color of the progress bar component.

    Declaration
    public string[] SegmentColor { get; set; }
    Property Value
    Type Description
    System.String[]

    Accepts the string array that specifies the segment color of progress bar component.

    SegmentCount

    Gets and sets a segment count of the progress bar component.

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

    Accepts an integer value. The default value is 1.

    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

    true, if the progress value should be shown. Otherwise, false.

    StartAngle

    Sets and get the start angle for circular progress bar component.

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

    Accepts an integer value that representing the start angle for circular progress bar component.

    Theme

    Sets and gets the options for customizing the theme of the progress bar component.

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

    Accepts a value from the Theme enum. The default value is Bootstrap4.

    TrackColor

    Gets and sets the track color of the progress bar component.

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

    Accepts the string value. The default value is empty.

    TrackThickness

    Gets and sets the track height of the progress bar component.

    Declaration
    public double TrackThickness { get; set; }
    Property Value
    Type
    System.Double

    Type

    Gets and sets the type (Linear or Circular) of the progress bar component.

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

    One of the ProgressType enumeration that specifies the type of progress bar. The default value is Linear.

    Value

    Gets and sets the progress value of the progress bar component.

    Declaration
    public double Value { get; set; }
    Property Value
    Type Description
    System.Double

    Accepts the double value representing the progress value of progress bar component.

    Visible

    Get and set a value that indicates whether the progress bar component is visible or hidden.

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

    Specifies the visibility of the progress bar. The default value is true.

    Width

    Gets and sets the width of the progress bar component.

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

    Accepts the string value.

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    OnAfterRenderAsync(Boolean)

    Method invoked after each time the component has been rendered.

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender

    Specifies the first render of the component.

    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing the asynchronous operation.

    Overrides
    SfBaseComponent.OnAfterRenderAsync(Boolean)

    OnInitializedAsync()

    Method invoked when the component is ready to start.

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing the asynchronous operation.

    Overrides
    SfBaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing the asynchronous operation.

    RefreshAsync()

    The method is used to re-render the progressbar component.

    Declaration
    public Task RefreshAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing the asynchronous operation.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved