Class MudProgressLinear
- Namespace
- MudBlazor
- Assembly
- MudBlazor.dll
A line-shaped indicator of progress for an ongoing operation.
public class MudProgressLinear : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged
- Inheritance
-
MudProgressLinear
- Implements
- Inherited Members
- Extension Methods
Constructors
MudProgressLinear()
public MudProgressLinear()
Properties
Buffer
Displays an additional value ahead of Value.
[Parameter]
[Category("Behavior")]
public bool Buffer { get; set; }
Property Value
Remarks
Defaults to false
. When true
, the value of BufferValue is displayed.
BufferPercent
protected double BufferPercent { get; set; }
Property Value
BufferValue
The amount to display ahead of the value.
[Parameter]
[Category("Behavior")]
public double BufferValue { get; set; }
Property Value
Remarks
Defaults to 0
. Only shows when Buffer is true
and Indeterminate is false
. Typically a value greater than Value.
ChildContent
The content within this progress bar.
[Parameter]
[Category("Behavior")]
public RenderFragment? ChildContent { get; set; }
Property Value
Classname
protected string Classname { get; }
Property Value
Color
The color of this component.
[Parameter]
[Category("Appearance")]
public Color Color { get; set; }
Property Value
Remarks
Defaults to Default.
Indeterminate
Displays a constant animation without any value.
[Parameter]
[Category("Behavior")]
public bool Indeterminate { get; set; }
Property Value
Remarks
Defaults to false
. When true
, the Value will be ignored.
Max
The highest possible value.
[Parameter]
[Category("Behavior")]
public double Max { get; set; }
Property Value
Remarks
Defaults to 100.0
. Usually a percentage. Should be higher than Min.
Min
The lowest possible value.
[Parameter]
[Category("Behavior")]
public double Min { get; set; }
Property Value
Remarks
Defaults to 0.0
. Usually a percentage. Should be lower than Max.
Rounded
Displays a rounded border.
[Parameter]
[Category("Appearance")]
public bool Rounded { get; set; }
Property Value
Remarks
Defaults to false
in Rounded.
When true
, the CSS border-radius
is set to the theme's default value.
Size
The size of this component.
[Parameter]
[Category("Appearance")]
public Size Size { get; set; }
Property Value
Remarks
Defaults to Medium.
Striped
Displays animated stripes for the value portion of this progress bar.
[Parameter]
[Category("Appearance")]
public bool Striped { get; set; }
Property Value
Remarks
Default to false
.
Value
The current progress amount.
[Parameter]
[Category("Behavior")]
public double Value { get; set; }
Property Value
Remarks
Defaults to 0
. Only applies when Indeterminate is false
. Should be between Min and Max.
ValuePercent
protected double ValuePercent { get; set; }
Property Value
Vertical
Displays this progress bar vertically.
[Parameter]
[Category("Appearance")]
public bool Vertical { get; set; }
Property Value
Remarks
Defaults to false
.
Methods
BuildRenderTree(RenderTreeBuilder)
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
RenderTreeBuilder
GetBufferPercent()
The calculated buffer value percentage based on Min, Max, and BufferValue.
public double GetBufferPercent()
Returns
- double
A value between
0.0
and100.0
.
GetStyledBar1Transform()
Gets the CSS transform to apply based on the current value percentage.
public string GetStyledBar1Transform()
Returns
- string
A CSS transform.
GetStyledBar2Transform()
Gets the CSS transform to apply based on the current buffer value percentage.
public string GetStyledBar2Transform()
Returns
- string
A CSS transform.
GetValuePercent()
public double GetValuePercent()
Returns
- double
A value between
0.0
and100.0
.
UpdatePercentages()
protected void UpdatePercentages()