Class StepProgressItem

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
StepProgressItem
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 StepProgressItem : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

StepProgressItem()

Declaration
public StepProgressItem()

Fields

CompletedProperty

Declaration
public static RadProperty CompletedProperty
Field Value
RadProperty

ConnectionLengthProperty

Declaration
public static RadProperty ConnectionLengthProperty
Field Value
RadProperty

ConnectionThicknessProperty

Declaration
public static RadProperty ConnectionThicknessProperty
Field Value
RadProperty

IndicatorSizeProperty

Declaration
public static RadProperty IndicatorSizeProperty
Field Value
RadProperty

InProgressProperty

Declaration
public static RadProperty InProgressProperty
Field Value
RadProperty

IsActiveProperty

Declaration
public static RadProperty IsActiveProperty
Field Value
RadProperty

IsErrorProperty

Declaration
public static RadProperty IsErrorProperty
Field Value
RadProperty

OrientationProperty

Declaration
public static RadProperty OrientationProperty
Field Value
RadProperty

Properties

Completed

Gets or sets whether the step is completed. Setting this property also changes the step's Progress. If the property is set to false, the step's progress will change to 0.

Declaration
public bool Completed { get; set; }
Property Value
System.Boolean

Connection

Gets the connection element.

Declaration
public StepConnectionElement Connection { get; }
Property Value
StepConnectionElement

ConnectionLength

Gets or sets the length of the connection. If you use this property to set the step spacing, the property will unbind from the StepSpacing property. In order to bind it again, you need to reset the property, using ResetConnectionLength() method.

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

ConnectionThickness

Gets or sets the thickness of the connection. If you use this property to set the step spacing, the property will unbind from the ConnectionThickness property. In order to bind it again, you need to reset the property, using ResetConnectionThickness() method.

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

EnableItemInProgressVisualState

Determines whether there is a separate visual state of the step when its progress is between 0 and 100.

Declaration
public bool EnableItemInProgressVisualState { get; set; }
Property Value
System.Boolean

FirstContentElement

Gets the first content element.

Declaration
public StepContentElement FirstContentElement { get; }
Property Value
StepContentElement

FirstDescription

Gets or sets the description of the first content element.

Declaration
public string FirstDescription { get; set; }
Property Value
System.String

FirstHeader

Gets or sets the header of the first content element.

Declaration
public string FirstHeader { get; set; }
Property Value
System.String

IndicatorSize

Gets or sets the step size. If you use this property to set the step size, the property will unbind from the IndicatorSize property. In order to bind it again, you need to reset the property, using ResetIndicatorSize() method.

Declaration
public Size IndicatorSize { get; set; }
Property Value
System.Drawing.Size

IsError

Gets or sets whether the item is in error state. If yes, the progress will change to 0.

Declaration
public bool IsError { get; set; }
Property Value
System.Boolean

IsFirst

Determines if the step is first.

Declaration
public bool IsFirst { get; }
Property Value
System.Boolean

IsLast

Determines if the step is last.

Declaration
public bool IsLast { get; }
Property Value
System.Boolean

Next

Gets the next step.

Declaration
public StepProgressItem Next { get; }
Property Value
StepProgressItem

Orientation

Gets or sets the orientation of the step item. If you use this property to set the step spacing, the property will unbind from the Orientation property. In order to bind it again, you need to reset the property, using ResetOrientation() method.

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

Previous

Gets the previous step.

Declaration
public StepProgressItem Previous { get; }
Property Value
StepProgressItem

Progress

Gets or sets the progress of the step. Setting the progress of an item may affect the progress of the other items. This behavior is controlled by the StepProgressMode enum set on the element's ProgressMode property.

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

ProgressStatus

Gets the prgress status.

Declaration
public StepProgressStatus ProgressStatus { get; }
Property Value
StepProgressStatus

SecondContentElement

Gets the second content element.

Declaration
public StepContentElement SecondContentElement { get; }
Property Value
StepContentElement

SecondDescription

Gets or sets the description of the second content element.

Declaration
public string SecondDescription { get; set; }
Property Value
System.String

SecondHeader

Gets or sets the header of the second content element.

Declaration
public string SecondHeader { get; set; }
Property Value
System.String

StepIndicator

Gets this indicator element.

Declaration
public StepItemIndicatorElement StepIndicator { get; }
Property Value
StepItemIndicatorElement

Methods

ArrangeOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateConnectionElement()

Declaration
protected virtual StepConnectionElement CreateConnectionElement()
Returns
StepConnectionElement

CreateFirstContentElement()

Declaration
protected virtual StepContentElement CreateFirstContentElement()
Returns
StepContentElement

CreateIndicatorElement()

Declaration
protected virtual StepItemIndicatorElement CreateIndicatorElement()
Returns
StepItemIndicatorElement

CreateSecondContentElement()

Declaration
protected virtual StepContentElement CreateSecondContentElement()
Returns
StepContentElement

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

OnProgressChanged()

Declaration
protected virtual void OnProgressChanged()

OnProgressChanging(Int32)

Declaration
protected virtual bool OnProgressChanging(int newProgress)
Parameters
System.Int32 newProgress

Returns
System.Boolean

ResetConnectionLength()

Resets the ConnectionLength property to the default value.

Declaration
public void ResetConnectionLength()

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

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

TryGetStepProgressItemsProvider(out IStepProgressItemsProvider)

Declaration
protected virtual bool TryGetStepProgressItemsProvider(out IStepProgressItemsProvider provider)
Parameters
IStepProgressItemsProvider provider

Returns
System.Boolean

Extension Methods