Class SfProgressBar

The SfProgressBar control allows the user to notify the progress of a longer operation by animated UI.

Inheritance

System.Object

SfProgressBar

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Controls.Notification

Assembly: Syncfusion.SfProgressBar.UWP.dll

Syntax

[ClassReference(IsReviewed = false)]
public class SfProgressBar : ContentControl, IDisposable

Constructors

SfProgressBar()

Initializes a new instance of the SfProgressBar class.

Declaration

[ClassReference(IsReviewed = false)]
public SfProgressBar()

Fields

BackRimFillColorProperty

Using a DependencyProperty as the backing store for BackRimFillColor. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty BackRimFillColorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

BackRimRadiusProperty

Using a DependencyProperty as the backing store for BackRimRadius. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty BackRimRadiusProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

BackRimStrokeThicknessProperty

Using a DependencyProperty as the backing store for BackRimStrokeThickness. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty BackRimStrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CustomContentProperty

Using a DependencyProperty as the backing store for CustomContent. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty CustomContentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DisplayContentModeProperty

Using a DependencyProperty as the backing store for DisplayContentMode. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DisplayContentModeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DisplayContentStyleProperty

Using a DependencyProperty as the backing store for DisplayContentStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DisplayContentStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

FillColorProperty

Using a DependencyProperty as the backing store for FillColor. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty FillColorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

FillDirectionProperty

Using a DependencyProperty as the backing store for FillDirection. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty FillDirectionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

FillPathProperty

Using a DependencyProperty as the backing store for FillPath. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty FillPathProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IsDirectionReversedProperty

Using a DependencyProperty as the backing store for IsDirectionReversed. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty IsDirectionReversedProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

MaximumProperty

Using a DependencyProperty as the backing store for Maximum. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty MaximumProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

MinimumProperty

Using a DependencyProperty as the backing store for Minimum. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty MinimumProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PercentageProperty

Using a DependencyProperty as the backing store for Percentage. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty PercentageProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PercentageSymbolProperty

Using a DependencyProperty as the backing store for PercentageSymbol. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty PercentageSymbolProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressTypeProperty

Using a DependencyProperty as the backing store for ProgressType. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ProgressTypeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RadiusProperty

Using a DependencyProperty as the backing store for Radius. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RadiusProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SegmentCountProperty

Using a DependencyProperty as the backing store for SegmentCount. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SegmentCountProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SegmentHeightProperty

Using a DependencyProperty as the backing store for SegmentHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SegmentHeightProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SegmentSpacingProperty

Using a DependencyProperty as the backing store for SegmentSpacing. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SegmentSpacingProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SegmentWidthProperty

Using a DependencyProperty as the backing store for SegmentWidth. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SegmentWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShapeProperty

Using a DependencyProperty as the backing store for Shape. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ShapeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeThicknessProperty

Using a DependencyProperty as the backing store for StrokeThickness. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty StrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ValueProperty

Using a DependencyProperty as the backing store for Value. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ValueProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

BackRimFillColor

Gets or Sets the BackRimFillColor property.

Declaration

[ClassReference(IsReviewed = false)]
public Brush BackRimFillColor { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

BackRimRadius

Gets or Sets the BackRimRadius property.

Declaration

[ClassReference(IsReviewed = false)]
public double BackRimRadius { get; set; }

Property Value

Type
System.Double

BackRimStrokeThickness

Gets or Sets the BackRimStrokeThickness property.

Declaration

[ClassReference(IsReviewed = false)]
public double BackRimStrokeThickness { get; set; }

Property Value

Type
System.Double

CustomContent

Gets or Sets the CustomContent property.

Declaration

[ClassReference(IsReviewed = false)]
public object CustomContent { get; set; }

Property Value

Type
System.Object

DisplayContentMode

Gets or Sets the DisplayContentMode property.

Declaration

[ClassReference(IsReviewed = false)]
public DisplayContentMode DisplayContentMode { get; set; }

Property Value

Type
DisplayContentMode

DisplayContentStyle

Gets or Sets the DisplayContentStyle property.

Declaration

[ClassReference(IsReviewed = false)]
public Style DisplayContentStyle { get; set; }

Property Value

Type
Windows.UI.Xaml.Style

FillColor

Gets or Sets the FillColor property.

Declaration

[ClassReference(IsReviewed = false)]
public Brush FillColor { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

FillDirection

Gets or Sets the FillDirection property.

Declaration

[ClassReference(IsReviewed = false)]
public Directions FillDirection { get; set; }

Property Value

Type
Directions

FillPath

Gets or Sets the FillPath property.

Declaration

[ClassReference(IsReviewed = false)]
public string FillPath { get; set; }

Property Value

Type
System.String

IsDirectionReversed

Gets or Sets the IsDirectionReversed property.

Declaration

[ClassReference(IsReviewed = false)]
public bool IsDirectionReversed { get; set; }

Property Value

Type
System.Boolean

Maximum

Gets or Sets the Maximum property.

Declaration

[ClassReference(IsReviewed = false)]
public double Maximum { get; set; }

Property Value

Type
System.Double

Minimum

Gets or Sets the Minimum property.

Declaration

[ClassReference(IsReviewed = false)]
public double Minimum { get; set; }

Property Value

Type
System.Double

Percentage

Gets or Sets the Percentage property.

Declaration

[ClassReference(IsReviewed = false)]
public double Percentage { get; set; }

Property Value

Type
System.Double

PercentageSymbol

Gets or Sets the PercentageSymbol property.

Declaration

[ClassReference(IsReviewed = false)]
public string PercentageSymbol { get; set; }

Property Value

Type
System.String

ProgressType

Gets or Sets the ProgressType property.

Declaration

[ClassReference(IsReviewed = false)]
public ProgressTypes ProgressType { get; set; }

Property Value

Type
ProgressTypes

Radius

Gets or Sets the Radius property.

Declaration

[ClassReference(IsReviewed = false)]
public double Radius { get; set; }

Property Value

Type
System.Double

SegmentCount

Gets or Sets the SegmentCount property.

Declaration

[ClassReference(IsReviewed = false)]
public int SegmentCount { get; set; }

Property Value

Type
System.Int32

SegmentHeight

Gets or Sets the SegmentHeight property.

Declaration

[ClassReference(IsReviewed = false)]
public double SegmentHeight { get; set; }

Property Value

Type
System.Double

SegmentSpacing

Gets or Sets the SegmentSpacing property.

Declaration

[ClassReference(IsReviewed = false)]
public double SegmentSpacing { get; set; }

Property Value

Type
System.Double

SegmentWidth

Gets or Sets the SegmentWidth property.

Declaration

[ClassReference(IsReviewed = false)]
public double SegmentWidth { get; set; }

Property Value

Type
System.Double

Shape

Gets or Sets the Shape property.

Declaration

[ClassReference(IsReviewed = false)]
public Shapes Shape { get; set; }

Property Value

Type
Shapes

StrokeThickness

Gets or Sets the StrokeThickness property.

Declaration

[ClassReference(IsReviewed = false)]
public double StrokeThickness { get; set; }

Property Value

Type
System.Double

Value

Gets or Sets the Value property.

Declaration

[ClassReference(IsReviewed = false)]
public double Value { get; set; }

Property Value

Type
System.Double

Methods

add_ValueChanged(ValueChangedEventHandler)

Declaration

public void add_ValueChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
ValueChangedEventHandler	value

Dispose()

Declaration

public void Dispose()

Dispose(Boolean)

To remove all the instance which is used in SfAccordion

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnApplyTemplate()

Initializes all the child elements of SfProgressBar control.

Declaration

protected override void OnApplyTemplate()

Pause()

Pauses the progress animation

Declaration

[ClassReference(IsReviewed = false)]
public void Pause()

remove_ValueChanged(ValueChangedEventHandler)

Declaration

public void remove_ValueChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
ValueChangedEventHandler	value

Resume()

Resumes the progress animation

Declaration

[ClassReference(IsReviewed = false)]
public void Resume()

Stop()

Collapses the ProgressBar

Declaration

[ClassReference(IsReviewed = false)]
public void Stop()

Events

Completed

Completed event fires when ProgressBar Percentage property reaches 100

Declaration

public event RoutedEventHandler Completed

Event Type

Type
Windows.UI.Xaml.RoutedEventHandler

ValueChanged

ValueChanged event fires when ProgressBar Value property changes

Declaration

public event ValueChangedEventHandler ValueChanged

Event Type

Type
ValueChangedEventHandler

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)