ClassRadStepProgressBar
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:
[TelerikToolboxCategory("Data")]
public class RadStepProgressBar : ItemsControl
Inheritance: objectRadStepProgressBar
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
DependencyProperty
CanUserSelectProperty
Identifies the CanUserSelect property.
Declaration
public static readonly DependencyProperty CanUserSelectProperty
Field Value
DependencyProperty
CompleteAllPreviousStepsOnSelectionProperty
Identifies the CompleteAllPreviousStepsOnSelection property.
Declaration
public static readonly DependencyProperty CompleteAllPreviousStepsOnSelectionProperty
Field Value
DependencyProperty
ItemAdditionalContentStringFormatProperty
Identifies the ItemAdditionalContentStringFormat property.
Declaration
public static readonly DependencyProperty ItemAdditionalContentStringFormatProperty
Field Value
DependencyProperty
ItemAdditionalContentTemplateProperty
Identifies the ItemAdditionalContentTemplate property.
Declaration
public static readonly DependencyProperty ItemAdditionalContentTemplateProperty
Field Value
DependencyProperty
ItemAdditionalContentTemplateSelectorProperty
Identifies the ItemAdditionalContentTemplateSelector property.
Declaration
public static readonly DependencyProperty ItemAdditionalContentTemplateSelectorProperty
Field Value
DependencyProperty
OrientationProperty
Identifies the Orientation property.
Declaration
public static readonly DependencyProperty OrientationProperty
Field Value
DependencyProperty
OverallProgressProperty
Identifies the OverallProgress property.
Declaration
public static readonly DependencyProperty OverallProgressProperty
Field Value
DependencyProperty
ReverseVerticalDirectionProperty
Identifies the ReverseVerticalDirection property.
Declaration
public static readonly DependencyProperty ReverseVerticalDirectionProperty
Field Value
DependencyProperty
SelectedIndexProperty
Identifies the SelectedIndex property.
Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
DependencyProperty
SelectedItemProperty
Identifies the SelectedItem property.
Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
DependencyProperty
SelectedItemStatusProperty
Identifies the SelectedItemStatus property.
Declaration
public static readonly DependencyProperty SelectedItemStatusProperty
Field Value
DependencyProperty
StepSpacingProperty
Identifies the StepSpacing property.
Declaration
public static readonly DependencyProperty StepSpacingProperty
Field Value
DependencyProperty
TrackFillProperty
Identifies the TrackFill property.
Declaration
public static readonly DependencyProperty TrackFillProperty
Field Value
DependencyProperty
TrackThicknessProperty
Identifies the TrackThickness property.
Declaration
public static readonly DependencyProperty TrackThicknessProperty
Field Value
DependencyProperty
Properties
AnimationDuration
Gets or sets a value indicating the selection (value changing) animation duration in seconds.
CanUserSelect
Gets or sets a value indicating whether the user can select step items with UI interactions.
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
ItemAdditionalContentStringFormat
Gets or sets the items' additional content string format.
Declaration
public string ItemAdditionalContentStringFormat { get; set; }
Property Value
ItemAdditionalContentTemplate
Gets or sets the items' additional content template.
Declaration
public DataTemplate ItemAdditionalContentTemplate { get; set; }
Property Value
DataTemplate
ItemAdditionalContentTemplateSelector
Gets or sets the items' additional content template selector.
Declaration
public DataTemplateSelector ItemAdditionalContentTemplateSelector { get; set; }
Property Value
DataTemplateSelector
Orientation
Gets or sets a value indicating the orientation of the control.
Declaration
public Orientation Orientation { get; set; }
Property Value
Orientation
OverallProgress
Gets a value indicating the overall progress (0-100) of the RadStepProgressBar's process.
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
SelectedIndex
Gets or sets the selected index.
SelectedItem
Gets or sets the selected item.
SelectedItemStatus
Gets or sets a value indicating the status of the item located at the SelectedIndex.
Declaration
public StepStatus SelectedItemStatus { get; set; }
Property Value
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.
TrackFill
Gets or sets the foreground brush of the underlying progress bar track.
Declaration
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.
Methods
ArrangeOverride(Size)
Declaration
protected override Size ArrangeOverride(Size arrangeBounds)
Parameters
arrangeBounds
Size
Returns
Size
ClearContainerForItemOverride(DependencyObject, object)
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
item
GetContainerForItemOverride()
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
DependencyObject
MeasureOverride(Size)
Declaration
protected override Size MeasureOverride(Size constraint)
Parameters
constraint
Size
Returns
Size
OnApplyTemplate()
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
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
protected override void OnInitialized(EventArgs e)
Parameters
e
The RoutedEventArgs that contains the event data.
OnItemsChanged(NotifyCollectionChangedEventArgs)
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
e
OnSelectionChanged(StepSelectionChangedEventArgs)
Called when selected item is changed.
Declaration
protected void OnSelectionChanged(StepSelectionChangedEventArgs args)
Parameters
args
OnStepItemClicked(RadStepProgressBarItem)
Called when a step item is clicked.
Declaration
protected virtual void OnStepItemClicked(RadStepProgressBarItem stepItem)
Parameters
stepItem
PrepareContainerForItemOverride(DependencyObject, object)
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
item
Events
SelectionChanged
Occurs when SelectedItem is changed.
Declaration
public event EventHandler<StepSelectionChangedEventArgs> SelectionChanged
Event Value
StepClicked
Occurs when RadStepProgressBarItem is clicked.
Declaration
public event EventHandler<StepClickedEventArgs> StepClicked
Event Value