ClassRadStepProgressBarElement
Represents the main visual element for the RadStepProgressBar control, providing step-based progress visualization with support for different layout modes and navigation.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadStepProgressBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IStepProgressItemsProvider, IStepItemEnumerator, IDisposable, IEnumeratorInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadStepProgressBarElement
Implements:
Inherited Members
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 ConnectionThicknessPropertyField Value
IndicatorSizeProperty
Identifies the IndicatorSize dependency property that defines the size of step indicators.
Declaration
public static RadProperty IndicatorSizePropertyField Value
OrientationProperty
Identifies the Orientation dependency property that defines the layout orientation of the step progress bar.
StepSpacingProperty
Identifies the StepSpacing dependency property that defines the spacing between step items.
Properties
ConnectionThickness
Gets or sets the thickness of the connection lines between steps.
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
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
HideConnections
Gets or sets a value indicating whether the connection elements between steps will be hidden.
IndicatorSize
Gets or sets the size of the step indicators.
ItemsContainer
Gets the panel element that holds the visual step items.
Declaration
public StepItemsContainer ItemsContainer { get; }Property Value
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
NavigationStep
Gets or sets the step used for scrolling the items in the Absolute layout mode.
NextButton
Declaration
public StepNavigationButtonElement NextButton { get; }Property Value
Orientation
Gets or sets the orientation of the control, either horizontal or vertical.
Declaration
public Orientation Orientation { get; set; }Property Value
PreviousButton
Declaration
public StepNavigationButtonElement PreviousButton { get; }Property Value
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
StepSpacing
Gets or sets the spacing between the steps.
Steps
Gets a collection of StepProgressItem objects that represents the different steps of the progress bar.
Declaration
public RadItemOwnerGenericCollection<StepProgressItem> Steps { get; }Property Value
Implements
Methods
ArrangeNavigationButtons(RectangleF, ref float, ref float, ref float)
Declaration
protected virtual void ArrangeNavigationButtons(RectangleF client, ref float stepItemsLength, ref float x, ref float y)Parameters
client
stepItemsLength
x
y
ArrangeOverride(SizeF)
Arranges this element and its child elements within the specified size bounds.
CancelAll()
Cancels all steps by setting their progress to 0.
Declaration
public bool CancelAll()Returns
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
step
The step to be cancelled.
Returns
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
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
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
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
step
The step to be completed.
Returns
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()
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
Declaration
protected override void InitializeFields()Overrides
MeasureOverride(SizeF)
Measures the desired size of this element and its child elements based on the available size.
MoveNext()
Attempts to move the current step to the next available position in the collection.
Declaration
public bool MoveNext()Returns
true if the current position has changed; otherwise, false.
Implements
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
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
e
The property change event arguments.
Overrides
OnStepClicked(StepClickedEventArgs)
Declaration
protected virtual void OnStepClicked(StepClickedEventArgs e)Parameters
e
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
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
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
ShouldArrangeChild(RadElement)
Determines whether a child element should be arranged during the layout process.
Declaration
protected override bool ShouldArrangeChild(RadElement child)Parameters
child
The child element to evaluate.
Returns
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
child
The child element to evaluate.
Returns
true if the child should be measured; otherwise, false.
Overrides
UpdateNavigationGlyph(RadButtonElement)
Declaration
protected virtual void UpdateNavigationGlyph(RadButtonElement button)Parameters
button
Events
CurrentChanged
Occurs when the Current property value changes.
StepClicked
Occurs when a step indicator is clicked.
Declaration
public event StepClickedEventHandler StepClickedEvent Value
StepProgressChanged
Occurs when a StepProgressItem's progress value has been updated.
Declaration
public event StepProgressChangedEventHandler StepProgressChangedEvent Value
StepProgressChanging
Occurs before updating a StepProgressItem's progress value, allowing the operation to be canceled.
Declaration
public event StepProgressChangingEventHandler StepProgressChangingEvent Value