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.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
[TelerikToolboxCategory("Data")]
public class RadStepProgressBar : ItemsControl

Inheritance: objectRadStepProgressBar

Constructors

RadStepProgressBar()

Initializes a new instance of the RadStepProgressBar class.

Declaration

cs-api-definition
public RadStepProgressBar()

Fields

AnimationDurationProperty

Identifies the AnimationDuration property.

Declaration

cs-api-definition
public static readonly DependencyProperty AnimationDurationProperty

Field Value

DependencyProperty

CanUserSelectProperty

Identifies the CanUserSelect property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanUserSelectProperty

Field Value

DependencyProperty

CompleteAllPreviousStepsOnSelectionProperty

Identifies the CompleteAllPreviousStepsOnSelection property.

Declaration

cs-api-definition
public static readonly DependencyProperty CompleteAllPreviousStepsOnSelectionProperty

Field Value

DependencyProperty

ItemAdditionalContentStringFormatProperty

Identifies the ItemAdditionalContentStringFormat property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemAdditionalContentStringFormatProperty

Field Value

DependencyProperty

ItemAdditionalContentTemplateProperty

Identifies the ItemAdditionalContentTemplate property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemAdditionalContentTemplateProperty

Field Value

DependencyProperty

ItemAdditionalContentTemplateSelectorProperty

Identifies the ItemAdditionalContentTemplateSelector property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemAdditionalContentTemplateSelectorProperty

Field Value

DependencyProperty

OrientationProperty

Identifies the Orientation property.

Declaration

cs-api-definition
public static readonly DependencyProperty OrientationProperty

Field Value

DependencyProperty

OverallProgressProperty

Identifies the OverallProgress property.

Declaration

cs-api-definition
public static readonly DependencyProperty OverallProgressProperty

Field Value

DependencyProperty

ReverseVerticalDirectionProperty

Identifies the ReverseVerticalDirection property.

Declaration

cs-api-definition
public static readonly DependencyProperty ReverseVerticalDirectionProperty

Field Value

DependencyProperty

SelectedIndexProperty

Identifies the SelectedIndex property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedIndexProperty

Field Value

DependencyProperty

SelectedItemProperty

Identifies the SelectedItem property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedItemProperty

Field Value

DependencyProperty

SelectedItemStatusProperty

Identifies the SelectedItemStatus property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedItemStatusProperty

Field Value

DependencyProperty

StepSpacingProperty

Identifies the StepSpacing property.

Declaration

cs-api-definition
public static readonly DependencyProperty StepSpacingProperty

Field Value

DependencyProperty

TrackFillProperty

Identifies the TrackFill property.

Declaration

cs-api-definition
public static readonly DependencyProperty TrackFillProperty

Field Value

DependencyProperty

TrackThicknessProperty

Identifies the TrackThickness property.

Declaration

cs-api-definition
public static readonly DependencyProperty TrackThicknessProperty

Field Value

DependencyProperty

Properties

AnimationDuration

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

Declaration

cs-api-definition
public double AnimationDuration { get; set; }

Property Value

double

CanUserSelect

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

Declaration

cs-api-definition
public bool CanUserSelect { get; set; }

Property Value

bool

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

cs-api-definition
public bool CompleteAllPreviousStepsOnSelection { get; set; }

Property Value

bool

ItemAdditionalContentStringFormat

Gets or sets the items' additional content string format.

Declaration

cs-api-definition
public string ItemAdditionalContentStringFormat { get; set; }

Property Value

string

ItemAdditionalContentTemplate

Gets or sets the items' additional content template.

Declaration

cs-api-definition
public DataTemplate ItemAdditionalContentTemplate { get; set; }

Property Value

DataTemplate

ItemAdditionalContentTemplateSelector

Gets or sets the items' additional content template selector.

Declaration

cs-api-definition
public DataTemplateSelector ItemAdditionalContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector

Orientation

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

Declaration

cs-api-definition
public Orientation Orientation { get; set; }

Property Value

Orientation

OverallProgress

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

Declaration

cs-api-definition
public double OverallProgress { get; }

Property Value

double

ReverseVerticalDirection

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

Declaration

cs-api-definition
public bool ReverseVerticalDirection { get; set; }

Property Value

bool

SelectedIndex

Gets or sets the selected index.

Declaration

cs-api-definition
public int SelectedIndex { get; set; }

Property Value

int

SelectedItem

Gets or sets the selected item.

Declaration

cs-api-definition
public object SelectedItem { get; set; }

Property Value

object

SelectedItemStatus

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

Declaration

cs-api-definition
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

cs-api-definition
public double StepSpacing { get; set; }

Property Value

double

TrackFill

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

Declaration

cs-api-definition
public Brush TrackFill { get; set; }

Property Value

Brush

TrackThickness

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

Declaration

cs-api-definition
public double TrackThickness { get; set; }

Property Value

double

Methods

ArrangeOverride(Size)

Declaration

cs-api-definition
protected override Size ArrangeOverride(Size arrangeBounds)

Parameters

arrangeBounds

Size

Returns

Size

ClearContainerForItemOverride(DependencyObject, object)

Declaration

cs-api-definition
protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

item

object

GetContainerForItemOverride()

Declaration

cs-api-definition
protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject

IsItemItsOwnContainerOverride(object)

Declaration

cs-api-definition
protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

item

object

Returns

bool

MeasureOverride(Size)

Declaration

cs-api-definition
protected override Size MeasureOverride(Size constraint)

Parameters

constraint

Size

Returns

Size

OnApplyTemplate()

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
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.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Declaration

cs-api-definition
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

e

NotifyCollectionChangedEventArgs

OnSelectionChanged(StepSelectionChangedEventArgs)

Called when selected item is changed.

Declaration

cs-api-definition
protected void OnSelectionChanged(StepSelectionChangedEventArgs args)

Parameters

args

StepSelectionChangedEventArgs

OnStepItemClicked(RadStepProgressBarItem)

Called when a step item is clicked.

Declaration

cs-api-definition
protected virtual void OnStepItemClicked(RadStepProgressBarItem stepItem)

Parameters

stepItem

RadStepProgressBarItem

PrepareContainerForItemOverride(DependencyObject, object)

Declaration

cs-api-definition
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

item

object

Events

SelectionChanged

Occurs when SelectedItem is changed.

Declaration

cs-api-definition
public event EventHandler<StepSelectionChangedEventArgs> SelectionChanged

Event Value

EventHandler<StepSelectionChangedEventArgs>

StepClicked

Occurs when RadStepProgressBarItem is clicked.

Declaration

cs-api-definition
public event EventHandler<StepClickedEventArgs> StepClicked

Event Value

EventHandler<StepClickedEventArgs>