Class RadStepProgressBarElement

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()

Declaration
public RadStepProgressBarElement()

Fields

ConnectionThicknessProperty

Declaration
public static RadProperty ConnectionThicknessProperty
Field Value
RadProperty

IndicatorSizeProperty

Declaration
public static RadProperty IndicatorSizeProperty
Field Value
RadProperty

OrientationProperty

Declaration
public static RadProperty OrientationProperty
Field Value
RadProperty

StepSpacingProperty

Declaration
public static RadProperty StepSpacingProperty
Field Value
RadProperty

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

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

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

ItemsContainer

The panel element holding the visual step items.

Declaration
public StepItemsContainer ItemsContainer { get; }
Property Value
StepItemsContainer

LayoutMode

Determines 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.

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

PreviousButton

Declaration
public StepNavigationButtonElement PreviousButton { get; }
Property Value
StepNavigationButtonElement

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 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)

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

Returns
System.Drawing.SizeF

Overrides

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.

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateNavigationElements()

Declaration
protected virtual void CreateNavigationElements()

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides

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.
Implements
System.Collections.IEnumerator.MoveNext()

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.
Implements

OnCurrentStepChanged()

Declaration
protected virtual void OnCurrentStepChanged()

OnNavigationButtonClicked()

Declaration
protected virtual void OnNavigationButtonClicked()

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnStepItemProgressChanged(StepProgressItem)

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

OnStepItemProgressChanging(StepProgressChangingEventArgs)

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

Reset()

Sets the current step to null.

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

ShouldArrangeChild(RadElement)

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

Returns
System.Boolean

Overrides

ShouldMeasureChild(RadElement)

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

Returns
System.Boolean

Overrides

UpdateNavigationGlyph(RadButtonElement)

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

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

Explicit Interface Implementations

IEnumerator.Current

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

Implements
System.Collections.IEnumerator.Current

IStepProgressItemsProvider.Center

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

Implements

Extension Methods