ClassStepProgressItem
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class StepProgressItem : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementStepProgressItem
Implements:
Inherited Members
Constructors
StepProgressItem()
Declaration
public StepProgressItem()
Fields
ConnectionLengthProperty
Declaration
public static RadProperty ConnectionLengthProperty
Field Value
ConnectionThicknessProperty
Declaration
public static RadProperty ConnectionThicknessProperty
Field Value
IndicatorSizeProperty
Declaration
public static RadProperty IndicatorSizeProperty
Field Value
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.
Connection
Gets the connection element.
Declaration
public StepConnectionElement Connection { get; }
Property Value
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.
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.
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
FirstContentElement
Gets the first content element.
Declaration
public StepContentElement FirstContentElement { get; }
Property Value
FirstDescription
Gets or sets the description of the first content element.
FirstHeader
Gets or sets the header of the first content element.
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.
IsError
Gets or sets whether the item is in error state. If yes, the progress will change to 0.
IsFirst
Determines if the step is first.
IsLast
Determines if the step is last.
Next
Gets the next step.
Declaration
[Browsable(false)]
public StepProgressItem Next { get; }
Property Value
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
Previous
Gets the previous step.
Declaration
[Browsable(false)]
public StepProgressItem Previous { get; }
Property Value
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.
ProgressStatus
Gets the prgress status.
Declaration
[Browsable(false)]
public StepProgressStatus ProgressStatus { get; }
Property Value
SecondContentElement
Gets the second content element.
Declaration
public StepContentElement SecondContentElement { get; }
Property Value
SecondDescription
Gets or sets the description of the second content element.
SecondHeader
Gets or sets the header of the second content element.
StepIndicator
Gets this indicator element.
Declaration
public StepItemIndicatorElement StepIndicator { get; }
Property Value
Methods
ArrangeOverride(SizeF)
Arranges the content and child elements within the final allocated space, positioning text, images, and child elements.
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateConnectionElement()
Declaration
protected virtual StepConnectionElement CreateConnectionElement()
Returns
CreateFirstContentElement()
Declaration
protected virtual StepContentElement CreateFirstContentElement()
Returns
CreateIndicatorElement()
Declaration
protected virtual StepItemIndicatorElement CreateIndicatorElement()
Returns
CreateSecondContentElement()
Declaration
protected virtual StepContentElement CreateSecondContentElement()
Returns
DisposeManagedResources()
Releases the managed resources used by the StepProgressItem.
Declaration
protected override void DisposeManagedResources()
Overrides
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 the element by calculating the space needed for content, padding, and borders.
OnProgressChanged()
Declaration
protected virtual void OnProgressChanged()
OnStepIndicatorClick(EventArgs)
Declaration
protected virtual void OnStepIndicatorClick(EventArgs e)
Parameters
e
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)
Gets a value indicating whether a child will be arranged during the ArrangeOverride(SizeF).
Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
child
The child element to check.
Returns
Whether the child will be arranged in ArrangeOverride.
Overrides
ShouldMeasureChild(RadElement)
Gets a value indicating, whether a child will be measured during the MeasureOverride.
Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
child
The child.
Returns
Whether the child will be measured in MeasureOverride.
Overrides
TryGetStepProgressItemsProvider(out IStepProgressItemsProvider)
Declaration
protected virtual bool TryGetStepProgressItemsProvider(out IStepProgressItemsProvider provider)
Parameters
provider
Returns