Class RadStepProgressBar

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.

Inheritance
System.Object
RadStepProgressBar
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.dll

Syntax

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

Constructors

RadStepProgressBar()

Initializes a new instance of the RadStepProgressBar class.

Declaration
public RadStepProgressBar()

Fields

AnimationDurationProperty

Identifies the AnimationDuration property.

Declaration
public static readonly DependencyProperty AnimationDurationProperty
Field Value
System.Windows.DependencyProperty

CanUserSelectProperty

Identifies the CanUserSelect property.

Declaration
public static readonly DependencyProperty CanUserSelectProperty
Field Value
System.Windows.DependencyProperty

CompleteAllPreviousStepsOnSelectionProperty

Identifies the CompleteAllPreviousStepsOnSelection property.

Declaration
public static readonly DependencyProperty CompleteAllPreviousStepsOnSelectionProperty
Field Value
System.Windows.DependencyProperty

ItemAdditionalContentStringFormatProperty

Identifies the ItemAdditionalContentStringFormat property.

Declaration
public static readonly DependencyProperty ItemAdditionalContentStringFormatProperty
Field Value
System.Windows.DependencyProperty

ItemAdditionalContentTemplateProperty

Identifies the ItemAdditionalContentTemplate property.

Declaration
public static readonly DependencyProperty ItemAdditionalContentTemplateProperty
Field Value
System.Windows.DependencyProperty

ItemAdditionalContentTemplateSelectorProperty

Identifies the ItemAdditionalContentTemplateSelector property.

Declaration
public static readonly DependencyProperty ItemAdditionalContentTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

OrientationProperty

Identifies the Orientation property.

Declaration
public static readonly DependencyProperty OrientationProperty
Field Value
System.Windows.DependencyProperty

OverallProgressProperty

Identifies the OverallProgress property.

Declaration
public static readonly DependencyProperty OverallProgressProperty
Field Value
System.Windows.DependencyProperty

ReverseVerticalDirectionProperty

Identifies the ReverseVerticalDirection property.

Declaration
public static readonly DependencyProperty ReverseVerticalDirectionProperty
Field Value
System.Windows.DependencyProperty

SelectedIndexProperty

Identifies the SelectedIndex property.

Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
System.Windows.DependencyProperty

SelectedItemProperty

Identifies the SelectedItem property.

Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
System.Windows.DependencyProperty

SelectedItemStatusProperty

Identifies the SelectedItemStatus property.

Declaration
public static readonly DependencyProperty SelectedItemStatusProperty
Field Value
System.Windows.DependencyProperty

StepSpacingProperty

Identifies the StepSpacing property.

Declaration
public static readonly DependencyProperty StepSpacingProperty
Field Value
System.Windows.DependencyProperty

TrackFillProperty

Identifies the TrackFill property.

Declaration
public static readonly DependencyProperty TrackFillProperty
Field Value
System.Windows.DependencyProperty

TrackThicknessProperty

Identifies the TrackThickness property.

Declaration
public static readonly DependencyProperty TrackThicknessProperty
Field Value
System.Windows.DependencyProperty

Properties

AnimationDuration

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

Declaration
public double AnimationDuration { get; set; }
Property Value
System.Double

CanUserSelect

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

Declaration
public bool CanUserSelect { get; set; }
Property Value
System.Boolean

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.

Declaration
public bool CompleteAllPreviousStepsOnSelection { get; set; }
Property Value
System.Boolean

ItemAdditionalContentStringFormat

Gets or sets the items' additional content string format.

Declaration
public string ItemAdditionalContentStringFormat { get; set; }
Property Value
System.String

ItemAdditionalContentTemplate

Gets or sets the items' additional content template.

Declaration
public DataTemplate ItemAdditionalContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

ItemAdditionalContentTemplateSelector

Gets or sets the items' additional content template selector.

Declaration
public DataTemplateSelector ItemAdditionalContentTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

Orientation

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

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

OverallProgress

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

Declaration
public double OverallProgress { get; }
Property Value
System.Double

ReverseVerticalDirection

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

Declaration
public bool ReverseVerticalDirection { get; set; }
Property Value
System.Boolean

SelectedIndex

Gets or sets the selected index.

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

SelectedItem

Gets or sets the selected item.

Declaration
public object SelectedItem { get; set; }
Property Value
System.Object

SelectedItemStatus

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

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

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.

Declaration
public double StepSpacing { get; set; }
Property Value
System.Double

TrackFill

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

Declaration
public Brush TrackFill { get; set; }
Property Value
System.Windows.Media.Brush

TrackThickness

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

Declaration
public double TrackThickness { get; set; }
Property Value
System.Double

Methods

ArrangeOverride(Size)

Declaration
protected override Size ArrangeOverride(Size arrangeBounds)
Parameters
System.Windows.Size arrangeBounds

Returns
System.Windows.Size

ClearContainerForItemOverride(DependencyObject, Object)

Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

System.Object item

GetContainerForItemOverride()

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

IsItemItsOwnContainerOverride(Object)

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

Returns
System.Boolean

MeasureOverride(Size)

Declaration
protected override Size MeasureOverride(Size constraint)
Parameters
System.Windows.Size constraint

Returns
System.Windows.Size

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

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

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

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

OnSelectionChanged(StepSelectionChangedEventArgs)

Called when selected item is changed.

Declaration
protected void OnSelectionChanged(StepSelectionChangedEventArgs args)
Parameters
StepSelectionChangedEventArgs args

OnStepItemClicked(RadStepProgressBarItem)

Called when a step item is clicked.

Declaration
protected virtual void OnStepItemClicked(RadStepProgressBarItem stepItem)
Parameters
RadStepProgressBarItem stepItem

PrepareContainerForItemOverride(DependencyObject, Object)

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

System.Object item

Events

SelectionChanged

Occurs when SelectedItem is changed.

Declaration
public event EventHandler<StepSelectionChangedEventArgs> SelectionChanged
Event Type
System.EventHandler<StepSelectionChangedEventArgs>

StepClicked

Occurs when RadStepProgressBarItem is clicked.

Declaration
public event EventHandler<StepClickedEventArgs> StepClicked
Event Type
System.EventHandler<StepClickedEventArgs>

Extension Methods