StepProgressItem
Represents one step in a RadStepProgressBar, including its progress indicator, connector, and two content regions.
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
public StepProgressItem()
Fields
Identifies the completed visual state of the step indicator.
public static RadProperty CompletedProperty
Identifies the connector length used when laying out this step relative to its neighbor.
public static RadProperty ConnectionLengthProperty
Identifies the thickness of the connector between steps.
public static RadProperty ConnectionThicknessProperty
Identifies the size of the step's circular indicator and participates in parent measurement.
public static RadProperty IndicatorSizeProperty
Identifies the in-progress visual state of the step indicator.
public static RadProperty InProgressProperty
Identifies whether this step is active; the value is bound to the indicator's active visual state.
public static RadProperty IsActiveProperty
Identifies the error state. Setting it to true attempts to reset progress to zero; the update can be canceled through StepProgressChanging.
public static RadProperty IsErrorProperty
Identifies whether this step and its connector are laid out horizontally or vertically.
public static RadProperty OrientationProperty
Properties
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.
public bool Completed { get; set; }
Gets the connection element.
public StepConnectionElement Connection { get; }
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.
public int ConnectionLength { get; set; }
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.
public int ConnectionThickness { get; set; }
Determines whether there is a separate visual state of the step when its progress is between 0 and 100.
public bool EnableItemInProgressVisualState { get; set; }
Gets the first content element.
public StepContentElement FirstContentElement { get; }
Gets or sets the description of the first content element.
public string FirstDescription { get; set; }
Gets or sets the header of the first content element.
public string FirstHeader { get; set; }
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.
public Size IndicatorSize { get; set; }
Gets or sets whether the item is in error state. If yes, the progress will change to 0.
public bool IsError { get; set; }
Gets the next step.
[Browsable(false)]
public StepProgressItem Next { get; }
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.
public Orientation Orientation { get; set; }
Gets the previous step.
[Browsable(false)]
public StepProgressItem Previous { get; }
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.
public int Progress { get; set; }
Gets the prgress status.
[Browsable(false)]
public StepProgressStatus ProgressStatus { get; }
Gets the second content element.
public StepContentElement SecondContentElement { get; }
Gets or sets the description of the second content element.
public string SecondDescription { get; set; }
Gets or sets the header of the second content element.
public string SecondHeader { get; set; }
Gets this indicator element.
public StepItemIndicatorElement StepIndicator { get; }
Methods
Creates and binds the connector, indicator, and two content elements that make up a step.
protected override void CreateChildElements()
Overrides:
Creates the connector element; subclasses can override this to provide a custom connector.
Creates the content element displayed before the indicator in the current orientation.
Creates the step indicator element; subclasses can override this to provide a custom indicator.
protected virtual StepItemIndicatorElement CreateIndicatorElement()
Creates the content element displayed after the indicator in the current orientation.
Releases the managed resources used by the StepProgressItem.
protected override void DisposeManagedResources()
Overrides:
Configures the item to use its child elements for text and disabled-state rendering.
protected override void InitializeFields()
Overrides:
Notifies the component change service and raises the progress-changed event after an update succeeds.
protected virtual void OnProgressChanged()
Forwards an indicator click to the containing RadStepProgressBarElement when available.
protected virtual void OnStepIndicatorClick(EventArgs e)
The click event data.
Resets the ConnectionLength property to the default value.
public void ResetConnectionLength()
Resets the ConnectionThickness property to the default value.
public void ResetConnectionThickness()
Resets the IndicatorSize property to the default value.
public void ResetIndicatorSize()
Resets the Orientation property to the default value.
public void ResetOrientation()
Excludes the indicator, connector, and content elements from base arrangement because this item positions them explicitly.
protected override bool ShouldArrangeChild(RadElement child)
Overrides:
Excludes the indicator, connector, and content elements from base measurement because this item measures them explicitly.
protected override bool ShouldMeasureChild(RadElement child)
Overrides:
Finds the nearest ancestor that provides the step collection used by this item.
protected virtual bool TryGetStepProgressItemsProvider(out IStepProgressItemsProvider provider)
Receives the nearest ancestor provider, or null when none is found.
Returns:true if an ancestor provides a step collection; otherwise, false.