Class RadStepProgressBarElement

Represents the main visual element for the RadStepProgressBar control, providing step-based progress visualization with support for different layout modes and navigation.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadStepProgressBarElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadStepProgressBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IStepProgressItemsProvider, IStepItemEnumerator, IEnumerator<StepProgressItem>, IDisposable, IEnumerator

Constructors

RadStepProgressBarElement()

Initializes a new instance of the RadStepProgressBarElement class.

Declaration
public RadStepProgressBarElement()

Fields

ConnectionThicknessProperty

Identifies the ConnectionThickness dependency property that defines the thickness of connection lines between steps.

Declaration
public static RadProperty ConnectionThicknessProperty
Field Value
RadProperty

IndicatorSizeProperty

Identifies the IndicatorSize dependency property that defines the size of step indicators.

Declaration
public static RadProperty IndicatorSizeProperty
Field Value
RadProperty

OrientationProperty

Identifies the Orientation dependency property that defines the layout orientation of the step progress bar.

Declaration
public static RadProperty OrientationProperty
Field Value
RadProperty

StepSpacingProperty

Identifies the StepSpacing dependency property that defines the spacing between step items.

Declaration
public static RadProperty StepSpacingProperty
Field Value
RadProperty

Properties

ConnectionThickness

Gets or sets the thickness of the connection lines 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

Implements
System.Collections.Generic.IEnumerator<T>.Current

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

ItemsContainer

Gets the panel element that holds the visual step items.

Declaration
public StepItemsContainer ItemsContainer { get; }
Property Value
StepItemsContainer

LayoutMode

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

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

NavigationStep

Gets or sets the step used for scrolling the items in the Absolute layout mode.

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

NextButton

Declaration
public StepNavigationButtonElement NextButton { get; }
Property Value
StepNavigationButtonElement

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

PreviousButton

Declaration
public StepNavigationButtonElement PreviousButton { get; }
Property Value
StepNavigationButtonElement

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 virtual StepProgressMode ProgressMode { get; set; }
Property Value
StepProgressMode

Steps

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

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

Implements

StepSpacing

Gets or sets the spacing between the steps.

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

Methods

ArrangeNavigationButtons(RectangleF, ref Single, ref Single, ref Single)

Declaration
protected virtual void ArrangeNavigationButtons(RectangleF client, ref float stepItemsLength, ref float x, ref float y)
Parameters
System.Drawing.RectangleF client

System.Single stepItemsLength

System.Single x

System.Single y

ArrangeOverride(SizeF)

Arranges this element and its child elements within the specified size bounds.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size that this element should use to arrange itself and its children.
Returns
System.Drawing.SizeF

The actual size used by this element.
Overrides

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.

CreateChildElements()

Creates the child elements for this step progress bar element, including the items container and navigation elements.

Declaration
protected override void CreateChildElements()
Overrides

CreateNavigationElements()

Declaration
protected virtual void CreateNavigationElements()

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the desired size of this element and its child elements based on the available size.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size for this element.
Returns
System.Drawing.SizeF

The desired size of this element.
Overrides

MoveNext()

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

Declaration
public bool MoveNext()
Returns
System.Boolean

true if the current position has changed; otherwise, false.
Implements
System.Collections.IEnumerator.MoveNext()
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 in the collection.

Declaration
public bool MovePrevious()
Returns
System.Boolean

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

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

OnCurrentStepChanged()

Raises the current step changed event to notify subscribers that the current step has changed.

Declaration
protected virtual void OnCurrentStepChanged()

OnNavigationButtonClicked()

Declaration
protected virtual void OnNavigationButtonClicked()

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property changes for this element, particularly for layout-affecting properties in absolute layout mode.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The property change event arguments.
Overrides

OnStepItemProgressChanged(StepProgressItem)

Raises the step progress changed event to notify subscribers that a step's progress has been updated.

Declaration
protected virtual void OnStepItemProgressChanged(StepProgressItem item)
Parameters
StepProgressItem item

The step item whose progress has changed.

OnStepItemProgressChanging(StepProgressChangingEventArgs)

Raises the step progress changing event, allowing subscribers to cancel the progress change.

Declaration
protected virtual void OnStepItemProgressChanging(StepProgressChangingEventArgs args)
Parameters
StepProgressChangingEventArgs args

The event arguments containing the step and new progress value.

Reset()

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

Declaration
public void Reset()
Implements
System.Collections.IEnumerator.Reset()

ShouldArrangeChild(RadElement)

Determines whether a child element should be arranged during the layout process.

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

The child element to evaluate.
Returns
System.Boolean

true if the child should be arranged; otherwise, false.
Overrides

ShouldMeasureChild(RadElement)

Determines whether a child element should be measured during the layout process.

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

The child element to evaluate.
Returns
System.Boolean

true if the child should be measured; otherwise, false.
Overrides

UpdateNavigationGlyph(RadButtonElement)

Declaration
protected virtual void UpdateNavigationGlyph(RadButtonElement button)
Parameters
RadButtonElement button

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

Explicit Interface Implementations

IEnumerator.Current

Gets the current object in the collection for enumeration purposes.

Declaration
object IEnumerator.Current { get; }
Returns
System.Object

Implements
System.Collections.IEnumerator.Current

IStepProgressItemsProvider.Center

Gets the center position for step indicators used in layout calculations.

Declaration
float IStepProgressItemsProvider.Center { get; }
Returns
System.Single

Implements

Extension Methods