Class RadStepProgressBar

Represents a visual control that displays a series of connected steps to indicate progress through a multi-step process or workflow.

Inheritance
System.Object
RadControl
RadStepProgressBar
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadStepProgressBar : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadStepProgressBar()

Declaration
public RadStepProgressBar()

Properties

ConnectionThickness

Gets or sets the thickness of the connections between steps.

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

Current

Gets the current step, which is the step that has its progress last updated or is last completed or cancelled.

Declaration
public StepProgressItem Current { get; }
Property Value
StepProgressItem

DefaultSize

Gets the default size for the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

EnableItemInProgressVisualState

Gets or sets a value indicating whether steps which are in progress (between 0 and 100) are visually indicated.

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

HideConnections

Gets or sets a value indicating whether the connection elements between steps will be hidden.

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

IndicatorSize

Gets or sets the size of the step indicators.

Declaration
public Size IndicatorSize { get; set; }
Property Value
System.Drawing.Size

LayoutMode

Gets or sets how the step items are measured and arranged in the available space.

Declaration
public StepLayoutMode LayoutMode { get; set; }
Property Value
StepLayoutMode

NavigationStep

Gets or sets the scroll step distance for the navigation buttons when they are visible in the Absolute layout mode.

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

Orientation

Gets or sets the orientation of the control, either horizontal or vertical.

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

ProgressMode

Gets or sets how the steps are related with regard to their progress. Changing this property will set the progress of all steps to 0.

Declaration
public StepProgressMode ProgressMode { get; set; }
Property Value
StepProgressMode

StepProgressBarElement

Gets the RadStepProgressBarElement that represents the main element of the control.

Declaration
public RadStepProgressBarElement StepProgressBarElement { get; }
Property Value
RadStepProgressBarElement

Steps

Gets a collection of StepProgressItem objects that represents the different steps of the progress bar.

Declaration
[RadEditItemsAction]
public RadItemOwnerGenericCollection<StepProgressItem> Steps { get; }
Property Value
RadItemOwnerGenericCollection<StepProgressItem>

StepSpacing

Gets or sets the spacing between the steps.

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

Methods

CancelAll()

Cancels all steps by setting their progress to 0.

Declaration
public bool CancelAll()
Returns
System.Boolean

true if all steps have their progress successfully set to 0; otherwise, false.

CancelStep(StepProgressItem)

Cancels the specified step by setting its progress to 0.

Declaration
public bool CancelStep(StepProgressItem step)
Parameters
StepProgressItem step

The step to be cancelled.
Returns
System.Boolean

true if the step's progress was successfully set to 0; otherwise, false.

CompleteAll()

Completes all steps by setting their progress to 100.

Declaration
public bool CompleteAll()
Returns
System.Boolean

true if all steps have their progress successfully set to 100; otherwise, false.

CompleteNext()

Completes the next step in the sequence. If the current step is not completed, sets its progress to 100. Otherwise, attempts to complete the next step if available.

Declaration
public bool CompleteNext()
Returns
System.Boolean

true if a step's progress was successfully set to 100; otherwise, false.

CompletePrevious()

Completes the previous step in the sequence by setting its progress to 100 and resets the current step's progress to 0.

Declaration
public bool CompletePrevious()
Returns
System.Boolean

true if the previous step's progress was successfully set to 100; otherwise, false.

CompleteStep(StepProgressItem)

Completes the specified step by setting its progress to 100.

Declaration
public bool CompleteStep(StepProgressItem step)
Parameters
StepProgressItem step

The step to be completed.
Returns
System.Boolean

true if the step's progress was successfully set to 100; otherwise, false.

CreateAccessibilityInstance()

Creates an accessibility instance for the control when accessibility objects are enabled.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

An accessibility object for this control.

CreateChildItems(RadElement)

Creates child elements for the control by adding the main step progress bar element to the root element.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to which child elements will be added.
Overrides

CreateStepProgressBarElement()

Creates and returns a new instance of RadStepProgressBarElement that represents the main element of the control.

Declaration
protected virtual RadStepProgressBarElement CreateStepProgressBarElement()
Returns
RadStepProgressBarElement

A new instance of RadStepProgressBarElement.

MoveNext()

Attempts to move the current step to the next available position.

Declaration
public bool MoveNext()
Returns
System.Boolean

true if the current position has changed; otherwise, false.
Remarks

In case there is no current, the next step will be the first item in the Steps collection. If the current step is at the end of the Steps collection, the position will not change

MovePrevious()

Attempts to move the current step to the previous available step.

Declaration
public bool MovePrevious()
Returns
System.Boolean

true if the current position has changed; otherwise, false.
Remarks

In case there is no current step or the current step is first inside the Steps collection, the position will not change.

Reset()

Resets the current step to null, clearing any current step selection.

Declaration
public void Reset()

ResetConnectionThickness()

Resets the ConnectionThickness property to its default value.

Declaration
public void ResetConnectionThickness()

ResetIndicatorSize()

Resets the IndicatorSize property to its default value.

Declaration
public void ResetIndicatorSize()

ResetOrientation()

Resets the Orientation property to its default value.

Declaration
public void ResetOrientation()

ResetStepSpacing()

Resets the StepSpacing property to its default value.

Declaration
public void ResetStepSpacing()

Events

CurrentChanged

Occurs when the Current property value changes.

Declaration
public event EventHandler CurrentChanged
Event Type
System.EventHandler

StepProgressChanged

Occurs when a StepProgressItem's progress value has been updated.

Declaration
public event StepProgressChangedEventHandler StepProgressChanged
Event Type
StepProgressChangedEventHandler

StepProgressChanging

Occurs before updating a StepProgressItem's progress value, allowing the operation to be canceled.

Declaration
public event StepProgressChangingEventHandler StepProgressChanging
Event Type
StepProgressChangingEventHandler

Extension Methods