Skip to main content

ProgressBar

C# API / Fluence.Wpf.Controls

  • Assembly: Fluence.Wpf
  • Namespace: Fluence.Wpf.Controls
public class ProgressBar : System.Windows.Controls.ProgressBar

Fluent-styled progress bar with determinate, indeterminate, error, and paused states plus an optional step mode.

Base type: System.Windows.Controls.ProgressBar (including inherited WPF and .NET members)

C# source

Constructors​

ProgressBar​

public ProgressBar()

Initializes a new instance of the ProgressBar class and subscribes to size changes for layout updates. Loaded and Unloaded are also wired so the repeat-forever indeterminate animation only runs while the control is in a live visual tree, mirroring ProgressRing.

Properties​

CornerRadius​

public CornerRadius CornerRadius { get; set; }

Gets or sets the corner radius of the progress indicator (the determinate fill and the indeterminate bars), matching the WinUI 3 default of 1.5.

CurrentStep​

public int CurrentStep { get; set; }

Gets or sets the current step in StepProgress mode.

ProgressMode​

public ProgressBarMode ProgressMode { get; set; }

Gets or sets the progress mode. This is a one-way backward-compatibility alias that maps onto the WinUI-orthogonal primitives IsIndeterminate, ShowError, and ShowPaused; changing those primitives does not write back to this property.

ShowError​

public bool ShowError { get; set; }

Gets or sets a value indicating whether the progress bar reports an error state. When set, the determinate fill and the indeterminate bars use the critical system brush, matching the WinUI 3 ProgressBar.ShowError contract. Takes precedence over ShowPaused.

ShowPaused​

public bool ShowPaused { get; set; }

Gets or sets a value indicating whether the progress bar reports a paused state. When set (and ShowError is not), the determinate fill and the indeterminate bars use the caution system brush, matching the WinUI 3 ProgressBar.ShowPaused contract.

ShowStepMarkers​

public bool ShowStepMarkers { get; set; }

Gets or sets whether the bar is notched at each step boundary while it is in step progress mode. Off by default: a step bar reads as one travelling fill unless a consumer asks for the segmented look. The notches cut through the track and the fill alike, so a step bar reads as a row of segments rather than one continuous bar. Ignored outside step progress mode, and by a bar with fewer than two steps, which has no interior boundary to mark.

Steps​

public int Steps { get; set; }

Gets or sets the total number of steps in StepProgress mode.

TrackHeight​

public double TrackHeight { get; set; }

Gets or sets the height of the thin baseline track behind the progress indicator, matching the WinUI 3 default of 1.

Methods​

OnApplyTemplate​

public override void OnApplyTemplate()

Documentation inherited from the ProgressBar API.

OnMaximumChanged​

protected override void OnMaximumChanged(double oldMaximum, double newMaximum)

Documentation inherited from the ProgressBar API.

OnMinimumChanged​

protected override void OnMinimumChanged(double oldMinimum, double newMinimum)

Documentation inherited from the ProgressBar API.

OnValueChanged​

protected override void OnValueChanged(double oldValue, double newValue)

Documentation inherited from the ProgressBar API.

Dependency property identifiers​

Use these identifiers with WPF property APIs. The matching CLR properties appear above when the control exposes them.

CornerRadiusProperty​

public static readonly DependencyProperty CornerRadiusProperty

Identifies the CornerRadius dependency property.

CurrentStepProperty​

public static readonly DependencyProperty CurrentStepProperty

Identifies the CurrentStep dependency property.

ProgressModeProperty​

public static readonly DependencyProperty ProgressModeProperty

Identifies the ProgressMode dependency property.

ShowErrorProperty​

public static readonly DependencyProperty ShowErrorProperty

Identifies the ShowError dependency property.

ShowPausedProperty​

public static readonly DependencyProperty ShowPausedProperty

Identifies the ShowPaused dependency property.

ShowStepMarkersProperty​

public static readonly DependencyProperty ShowStepMarkersProperty

Identifies the ShowStepMarkers dependency property.

StepsProperty​

public static readonly DependencyProperty StepsProperty

Identifies the Steps dependency property.

TrackHeightProperty​

public static readonly DependencyProperty TrackHeightProperty

Identifies the TrackHeight dependency property.