Class SfStepProgressBar

Represents the SfStepProgressBar class. The step progress bar provides a customizable visual that indicates the progress, step by step process.

Inheritance

System.Object

SfStepProgressBar

Namespace: Syncfusion.XForms.ProgressBar

Assembly: Syncfusion.SfProgressBar.XForms.dll

Syntax

public class SfStepProgressBar : Layout<View>, IParentThemeElement, IThemeElement

Constructors

SfStepProgressBar()

Initializes a new instance of the SfStepProgressBar class.

Declaration

public SfStepProgressBar()

Fields

CompletedStepStyleProperty

Identifies the CompletedStepStyle bindable property. This property can be used to apply style for StepView which are all in completed status.

Declaration

public static readonly BindableProperty CompletedStepStyleProperty

Field Value

Type
Xamarin.Forms.BindableProperty

InProgressStepStyleProperty

Identifies the InProgressStepStyle bindable property. This property can be used to apply style for StepView which are all in inprogress status.

Declaration

public static readonly BindableProperty InProgressStepStyleProperty

Field Value

Type
Xamarin.Forms.BindableProperty

LayoutOptionProperty

Identifies the LayoutOption bindable property. This property can be used to change the layout of SfStepProgressBar.

Declaration

public static readonly BindableProperty LayoutOptionProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NotStartedStepStyleProperty

Identifies the NotStartedStepStyle bindable property. This property can be used to apply style for StepView which are all in not started status.

Declaration

public static readonly BindableProperty NotStartedStepStyleProperty

Field Value

Type
Xamarin.Forms.BindableProperty

OrientationProperty

Identifies the StepOrientation bindable property. This property can be used to change the orientation of SfStepProgressBar.

Declaration

public static readonly BindableProperty OrientationProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ProgressAnimationDurationProperty

Identifies the ProgressAnimationDuration bindable property. This property can be used to change animation duration for each progress in StepView.

Declaration

public static readonly BindableProperty ProgressAnimationDurationProperty

Field Value

Type
Xamarin.Forms.BindableProperty

StepViewTappedCommandProperty

Identifies the StepViewTappedCommand bindable property. Triggers when step view is tapped.

Declaration

public static readonly BindableProperty StepViewTappedCommandProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TitleAlignmentProperty

Identifies the StepTitleAlignment bindable property. This property can be used to change the tite text alignment of each StepView.

Declaration

public static readonly BindableProperty TitleAlignmentProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TitleSpaceProperty

Identifies the TitleSpace bindable property. This property can be used to change the space between title and marker of each StepView.

Declaration

public static readonly BindableProperty TitleSpaceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

CompletedStepStyle

Gets or sets the completed StepStyle<T> for StepView.

Declaration

public StepStyle<CompletedStepState> CompletedStepStyle { get; set; }

Property Value

Type
StepStyle<CompletedStepState>

InProgressStepStyle

Gets or sets the inprogress StepStyle<T> for StepView.

Declaration

public StepStyle<InProgressStepState> InProgressStepStyle { get; set; }

Property Value

Type
StepStyle<InProgressStepState>

LayoutOption

Gets or sets the Justify content of SfStepProgressBar.

Declaration

public StepLayoutOptions LayoutOption { get; set; }

Property Value

Type
StepLayoutOptions

NotStartedStepStyle

Gets or sets the not started StepStyle<T> for StepView.

Declaration

public StepStyle<NotStartedStepState> NotStartedStepStyle { get; set; }

Property Value

Type
StepStyle<NotStartedStepState>

Orientation

Gets or sets the type of Orientation of the SfStepProgressBar.

Declaration

public StepOrientation Orientation { get; set; }

Property Value

Type
StepOrientation

ProgressAnimationDuration

Gets or sets the value for progress animation duration, while changing the status.

Declaration

public int ProgressAnimationDuration { get; set; }

Property Value

Type
System.Int32

StepViewTappedCommand

Gets or Sets set the Step view tapped command.

Declaration

public ICommand StepViewTappedCommand { get; set; }

Property Value

Type
System.Windows.Input.ICommand

TitleAlignment

Gets or sets the TitleAlignment of StepView's title.

Declaration

public StepTitleAlignment TitleAlignment { get; set; }

Property Value

Type
StepTitleAlignment

TitleSpace

Gets or sets the value for distance between marker and title text.

Declaration

public double TitleSpace { get; set; }

Property Value

Type
System.Double

Methods

LayoutChildren(Double, Double, Double, Double)

LayoutChildren override method for SfStepProgressBar.

Declaration

protected override void LayoutChildren(double x, double y, double width, double height)

Parameters

Type	Name	Description
System.Double	x	Offset x.
System.Double	y	Offset y.
System.Double	width	Width.
System.Double	height	Height.

OnChildAdded(Element)

OnChildAdded override method for SfStepProgressBar.

Declaration

protected override void OnChildAdded(Element child)

Parameters

Type	Name	Description
Xamarin.Forms.Element	child	Added child element.

OnChildRemoved(Element)

OnChildRemoved override method for SfStepProgressBar.

Declaration

protected override void OnChildRemoved(Element child)

Parameters

Type	Name	Description
Xamarin.Forms.Element	child	Removed child element.

OnMeasure(Double, Double)

OnMeasure override method for SfStepProgressBar.

Declaration

protected override SizeRequest OnMeasure(double widthConstraint, double heightConstraint)

Parameters

Type	Name	Description
System.Double	widthConstraint	Width constraint.
System.Double	heightConstraint	Height constraint.

Returns

Type	Description
Xamarin.Forms.SizeRequest	SfStepProgressBar maximum content size.

OnPropertyChanged(String)

Triggers when the property is changed.

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
System.String	propertyName	property name.

OnSizeAllocated(Double, Double)

OnSizeAllocate override method for SfStepProgressBar.

Declaration

protected override void OnSizeAllocated(double width, double height)

Parameters

Type	Name	Description
System.Double	width	Content width.
System.Double	height	Content height.

Events

StatusChanged

The status change event occurs when StepStatus property changed in StepView.

Declaration

public event EventHandler<StatusChangedEventArgs> StatusChanged

Event Type

Type
System.EventHandler<StatusChangedEventArgs>

StepTapped

The step tapped event occurs when marker in StepView was tapped.

Declaration

public event EventHandler<StepTappedEventArgs> StepTapped

Event Type

Type
System.EventHandler<StepTappedEventArgs>