menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfStepProgressBar - MAUI API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfStepProgressBar

    Represents a class for step progress bar.

    Inheritance
    System.Object
    SfView
    SfStepProgressBar
    Implements
    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<Microsoft.Maui.IView>
    System.Collections.Generic.ICollection<Microsoft.Maui.IView>
    System.Collections.Generic.IEnumerable<Microsoft.Maui.IView>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Inherited Members
    SfView.ArrangeOverride(Rect)
    SfView.Children
    SfView.ClipToBounds
    SfView.IDrawableLayout.DrawingOrder
    SfView.IDrawableLayout.InvalidateDrawable()
    SfView.MeasureOverride(Double, Double)
    SfView.OnBindingContextChanged()
    SfView.OnDraw(ICanvas, RectF)
    SfView.OnHandlerChanged()
    SfView.Padding
    Namespace: Syncfusion.Maui.ProgressBar
    Assembly: Syncfusion.Maui.ProgressBar.dll
    Syntax
    public class SfStepProgressBar : SfView, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider, IStepProgressBar, IParentThemeElement, IThemeElement
    Examples

    The following code demonstrates, how to bind ItemsSource and populate items in the step progressbar control.

    # [C#](#tab/tabid-1)
    public class ViewModel : INotifyPropertyChanged
    {
       private FormattedString orderFormattedString;
       private FormattedString shippedFormattedString;
       private FormattedString outForDeliveryFormattedString;
       private FormattedString deliveryFormattedString;
       private ObservableCollection<StepProgressBarItem> shipmentInfoCollection;
       public event PropertyChangedEventHandler? PropertyChanged;
       public ObservableCollection<StepProgressBarItem> ShipmentInfoCollection
       {
           get { return shipmentInfoCollection; }
           set
           {
               if (shipmentInfoCollection != value)
               {
                   shipmentInfoCollection = value;
                   OnPropertyChanged(nameof(ShipmentInfoCollection));
               }
           }
       }
    # [C#](#tab/tabid-2)
     public ViewModel()
    {
      var currentDate = DateTime.Now.AddDays(-2);
      orderFormattedString = new FormattedString();
       orderFormattedString.Spans.Add(new Span { Text = "Order Confirmed", FontSize = 15, TextColor = Color.FromRgb(28, 28, 28) });
       orderFormattedString.Spans.Add(new Span { Text = "\n ", FontSize = 10 });
       orderFormattedString.Spans.Add(new Span { Text = "\nYour Order has been placed.", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       orderFormattedString.Spans.Add(new Span { Text = "\n" + GetFormattedDateText(currentDate), FontSize = 13, TextColor = Color.FromRgb(99, 99, 99) });
       orderFormattedString.Spans.Add(new Span { Text = "\n ", FontSize = 10, });
       orderFormattedString.Spans.Add(new Span { Text = "\nSeller has processed your order.", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       orderFormattedString.Spans.Add(new Span { Text = "\n" + GetFormattedDateText(currentDate.AddHours(3)), FontSize = 13, TextColor = Color.FromRgb(99, 99, 99) });
       orderFormattedString.Spans.Add(new Span { Text = "\n ", FontSize = 10, });
       orderFormattedString.Spans.Add(new Span { Text = "\nYour item has been picked up by courier partner.", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       orderFormattedString.Spans.Add(new Span { Text = "\n" + GetFormattedDateText(currentDate.AddHours(5)), FontSize = 13, TextColor = Color.FromRgb(99, 99, 99) });
       shippedFormattedString = new FormattedString();
       shippedFormattedString.Spans.Add(new Span { Text = "Shipped", FontSize = 15, TextColor = Color.FromRgb(28, 28, 28) });
       shippedFormattedString.Spans.Add(new Span { Text = "\n ", FontSize = 10 });
       shippedFormattedString.Spans.Add(new Span { Text = "\nEDDY Fashion - FMPP1763973460", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       shippedFormattedString.Spans.Add(new Span { Text = "\nYour item has been shipped", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       shippedFormattedString.Spans.Add(new Span { Text = "\n" + GetFormattedDateText(currentDate.AddHours(5).AddMinutes(30)), FontSize = 13, TextColor = Color.FromRgb(99, 99, 99) });
       shippedFormattedString.Spans.Add(new Span { Text = "\n ", FontSize = 10, });
       shippedFormattedString.Spans.Add(new Span { Text = "\nYour item has been received in the hub nearest to you", FontSize = 12, TextColor = Color.FromRgb(39, 39, 39) });
       outForDeliveryFormattedString = new FormattedString();
       outForDeliveryFormattedString.Spans.Add(new Span { Text = "Out For Delivery", FontSize = 15, TextColor = Color.FromRgb(28, 28, 28) });
       outForDeliveryFormattedString.Spans.Add(new Span { Text = "\n", FontSize = 14 });
       outForDeliveryFormattedString.Spans.Add(new Span { Text = "\nYour item is out for delivery", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       outForDeliveryFormattedString.Spans.Add(new Span { Text = "\n" + GetFormattedDateText(currentDate.AddDays(2).AddHours(-2)), FontSize = 13, TextColor = Color.FromRgb(99, 99, 99) });
       deliveryFormattedString = new FormattedString();
       deliveryFormattedString.Spans.Add(new Span { Text = "Delivered", FontSize = 15, TextColor = Color.FromRgb(28, 28, 28) });
       deliveryFormattedString.Spans.Add(new Span { Text = "\n", FontSize = 14 });
       deliveryFormattedString.Spans.Add(new Span { Text = "\nYour item has been delivered", FontSize = 13, TextColor = Color.FromRgb(39, 39, 39) });
       deliveryFormattedString.Spans.Add(new Span { Text = "\n" + GetFormattedDateText(currentDate.AddDays(2)), FontSize = 13, TextColor = Color.FromRgb(99, 99, 99) });
       shipmentInfoCollection = new ObservableCollection<StepProgressBarItem>();
       shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = orderFormattedString });
       shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = shippedFormattedString });
       shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = outForDeliveryFormattedString });
       shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = deliveryFormattedString });
    }
    ]></code>
    # [XAML](#tab/tabid-3)
    <code><![CDATA[
    <progressBar:SfStepProgressBar BackgroundColor = "Transparent"
                                     ItemsSource="{Binding ShipmentInfoCollection}"
                                       Orientation="Vertical" x:Name="stepProgress"
                                       Margin="10"
                                       ActiveStepIndex="3"
                                       LabelSpacing="15"
                                       LabelPosition="End"
                                       ProgressAnimationDuration="2000">
    <progressBar:SfStepProgressBar.CompletedStepSettings>
    <progressBar:StepSettings Background = "Green" ProgressColor="Green"/>
    </progressBar:SfStepProgressBar.CompletedStepSettings>
    <progressBar:SfStepProgressBar.InProgressStepSettings>
    <progressBar:StepSettings ProgressColor = "Green" />
    </ progressBar:SfStepProgressBar.InProgressStepSettings>
    </progressBar:SfStepProgressBar>

    Constructors

    SfStepProgressBar()

    Initializes a new instance of the SfStepProgressBar class.

    Declaration
    public SfStepProgressBar()

    Fields

    ActiveStepIndexProperty

    Identifies the ActiveStepIndex dependency property.

    Declaration
    public static readonly BindableProperty ActiveStepIndexProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ActiveStepIndex dependency property.

    ActiveStepProgressValueProperty

    Identifies the ActiveStepProgressValue dependency property.

    Declaration
    public static readonly BindableProperty ActiveStepProgressValueProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ActiveStepProgressValue dependency property.

    CompletedStepSettingsProperty

    Identifies the CompletedStepSettings dependency property.

    Declaration
    public static readonly BindableProperty CompletedStepSettingsProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for CompletedStepSettings dependency property.

    InProgressStepSettingsProperty

    Identifies the InProgressStepSettings dependency property.

    Declaration
    public static readonly BindableProperty InProgressStepSettingsProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for InProgressStepSettings dependency property.

    ItemsSourceProperty

    Identifies the ItemsSource dependency property.

    Declaration
    public static readonly BindableProperty ItemsSourceProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ItemsSource dependency property.

    LabelPositionProperty

    Identifies the LabelPosition dependency property.

    Declaration
    public static readonly BindableProperty LabelPositionProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for LabelPosition dependency property.

    LabelSpacingProperty

    Identifies the LabelSpacing dependency property.

    Declaration
    public static readonly BindableProperty LabelSpacingProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for LabelSpacing dependency property.

    NotStartedStepSettingsProperty

    Identifies the NotStartedStepSettings dependency property.

    Declaration
    public static readonly BindableProperty NotStartedStepSettingsProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for NotStartedStepSettings dependency property.

    OrientationProperty

    Identifies the Orientation dependency property.

    Declaration
    public static readonly BindableProperty OrientationProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for Orientation dependency property.

    PrimaryTextTemplateProperty

    Identifies the PrimaryTextTemplate dependency property.

    Declaration
    public static readonly BindableProperty PrimaryTextTemplateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for PrimaryTextTemplate dependency property.

    ProgressAnimationDurationProperty

    Identifies the ProgressAnimationDuration dependency property.

    Declaration
    public static readonly BindableProperty ProgressAnimationDurationProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ProgressAnimationDuration dependency property.

    ProgressBarBackgroundProperty

    Identifies the ProgressBarBackground dependency property.

    Declaration
    public static readonly BindableProperty ProgressBarBackgroundProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ProgressBarBackground dependency property.

    SecondaryTextTemplateProperty

    Identifies the SecondaryTextTemplate dependency property.

    Declaration
    public static readonly BindableProperty SecondaryTextTemplateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for SecondaryTextTemplate dependency property.

    ShowToolTipProperty

    Identifies the ShowToolTip dependency property.

    Declaration
    public static readonly BindableProperty ShowToolTipProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ShowToolTip dependency property.

    StepContentSizeProperty

    Identifies the StepContentSize dependency property.

    Declaration
    public static readonly BindableProperty StepContentSizeProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for StepContentSize dependency property.

    StepSizeProperty

    Identifies the StepSize dependency property.

    Declaration
    public static readonly BindableProperty StepSizeProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for StepSize dependency property.

    StepStrokeWidthProperty

    Identifies the StepStrokeWidth dependency property.

    Declaration
    public static readonly BindableProperty StepStrokeWidthProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for StepStrokeWidth dependency property.

    StepTemplateProperty

    Identifies the StepTemplate dependency property.

    Declaration
    public static readonly BindableProperty StepTemplateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for StepTemplate dependency property.

    ToolTipSettingsProperty

    Identifies the ToolTipSettings dependency property.

    Declaration
    public static readonly BindableProperty ToolTipSettingsProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ToolTipSettings dependency property.

    ToolTipTemplateProperty

    Identifies the ToolTipTemplate dependency property.

    Declaration
    public static readonly BindableProperty ToolTipTemplateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ToolTipTemplate dependency property.

    Properties

    ActiveStepIndex

    Gets or sets the status of the step.

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

    The default value of ActiveStepIndex is ActiveStepIndex.

    Examples

    The following code demonstrates, how to use ActiveStepIndex in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         ActiveStepIndex="1"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.ActiveStepIndex = 1;
    See Also
    ActiveStepIndex

    ActiveStepProgressValue

    Gets or sets the progress value of the step.

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

    The default value of ActiveStepProgressValue is ActiveStepProgressValue.

    Examples

    The following code demonstrates, how to use ActiveStepProgressValue in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         ActiveStepProgressValue="5"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.ActiveStepProgressValue = 5;
    See Also
    ActiveStepProgressValue

    CompletedStepSettings

    Gets or sets the completed step style for the step progressbar.

    Declaration
    public StepSettings CompletedStepSettings { get; set; }
    Property Value
    Type Description
    StepSettings

    The default value of CompletedStepSettings is CompletedStepSettings.

    Examples

    The following code demonstrates, how to use CompletedStepSettings in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar">
    <progressBar:SfStepProgressBar.CompletedStepSettings>
      <progressBar:StepSettings Background="Green" ProgressColor="Green" ContentFillColor="Green" ContentType="Cross" Stroke="Purple" ShapeType="Circle"/>
    </progressBar:SfStepProgressBar.CompletedStepSettings> 
    </progressBar:SfStepProgressBar>
    • C#
    sfStepProgressBar.CompletedStepSettings.Background = Colors.Green;
    sfStepProgressBar.CompletedStepSettings.ProgressColor = Colors.Green;
    sfStepProgressBar.CompletedStepSettings.ContentFillColor = Colors.Green;
    sfStepProgressBar.CompletedStepSettings.ContentType = StepContentType.Cross;
    sfStepProgressBar.CompletedStepSettings.Stroke = Colors.Purple;
    sfStepProgressBar.CompletedStepSettings.ShapeType = StepShapeType.Circle;
    See Also
    CompletedStepSettings

    InProgressStepSettings

    Gets or sets the in progress step style.

    Declaration
    public StepSettings InProgressStepSettings { get; set; }
    Property Value
    Type Description
    StepSettings

    The default value of InProgressStepSettings is InProgressStepSettings.

    Examples

    The following code demonstrates, how to use InProgressStepSettings in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar">
    <progressBar:SfStepProgressBar.InProgressStepSettings>
      <progressBar:StepSettings Background="Green" ProgressColor="Green" ContentFillColor="Green" ContentType="Cross" Stroke="Purple" ShapeType="Circle"/>
    </progressBar:SfStepProgressBar.InProgressStepSettings> 
    </progressBar:SfStepProgressBar>
    • C#
    sfStepProgressBar.InProgressStepSettings.Background = Colors.Green;
    sfStepProgressBar.InProgressStepSettings.ProgressColor = Colors.Green;
    sfStepProgressBar.InProgressStepSettings.ContentFillColor = Colors.Green;
    sfStepProgressBar.InProgressStepSettings.ContentType = StepContentType.Cross;
    sfStepProgressBar.InProgressStepSettings.Stroke = Colors.Purple;
    sfStepProgressBar.InProgressStepSettings.ShapeType = StepShapeType.Circle;
    See Also
    InProgressStepSettings

    ItemsSource

    Gets or sets the item source.

    Declaration
    public object ItemsSource { get; set; }
    Property Value
    Type Description
    System.Object

    The default value of ItemsSource is System.DateTime.MinValue.

    Examples

    The following code demonstrates, how to use ItemsSource in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         ItemsSource="{Binding ShipmentInfoCollection}">
    </progressBar:SfStepProgressBar>
    • C#
    private ObservableCollection<StepProgressBarItem> shipmentInfoCollection;
    public ObservableCollection<StepProgressBarItem> ShipmentInfoCollection;
    shipmentInfoCollection = new ObservableCollection<StepProgressBarItem>();
    shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = "Orderd confirmed" });
    shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = "Shipped" });
    shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = "Out for delivery" });
    shipmentInfoCollection.Add(new StepProgressBarItem() { PrimaryFormattedText = "Delivered" });
    sfStepProgressBar.ItemsSource = shipmentInfoCollection;
    See Also
    ItemsSource

    LabelPosition

    Gets or sets the title alignment.

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

    The default value of LabelPosition is LabelPosition.

    Examples

    The following code demonstrates, how to use LabelPosition in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         LabelPosition="End">
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.LabelPosition = LabelPosition.End;
    See Also
    LabelPosition

    LabelSpacing

    Gets or sets the label spacing.

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

    The default value of LabelSpacing is LabelSpacing.

    Examples

    The following code demonstrates, how to use LabelSpacing in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         LabelSpacing="10">
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.LabelSpacing = 10;
    See Also
    LabelSpacing

    NotStartedStepSettings

    Gets or sets the not started step style.

    Declaration
    public StepSettings NotStartedStepSettings { get; set; }
    Property Value
    Type Description
    StepSettings

    The default value of NotStartedStepSettings is NotStartedStepSettings.

    Examples

    The following code demonstrates, how to use InProgressStepSettings in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar">
    <progressBar:SfStepProgressBar.NotStartedStepSettings>
      <progressBar:StepSettings Background="Green" ProgressColor="Green" ContentFillColor="Green" ContentType="Cross" Stroke="Purple" ShapeType="Circle"/>
    </progressBar:SfStepProgressBar.NotStartedStepSettings> 
    </progressBar:SfStepProgressBar>
    • C#
    sfStepProgressBar.NotStartedStepSettings.Background = Colors.Green;
    sfStepProgressBar.NotStartedStepSettings.ProgressColor = Colors.Green;
    sfStepProgressBar.NotStartedStepSettings.ContentFillColor = Colors.Green;
    sfStepProgressBar.NotStartedStepSettings.ContentType = StepContentType.Cross;
    sfStepProgressBar.NotStartedStepSettings.Stroke = Colors.Purple;
    sfStepProgressBar.NotStartedStepSettings.ShapeType = StepShapeType.Circle;
    See Also
    NotStartedStepSettings

    Orientation

    Gets or sets the orientation.

    Declaration
    public StepProgressBarOrientation Orientation { get; set; }
    Property Value
    Type Description
    StepProgressBarOrientation

    The default value of Orientation is Orientation.

    Examples

    The following code demonstrates, how to use Orientation in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         Orientation="Vertical">
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.Orientation = StepProgressBarOrientation.Vertical;
    See Also
    Orientation

    PrimaryTextTemplate

    Gets or sets the primary text template.

    Declaration
    public DataTemplate PrimaryTextTemplate { get; set; }
    Property Value
    Type
    Microsoft.Maui.Controls.DataTemplate

    ProgressAnimationDuration

    Gets or sets the progress animation duration.

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

    The default value of ProgressAnimationDuration is ProgressAnimationDuration.

    Examples

    The following code demonstrates, how to use Orientation in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         ProgressAnimationDuration="2000">
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.ProgressAnimationDuration = 2000;
    See Also
    ProgressAnimationDuration

    ProgressBarBackground

    Gets or sets the stroke color of the progress line.

    Declaration
    public Brush ProgressBarBackground { get; set; }
    Property Value
    Type Description
    Microsoft.Maui.Controls.Brush

    The default value of ProgressBarBackground is ProgressBarBackground.

    Examples

    The following code demonstrates, how to use StepStrokeWidth in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         ProgressBarBackground="Red"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.ProgressBarBackground = Colors.Red;
    See Also
    ProgressBarBackground

    SecondaryTextTemplate

    Gets or sets the secondary text template.

    Declaration
    public DataTemplate SecondaryTextTemplate { get; set; }
    Property Value
    Type
    Microsoft.Maui.Controls.DataTemplate

    ShowToolTip

    Gets or sets a value indicating whether to show the tooltip.

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

    The default value of ShowToolTip is ShowToolTip.

    Examples

    The following code demonstrates, how to use ShowToolTip in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         ShowToolTip="True"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.ShowToolTip = true;
    See Also
    ShowToolTip

    StepContentSize

    Gets or sets the content size of the step.

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

    The default value of StepContentSize is StepContentSize.

    Examples

    The following code demonstrates, how to use StepContentSize in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         StepContentSize="5"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.StepContentSize = 5;
    See Also
    StepContentSize

    StepSize

    Gets or sets the size of the step.

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

    The default value of StepContentSize is StepSize.

    Examples

    The following code demonstrates, how to use StepContentSize in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         StepContentSize="5"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.StepSize = 5;
    See Also
    StepContentSize

    StepStrokeWidth

    Gets or sets the stroke width of the marker.

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

    The default value of StepStrokeWidth is StepStrokeWidth.

    Examples

    The following code demonstrates, how to use StepStrokeWidth in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar"
                         StepStrokeWidth="15"/>
    </progressBar:SfStepProgressBar>
    • C#
    this.sfStepProgressBar.StepStrokeWidth = 15;
    See Also
    StepStrokeWidth

    StepTemplate

    Gets or sets the step template.

    Declaration
    public DataTemplate StepTemplate { get; set; }
    Property Value
    Type
    Microsoft.Maui.Controls.DataTemplate

    ToolTipSettings

    Gets or sets the tooltip settings.

    Declaration
    public StepProgressBarToolTipSettings ToolTipSettings { get; set; }
    Property Value
    Type Description
    StepProgressBarToolTipSettings

    The default value of ToolTipSettings is ToolTipSettings.

    Examples

    The following code demonstrates, how to use ToolTipSettings in the step progressbar #XAML

    <progressBar:SfStepProgressBar x:Name="sfStepProgressBar">
    <progressBar:SfStepProgressBar.ToolTipSettings>
      <progressBar:StepProgressBarToolTipSettings Background="Green" Duration="0:0:10" Stroke="Black"/>
    </progressBar:SfStepProgressBar.ToolTipSettings> 
    </progressBar:SfStepProgressBar>
    • C#
    sfStepProgressBar.ToolTipSettings.Background = Colors.Green;
    sfStepProgressBar.ToolTipSettings.Duration = new TimeSpan(0, 0, 10);
    sfStepProgressBar.NotStartedStepSettings.Stroke = Brush.Black;
    See Also
    ToolTipSettings

    ToolTipTemplate

    Gets or sets the tooltip template.

    Declaration
    public DataTemplate ToolTipTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.Maui.Controls.DataTemplate

    The default value of ToolTipTemplate is null.

    Examples

    The following code demonstrates, how to use the ToolTipTemplate property in the step progress bar. #XAML

    <progressBar:SfStepProgressBar x:Name= "sfStepProgressBar">
    <progressBar:SfStepProgressBar.ToolTipTemplate>
       <DataTemplate>
           <Grid>
              <Label Text="{Binding ToolTipText}"
                     TextColor="White"/>
           </Grid>
       </DataTemplate>
    </progressBar:SfStepProgressBar.ToolTipTemplate>
    </progressBar:SfStepProgressBar>
    • C#
    DataTemplate tooltipTemplate = new DataTemplate(() =>
    {
         Grid grid = new Grid();
         Label label = new Label
         {
             TextColor = Colors.White,
         };
    
         label.SetBinding(Label.TextProperty, new Binding("ToolTipText"));
         grid.Children.Add(label);
         return grid;
    });
    this.sfStepProgressBar.ToolTipTemplate = tooltipTemplate;

    Methods

    ArrangeContent(Rect)

    Method to arrange the content of the step progress bar.

    Declaration
    protected override Size ArrangeContent(Rect bounds)
    Parameters
    Type Name Description
    Microsoft.Maui.Graphics.Rect bounds

    The available bounds

    Returns
    Type Description
    Microsoft.Maui.Graphics.Size

    The actual size

    Overrides
    SfView.ArrangeContent(Rect)

    GetSemanticsNodesCore(Double, Double)

    Method to create the semantics node for each step view item.

    Declaration
    protected override List<SemanticsNode> GetSemanticsNodesCore(double width, double height)
    Parameters
    Type Name Description
    System.Double width

    The width.

    System.Double height

    The height.

    Returns
    Type Description
    System.Collections.Generic.List<Syncfusion.Maui.Graphics.Internals.SemanticsNode>

    Returns semantic virtual view.

    Overrides
    SfView.GetSemanticsNodesCore(Double, Double)

    MeasureContent(Double, Double)

    Method to measure the content of the step progress bar.

    Declaration
    protected override Size MeasureContent(double widthConstraint, double heightConstraint)
    Parameters
    Type Name Description
    System.Double widthConstraint

    The available width

    System.Double heightConstraint

    The available height

    Returns
    Type Description
    Microsoft.Maui.Graphics.Size

    The actual size

    Overrides
    SfView.MeasureContent(Double, Double)

    Events

    StepStatusChanged

    Occurs whenever the step status is changed.

    Declaration
    public event EventHandler<StepStatusChangedEventArgs> StepStatusChanged
    Event Type
    Type
    System.EventHandler<StepStatusChangedEventArgs>

    StepTapped

    Occurs whenever the step is tapped.

    Declaration
    public event EventHandler<StepTappedEventArgs> StepTapped
    Event Type
    Type
    System.EventHandler<StepTappedEventArgs>

    Implements

    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<>
    System.Collections.Generic.ICollection<>
    System.Collections.Generic.IEnumerable<>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved