WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfStepProgressBar

    Show / Hide Table of Contents

    Class SfStepProgressBar

    Inheritance
    System.Object
    SfStepProgressBar
    Namespace: Syncfusion.UI.Xaml.ProgressBar
    Assembly: Syncfusion.SfProgressBar.WPF.dll
    Syntax
    public class SfStepProgressBar : ItemsControl

    Constructors

    SfStepProgressBar()

    Initializes a new instance of the SfStepProgressBar class.

    Declaration
    public SfStepProgressBar()

    Fields

    ActiveConnectorColorProperty

    Identifies the ActiveConnectorColor dependency property.

    Declaration
    public static DependencyProperty ActiveConnectorColorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    AnimationDurationProperty

    Identifies the AnimationDurationProperty dependency property.

    Declaration
    public static DependencyProperty AnimationDurationProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ConnectorColorProperty

    Identifies the ConnectorColor dependency property.

    Declaration
    public static DependencyProperty ConnectorColorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ConnectorThicknessProperty

    Identifies the ConnectorThickness dependency property.

    Declaration
    public static DependencyProperty ConnectorThicknessProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ItemSpacingProperty

    Identifies the ItemSpacing dependency property.

    Declaration
    public static DependencyProperty ItemSpacingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ItemsStretchProperty

    Identifies the ItemsStretch dependency property.

    Declaration
    public static DependencyProperty ItemsStretchProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MarkerShapeTypeProperty

    Identifies the MarkerShapeType dependency property.

    Declaration
    public static DependencyProperty MarkerShapeTypeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MarkerTemplateSelectorProperty

    Identifies the MarkerTemplateSelector dependency property.

    Declaration
    public static DependencyProperty MarkerTemplateSelectorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MinimumItemSpacingProperty

    Identifies the MinimumItemSpacingProperty dependency property.

    Declaration
    public static DependencyProperty MinimumItemSpacingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    OrientationProperty

    Identifies the Orientation dependency property.

    Declaration
    public static DependencyProperty OrientationProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SecondaryContentTemplateProperty

    Identifies the SecondaryContentTemplate dependency property.

    Declaration
    public static DependencyProperty SecondaryContentTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SecondaryContentTemplateSelectorProperty

    Identifies the SecondaryContentTemplateSelector dependency property.

    Declaration
    public static DependencyProperty SecondaryContentTemplateSelectorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SelectedIndexProperty

    Identifies the SelectedIndex dependency property.

    Declaration
    public static DependencyProperty SelectedIndexProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SelectedItemProgressProgressProperty

    Identifies the SelectedItemProgress dependency property.

    Declaration
    public static DependencyProperty SelectedItemProgressProgressProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SelectedItemStatusProperty

    Identifies the SelectedItemStatus dependency property.

    Declaration
    public static DependencyProperty SelectedItemStatusProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    ActiveConnectorColor

    Gets or sets a brush that describes the connector (line that connecting neighboring step view items) color for active StepViewItem.

    Declaration
    public Brush ActiveConnectorColor { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush
    Remarks

    The ActiveConnectorColor works when the Status is Active or Indeterminate status.

    See Also
    ConnectorColor
    StepStatus

    AnimationDuration

    Declaration
    public TimeSpan AnimationDuration { get; set; }
    Property Value
    Type Description
    System.TimeSpan

    ConnectorColor

    Gets or sets a brush that describes the connector color of StepViewItem.

    Declaration
    public Brush ConnectorColor { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush
    Remarks

    The ConnectorColor works when the Status status is Inactive.

    See Also
    ActiveConnectorColor
    StepStatus

    ConnectorThickness

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

    ItemSpacing

    Gets or sets the spacing between the adjacent step view items in SfStepProgressBar.

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

    The default value is 40/>.

    Remarks

    The SfStepProgressBar control arranges its items based on ItemsStretch. The ItemSpacing works only when the ItemsStretch is None. The single step size is calculated using ItemSpacing and MarkerWidth or MarkerHeight based on Orientation. The ItemSpacing applies between the current step view item and previous step view item.

    See Also
    ItemsStretch

    ItemsStretch

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

    MarkerShapeType

    Gets or sets the shape of marker in StepViewItem.

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

    The default value of MarkerShapeType is Circle.

    MarkerTemplateSelector

    Declaration
    public DataTemplateSelector MarkerTemplateSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.DataTemplateSelector

    MinimumItemSpacing

    Gets or sets the value that indicates the minimum space between the step view items when is Fill.

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

    The default value of MinimumItemSpacing is 0.

    Remarks

    When the ItemsStretch is Fill, the space between the items sized to fill the available space. if the calculated spacing is less than the MinimumItemSpacing, then the minimum item spacing is used.

    See Also
    ItemSpacing
    ItemsStretch

    Orientation

    Gets or sets a value that indicates the orientation by which the step view items are stacked.

    Declaration
    public Orientation Orientation { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.Orientation

    The default value of Orientation is System.Windows.Controls.Orientation.Horizontal.

    SecondaryContentTemplate

    Declaration
    public DataTemplate SecondaryContentTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    SecondaryContentTemplateSelector

    Declaration
    public DataTemplateSelector SecondaryContentTemplateSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.DataTemplateSelector

    SelectedIndex

    Gets or sets the index of the last active (selected) item where items before this index will moved to active status.

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

    The default value is -1.

    Remarks

    The SelectedIndex is a zero-index property and sets the last active (selected) step view item. Based on the SelectedItemStatus property, the last selected item will be in active or indeterminate or inactive status. The items before the selected index will be in active status and the item after the selected index will be in inactive status.

    See Also
    SelectedItemStatus

    SelectedItemProgress

    Gets or sets the value that indicates the progress of StepViewItem.

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

    The default value of SelectedItemProgress is 100.

    Remarks

    The SelectedItemProgress works only when the SelectedItemStatus is Indeterminate or Inactive. When SelectedItemStatus is Active, the progress will always 100% regardless of this property.

    See Also
    SelectedItemStatus
    SelectedIndex
    StepStatus

    SelectedItemStatus

    Gets or sets the value that indicates the Status of last active (selected) StepViewItem.

    Declaration
    public StepStatus SelectedItemStatus { get; set; }
    Property Value
    Type Description
    StepStatus

    The default value of SelectedItemStatus is Active.

    Remarks

    The last selected item displays Active or Indeterminate or Inactive status based on SelectedItemStatus.

    See Also
    SelectedIndex
    StepStatus

    Methods

    GetContainerForItemOverride()

    Creates or identifies the element that is used to display the given item.

    Declaration
    protected override DependencyObject GetContainerForItemOverride()
    Returns
    Type Description
    System.Windows.DependencyObject

    The element that is used to display the given item.

    IsItemItsOwnContainerOverride(Object)

    Determines if the specified item is (or is eligible to be) its own container.

    Declaration
    protected override bool IsItemItsOwnContainerOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The item to check.

    Returns
    Type Description
    System.Boolean

    Returns true if the item is (or is eligible to be) its own container; otherwise, false.

    OnApplyTemplate()

    Declaration
    public override void OnApplyTemplate()

    OnItemsChanged(NotifyCollectionChangedEventArgs)

    Declaration
    protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
    Parameters
    Type Name Description
    System.Collections.Specialized.NotifyCollectionChangedEventArgs e

    PrepareContainerForItemOverride(DependencyObject, Object)

    Prepares the specified element to display the specified item.

    Declaration
    protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
    Parameters
    Type Name Description
    System.Windows.DependencyObject element

    Element used to display the specified item.

    System.Object item

    Specified item.

    Events

    MarkerClicked

    Occurs when the marker of step view item is clicked.

    Declaration
    public event EventHandler<MarkerClickedEventArgs> MarkerClicked
    Event Type
    Type Description
    System.EventHandler<MarkerClickedEventArgs>
    Examples
    stepProgressBar.MarkerClicked += StepProgressBar_MarkerClicked;
    private void StepProgressBar_MarkerClicked(object sender, Syncfusion.UI.Xaml.ProgressBar.MarkerClickedEventArgs e)
    {
       SfStepProgressBar stepProgressBar = (sender as SfStepProgressBar);
       stepProgressBar.SelectedIndex = stepProgressBar.Items.IndexOf(e.StepViewItem);
    }

    In the above code sample, passed sender as SfStepProgressBar.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved