Class RadStepProgressBar

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.

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

Current

Gets the current step. That is the step which has its progress last updated or it is last completed or cancelled.

Declaration
public StepProgressItem Current { get; }
Property Value
StepProgressItem

DefaultSize

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

EnableItemInProgressVisualState

Determines 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 whether the connection elements 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

Determines how the step items are measured and arranged in the available space.

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

NavigationStep

Determines the scroll step of 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.

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

ProgressMode

Determines how the steps are related with regard to their progress. Changing the 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()

Sets the progress of all steps to 0.

Declaration
public bool CancelAll()
Returns
System.Boolean

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

CancelStep(StepProgressItem)

Sets the progress of the step to 0.

Declaration
public bool CancelStep(StepProgressItem step)
Parameters
StepProgressItem step

The step which will have its progress set to 0.
Returns
System.Boolean

True if the step has its progress 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()

If the current step is not completed sets its progress 100. Otherwise tries to complete the next step if there is such.

Declaration
public bool CompleteNext()
Returns
System.Boolean

True if there is a next step and its progress is successfully set to 100, otherwise false.

CompletePrevious()

Sets the progress of the current step to 0 and completes the previous step if there is such.

Declaration
public bool CompletePrevious()
Returns
System.Boolean

True if there is a previous step and its progess is successfully set to 100, otherwise false.

CompleteStep(StepProgressItem)

Completes the step by setting its progress to 100.

Declaration
public bool CompleteStep(StepProgressItem step)
Parameters
StepProgressItem step

The step which will be completed.
Returns
System.Boolean

True if the step has its progress successfully set to 100, otherwise false.

CreateAccessibilityInstance()

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

CreateChildItems(RadElement)

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

Overrides

CreateStepProgressBarElement()

Declaration
protected virtual RadStepProgressBarElement CreateStepProgressBarElement()
Returns
RadStepProgressBarElement

MoveNext()

Tries to move the Current to the next available position. 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.

Declaration
public bool MoveNext()
Returns
System.Boolean

True if the current has changed.

MovePrevious()

Tries to move the current to the previous available step. In case there is no current step or the current step is first inside the Steps collection, the position will not change.

Declaration
public bool MovePrevious()
Returns
System.Boolean

True if the position current has changed.

Reset()

Sets the current step to null.

Declaration
public void Reset()

ResetConnectionThickness()

Resets the ConnectionThickness property to the default value.

Declaration
public void ResetConnectionThickness()

ResetIndicatorSize()

Resets the IndicatorSize property to the default value.

Declaration
public void ResetIndicatorSize()

ResetOrientation()

Resets the Orientation property to the default value.

Declaration
public void ResetOrientation()

ResetStepSpacing()

Resets the StepSpacing property to the default value.

Declaration
public void ResetStepSpacing()

Events

CurrentChanged

Fires after the Current changes.

Declaration
public event EventHandler CurrentChanged
Event Type
System.EventHandler

StepProgressChanged

Fires when a StepProgressItem's Progress has been updated.

Declaration
public event StepProgressChangedEventHandler StepProgressChanged
Event Type
StepProgressChangedEventHandler

StepProgressChanging

Fires before updating a StepProgressItem's Progress.

Declaration
public event StepProgressChangingEventHandler StepProgressChanging
Event Type
StepProgressChangingEventHandler

Extension Methods