Table of Contents

Class RadzenSteps

Namespace
Radzen.Blazor
Assembly
Radzen.Blazor.dll

RadzenSteps component.

public class RadzenSteps : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance
RadzenSteps
Implements
Inherited Members

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

public RadzenSteps()

Properties

AllowStepSelect 

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

Property Value

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.

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

Property Value

EventCallback<StepsCanChangeEventArgs>

Examples

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

Change

Gets or sets the change callback.

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

Property Value

EventCallback<int>

The change callback.

EditContext

Gets or sets the edit context.

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

Property Value

EditContext

The edit context.

NextAriaLabel

Gets the next button aria-label attribute.

public string NextAriaLabel { get; }

Property Value

string

The next button aria-label attribute.

NextText

Gets or sets the next button text.

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

Property Value

string

The next button text.

NextTitle

Gets or sets the next button title attribute.

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

Property Value

string

The next button title attribute.

PreviousAriaLabel

Gets the previous button aria-label attribute.

public string PreviousAriaLabel { get; }

Property Value

string

The previous button aria-label attribute.

PreviousText

Gets or sets the previous button text.

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

Property Value

string

The previous button text.

PreviousTitle

Gets or sets the previous button title attribute.

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

Property Value

string

The previous button title attribute.

SelectedIndex

Gets or sets the selected index.

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

Property Value

int

The selected index.

SelectedIndexChanged

Gets or sets the selected index changed callback.

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

Property Value

EventCallback<int>

The selected index changed callback.

ShowStepsButtons

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

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

Property Value

bool

true if steps buttons are shown; otherwise, false.

Steps

Gets or sets the steps.

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

Property Value

RenderFragment

The steps.

StepsCollection

Gets the steps collection.

public IList<RadzenStepsItem> StepsCollection { get; }

Property Value

IList<RadzenStepsItem>

The steps collection.

Methods

AddStep(RadzenStepsItem)

Adds the step.

public void AddStep(RadzenStepsItem step)

Parameters

step RadzenStepsItem

The step.

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

GetComponentCssClass() 

protected override string GetComponentCssClass()

Returns

string

IsSelected(int, RadzenStepsItem)

Determines whether the specified index is selected.

protected bool IsSelected(int index, RadzenStepsItem step)

Parameters

index int

The index.

step RadzenStepsItem

The step.

Returns

bool

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

NextStep()

Goes to next step.

public Task NextStep()

Returns

Task

PrevStep()

Goes to previous step.

public Task PrevStep()

Returns

Task

RemoveStep(RadzenStepsItem)

Removes the step.

public void RemoveStep(RadzenStepsItem item)

Parameters

item RadzenStepsItem

The item.

SetParametersAsync(ParameterView) 

public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters ParameterView

Returns

Task