Class RadzenSteps

RadzenSteps component.

Inheritance

object

ComponentBase

RadzenComponent

RadzenSteps

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(MouseEventArgs)

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.OnInitialized()

RadzenComponent.OnAfterRenderAsync(bool)

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Dispose()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenSteps : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Examples

<RadzenSteps Change=@(args => Console.WriteLine($"Selected index is: {args}"))>
    <Steps>
        <RadzenStepsItem Text="Orders">
            Details for Orders
        </RadzenStepsItem>
        <RadzenStepsItem Text="Employees">
            Details for Employees
        </RadzenStepsItem>
    </Steps>
</RadzenTabs>

Constructors

RadzenSteps()

RadzenSteps component.

Declaration

public RadzenSteps()

Examples

<RadzenSteps Change=@(args => Console.WriteLine($"Selected index is: {args}"))>
    <Steps>
        <RadzenStepsItem Text="Orders">
            Details for Orders
        </RadzenStepsItem>
        <RadzenStepsItem Text="Employees">
            Details for Employees
        </RadzenStepsItem>
    </Steps>
</RadzenTabs>

Properties

AllowStepSelect

RadzenSteps component.

Declaration

[Parameter]
public bool AllowStepSelect { get; set; }

Property Value

Type	Description
bool	true user can jump to any step if enabled; false user can change steps only with step buttons (previous/next).

CanChange

A callback that will be invoked when the user tries to change the step. Invoke the PreventDefault() method to prevent this change.

Declaration

[Parameter]
public EventCallback<StepsCanChangeEventArgs> CanChange { get; set; }

Property Value

Type	Description
EventCallback<StepsCanChangeEventArgs>

Examples

<RadzenSteps CanChange=@OnCanChange>
</RadzenSteps>
@code {
 void OnCanChange(RadzenStepsCanChangeEventArgs args)
 {
    args.PreventDefault();
 }
}

Change

Gets or sets the change callback.

Declaration

[Parameter]
public EventCallback<int> Change { get; set; }

Property Value

Type	Description
EventCallback<int>	The change callback.

EditContext

Gets or sets the edit context.

Declaration

[CascadingParameter]
public EditContext EditContext { get; set; }

Property Value

Type	Description
EditContext	The edit context.

NextAriaLabel

Gets the next button aria-label attribute.

Declaration

public string NextAriaLabel { get; }

Property Value

Type	Description
string	The next button aria-label attribute.

NextText

Gets or sets the next button text.

Declaration

[Parameter]
public string NextText { get; set; }

Property Value

Type	Description
string	The next button text.

NextTitle

Gets or sets the next button title attribute.

Declaration

[Parameter]
public string NextTitle { get; set; }

Property Value

Type	Description
string	The next button title attribute.

PreviousAriaLabel

Gets the previous button aria-label attribute.

Declaration

public string PreviousAriaLabel { get; }

Property Value

Type	Description
string	The previous button aria-label attribute.

PreviousText

Gets or sets the previous button text.

Declaration

[Parameter]
public string PreviousText { get; set; }

Property Value

Type	Description
string	The previous button text.

PreviousTitle

Gets or sets the previous button title attribute.

Declaration

[Parameter]
public string PreviousTitle { get; set; }

Property Value

Type	Description
string	The previous button title attribute.

SelectedIndex

Gets or sets the selected index.

Declaration

[Parameter]
public int SelectedIndex { get; set; }

Property Value

Type	Description
int	The selected index.

SelectedIndexChanged

Gets or sets the selected index changed callback.

Declaration

[Parameter]
public EventCallback<int> SelectedIndexChanged { get; set; }

Property Value

Type	Description
EventCallback<int>	The selected index changed callback.

ShowStepsButtons

Gets or sets a value indicating whether to show steps buttons.

Declaration

[Parameter]
public bool ShowStepsButtons { get; set; }

Property Value

Type	Description
bool	true if steps buttons are shown; otherwise, false.

Steps

Gets or sets the steps.

Declaration

[Parameter]
public RenderFragment Steps { get; set; }

Property Value

Type	Description
RenderFragment	The steps.

StepsCollection

Gets the steps collection.

Declaration

public IList<RadzenStepsItem> StepsCollection { get; }

Property Value

Type	Description
IList<RadzenStepsItem>	The steps collection.

Methods

AddStep(RadzenStepsItem)

Adds the step.

Declaration

public void AddStep(RadzenStepsItem step)

Parameters

Type	Name	Description
RadzenStepsItem	step	The step.

BuildRenderTree(RenderTreeBuilder)

RadzenSteps component.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

IsSelected(int, RadzenStepsItem)

Determines whether the specified index is selected.

Declaration

protected bool IsSelected(int index, RadzenStepsItem step)

Parameters

Type	Name	Description
int	index	The index.
RadzenStepsItem	step	The step.

Returns

Type	Description
bool	true if the specified index is selected; otherwise, false.

NextStep()

Goes to next step.

Declaration

public Task NextStep()

Returns

Type	Description
Task

PrevStep()

Goes to previous step.

Declaration

public Task PrevStep()

Returns

Type	Description
Task

RemoveStep(RadzenStepsItem)

Removes the step.

Declaration

public void RemoveStep(RadzenStepsItem item)

Parameters

Type	Name	Description
RadzenStepsItem	item	The item.

SetParametersAsync(ParameterView)

Called by the Blazor runtime when parameters are set.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task

Overrides

RadzenComponent.SetParametersAsync(ParameterView)

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable