Back to all docs
API Reference / Telerik.Windows.Controls / RadStepProgressBar
New to Telerik UI for WPF? Start a free 30-day trial

RadStepProgressBar

Class

An ItemsControl representing a multi step process where moving to the next step increases the overall progress value. Generally steps have 3 major statuses - NotStarted, Completed and Indeterminate. Usually each step from the first to the current one is in Completed state and every other is in NotStarted state.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:
C#
[TelerikToolboxCategory("Data")]
public class RadStepProgressBar : ItemsControl

Inheritance: objectRadStepProgressBar

Constructors

RadStepProgressBar()

Initializes a new instance of the RadStepProgressBar class.

C#
public RadStepProgressBar()

Fields

AnimationDurationProperty

DependencyProperty

Identifies the AnimationDuration property.

C#
public static readonly DependencyProperty AnimationDurationProperty

CanUserSelectProperty

DependencyProperty

Identifies the CanUserSelect property.

C#
public static readonly DependencyProperty CanUserSelectProperty

CompleteAllPreviousStepsOnSelectionProperty

DependencyProperty

Identifies the CompleteAllPreviousStepsOnSelection property.

C#
public static readonly DependencyProperty CompleteAllPreviousStepsOnSelectionProperty

ItemAdditionalContentStringFormatProperty

DependencyProperty

Identifies the ItemAdditionalContentStringFormat property.

C#
public static readonly DependencyProperty ItemAdditionalContentStringFormatProperty

ItemAdditionalContentTemplateProperty

DependencyProperty

Identifies the ItemAdditionalContentTemplate property.

C#
public static readonly DependencyProperty ItemAdditionalContentTemplateProperty

ItemAdditionalContentTemplateSelectorProperty

DependencyProperty

Identifies the ItemAdditionalContentTemplateSelector property.

C#
public static readonly DependencyProperty ItemAdditionalContentTemplateSelectorProperty

OrientationProperty

DependencyProperty

Identifies the Orientation property.

C#
public static readonly DependencyProperty OrientationProperty

OverallProgressProperty

DependencyProperty

Identifies the OverallProgress property.

C#
public static readonly DependencyProperty OverallProgressProperty

ReverseVerticalDirectionProperty

DependencyProperty

Identifies the ReverseVerticalDirection property.

C#
public static readonly DependencyProperty ReverseVerticalDirectionProperty

SelectedIndexProperty

DependencyProperty

Identifies the SelectedIndex property.

C#
public static readonly DependencyProperty SelectedIndexProperty

SelectedItemProperty

DependencyProperty

Identifies the SelectedItem property.

C#
public static readonly DependencyProperty SelectedItemProperty

SelectedItemStatusProperty

DependencyProperty

Identifies the SelectedItemStatus property.

C#
public static readonly DependencyProperty SelectedItemStatusProperty

StepSpacingProperty

DependencyProperty

Identifies the StepSpacing property.

C#
public static readonly DependencyProperty StepSpacingProperty

TrackFillProperty

DependencyProperty

Identifies the TrackFill property.

C#
public static readonly DependencyProperty TrackFillProperty

TrackThicknessProperty

DependencyProperty

Identifies the TrackThickness property.

C#
public static readonly DependencyProperty TrackThicknessProperty

Properties

AnimationDuration

Gets or sets a value indicating the selection (value changing) animation duration in seconds.

C#
public double AnimationDuration { get; set; }

CanUserSelect

Gets or sets a value indicating whether the user can select step items with UI interactions.

C#
public bool CanUserSelect { get; set; }

CompleteAllPreviousStepsOnSelection

Gets or sets a value indicating whether al previous steps are set to Completed when new step is selected. If false, only the selected step is completed and also, there is no value animation.

C#
public bool CompleteAllPreviousStepsOnSelection { get; set; }

ItemAdditionalContentStringFormat

Gets or sets the items' additional content string format.

C#
public string ItemAdditionalContentStringFormat { get; set; }

ItemAdditionalContentTemplate

DataTemplate

Gets or sets the items' additional content template.

C#
public DataTemplate ItemAdditionalContentTemplate { get; set; }

ItemAdditionalContentTemplateSelector

DataTemplateSelector

Gets or sets the items' additional content template selector.

C#
public DataTemplateSelector ItemAdditionalContentTemplateSelector { get; set; }

Orientation

Orientation

Gets or sets a value indicating the orientation of the control.

C#
public Orientation Orientation { get; set; }

OverallProgress

Gets a value indicating the overall progress (0-100) of the RadStepProgressBar's process.

C#
public double OverallProgress { get; }

ReverseVerticalDirection

Gets or sets a value indicating the arrangement direction of items when the Orientation is vertical.

C#
public bool ReverseVerticalDirection { get; set; }

SelectedIndex

Gets or sets the selected index.

C#
public int SelectedIndex { get; set; }

SelectedItem

Gets or sets the selected item.

C#
public object SelectedItem { get; set; }

SelectedItemStatus

Gets or sets a value indicating the status of the item located at the SelectedIndex.

C#
public StepStatus SelectedItemStatus { get; set; }

StepSpacing

Gets or sets a value indicating the desired distance between the steps. When labels (main and secondary content) are too long, the actual distance might be bigger than the property value.

C#
public double StepSpacing { get; set; }

TrackFill

Brush

Gets or sets the foreground brush of the underlying progress bar track.

C#
public Brush TrackFill { get; set; }

TrackThickness

Gets or sets a value indicating the inner progress bar's height in horizontal orientation and width in vertical orientation.

C#
public double TrackThickness { get; set; }

Methods

ArrangeOverride(Size)

Size

C#
protected override Size ArrangeOverride(Size arrangeBounds)
Parameters:arrangeBoundsSizeReturns:

Size

ClearContainerForItemOverride(DependencyObject, object)

C#
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters:elementDependencyObjectitemobject

GetContainerForItemOverride()

DependencyObject

C#
protected override DependencyObject GetContainerForItemOverride()
Returns:

DependencyObject

IsItemItsOwnContainerOverride(object)

C#
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters:itemobjectReturns:

bool

MeasureOverride(Size)

Size

C#
protected override Size MeasureOverride(Size constraint)
Parameters:constraintSizeReturns:

Size

OnApplyTemplate()

C#
public override void OnApplyTemplate()

OnCreateAutomationPeer()

AutomationPeer

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

C#
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters:eNotifyCollectionChangedEventArgs

OnSelectionChanged(StepSelectionChangedEventArgs)

Called when selected item is changed.

C#
protected void OnSelectionChanged(StepSelectionChangedEventArgs args)
Parameters:argsStepSelectionChangedEventArgs

OnStepItemClicked(RadStepProgressBarItem)

Called when a step item is clicked.

C#
protected virtual void OnStepItemClicked(RadStepProgressBarItem stepItem)
Parameters:stepItemRadStepProgressBarItem

PrepareContainerForItemOverride(DependencyObject, object)

C#
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters:elementDependencyObjectitemobject

Events

SelectionChanged

Occurs when SelectedItem is changed.

C#
public event EventHandler<StepSelectionChangedEventArgs> SelectionChanged

StepClicked

Occurs when RadStepProgressBarItem is clicked.

C#
public event EventHandler<StepClickedEventArgs> StepClicked
In this article
DefinitionConstructorsRadStepProgressBar()FieldsAnimationDurationPropertyCanUserSelectPropertyCompleteAllPreviousStepsOnSelectionPropertyItemAdditionalContentStringFormatPropertyItemAdditionalContentTemplatePropertyItemAdditionalContentTemplateSelectorPropertyOrientationPropertyOverallProgressPropertyReverseVerticalDirectionPropertySelectedIndexPropertySelectedItemPropertySelectedItemStatusPropertyStepSpacingPropertyTrackFillPropertyTrackThicknessPropertyPropertiesAnimationDurationCanUserSelectCompleteAllPreviousStepsOnSelectionItemAdditionalContentStringFormatItemAdditionalContentTemplateItemAdditionalContentTemplateSelectorOrientationOverallProgressReverseVerticalDirectionSelectedIndexSelectedItemSelectedItemStatusStepSpacingTrackFillTrackThicknessMethodsArrangeOverride(Size)ClearContainerForItemOverride(DependencyObject, object)GetContainerForItemOverride()IsItemItsOwnContainerOverride(object)MeasureOverride(Size)OnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)OnItemsChanged(NotifyCollectionChangedEventArgs)OnSelectionChanged(StepSelectionChangedEventArgs)OnStepItemClicked(RadStepProgressBarItem)PrepareContainerForItemOverride(DependencyObject, object)EventsSelectionChangedStepClicked
Not finding the help you need?
Contact Support