RadStepProgressBar
Represents a visual control that displays a series of connected steps to indicate progress through a multi-step process or workflow.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadStepProgressBar : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadStepProgressBar...
Implements:
Inherited Members
Constructors
public RadStepProgressBar()Properties
Gets or sets the thickness of the connections between steps.
public int ConnectionThickness { get; set; }Gets the current step, which is the step that has its progress last updated or is last completed or cancelled.
[Browsable(false)]
public StepProgressItem Current { get; }Gets the default size for the control.
protected override Size DefaultSize { get; }Overrides:
Gets or sets a value indicating whether steps which are in progress (between 0 and 100) are visually indicated.
public bool EnableItemInProgressVisualState { get; set; }Gets or sets a value indicating whether the connection elements between steps will be hidden.
public bool HideConnections { get; set; }Gets or sets the size of the step indicators.
public Size IndicatorSize { get; set; }Gets or sets how the step items are measured and arranged in the available space.
public StepLayoutMode LayoutMode { get; set; }Gets or sets the scroll step distance for the navigation buttons when they are visible in the Absolute layout mode.
public int NavigationStep { get; set; }Gets or sets the orientation of the control, either horizontal or vertical.
public Orientation Orientation { get; set; }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.
public StepProgressMode ProgressMode { get; set; }Gets the RadStepProgressBarElement that represents the main element of the control.
[Browsable(false)]
public RadStepProgressBarElement StepProgressBarElement { get; }Gets a collection of StepProgressItem objects that represents the different steps of the progress bar.
[Browsable(true)]
[RadEditItemsAction]
public RadItemOwnerGenericCollection<StepProgressItem> Steps { get; }Gets or sets the spacing between the steps.
public int StepSpacing { get; set; }Methods
Cancels all steps by setting their progress to 0.
public bool CancelAll()true if all steps have their progress successfully set to 0; otherwise, false.
Cancels the specified step by setting its progress to 0.
public bool CancelStep(StepProgressItem step)The step to be cancelled.
Returns:true if the step's progress was successfully set to 0; otherwise, false.
Completes all steps by setting their progress to 100.
public bool CompleteAll()true if all steps have their progress successfully set to 100; otherwise, false.
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.
public bool CompleteNext()true if a step's progress was successfully set to 100; otherwise, false.
Completes the previous step in the sequence by setting its progress to 100 and resets the current step's progress to 0.
public bool CompletePrevious()true if the previous step's progress was successfully set to 100; otherwise, false.
Completes the specified step by setting its progress to 100.
public bool CompleteStep(StepProgressItem step)The step to be completed.
Returns:true if the step's progress was successfully set to 100; otherwise, false.
Creates an accessibility instance for the control when accessibility objects are enabled.
protected override AccessibleObject CreateAccessibilityInstance()An accessibility object for this control.
Overrides:
Creates child elements for the control by adding the main step progress bar element to the root element.
protected override void CreateChildItems(RadElement parent)The parent element to which child elements will be added.
Overrides:
Creates and returns a new instance of RadStepProgressBarElement that represents the main element of the control.
protected virtual RadStepProgressBarElement CreateStepProgressBarElement()A new instance of RadStepProgressBarElement.
Attempts to move the current step to the next available position.
public bool MoveNext()true if the current position has changed; otherwise, false.
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
Attempts to move the current step to the previous available step.
public bool MovePrevious()true if the current position has changed; otherwise, false.
In case there is no current step or the current step is first inside the Steps collection, the position will not change.
Resets the current step to null, clearing any current step selection.
public void Reset()Resets the ConnectionThickness property to its default value.
public void ResetConnectionThickness()Resets the IndicatorSize property to its default value.
public void ResetIndicatorSize()Resets the Orientation property to its default value.
public void ResetOrientation()Resets the StepSpacing property to its default value.
public void ResetStepSpacing()Events
Occurs when the Current property value changes.
public event EventHandler CurrentChangedOccurs when a step indicator is clicked.
public event StepClickedEventHandler StepClickedOccurs when a StepProgressItem's progress value has been updated.
public event StepProgressChangedEventHandler StepProgressChangedOccurs before updating a StepProgressItem's progress value, allowing the operation to be canceled.
public event StepProgressChangingEventHandler StepProgressChanging