Class MuddyWizard

This class is the code-behind for the MuddyWizard razor component.

Inheritance

System.Object

Microsoft.AspNetCore.Components.ComponentBase

MudBlazor.MudComponentBase

MuddyWizard

Implements

Microsoft.AspNetCore.Components.IComponent

Microsoft.AspNetCore.Components.IHandleEvent

Microsoft.AspNetCore.Components.IHandleAfterRender

System.IAsyncDisposable

Inherited Members

MudBlazor.MudComponentBase.Logger

MudBlazor.MudComponentBase.Class

MudBlazor.MudComponentBase.Style

MudBlazor.MudComponentBase.Tag

MudBlazor.MudComponentBase.UserAttributes

MudBlazor.MudComponentBase.FieldId

Microsoft.AspNetCore.Components.ComponentBase.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder)

Microsoft.AspNetCore.Components.ComponentBase.OnInitialized()

Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync()

Microsoft.AspNetCore.Components.ComponentBase.OnParametersSet()

Microsoft.AspNetCore.Components.ComponentBase.OnParametersSetAsync()

Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged()

Microsoft.AspNetCore.Components.ComponentBase.ShouldRender()

Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync(System.Boolean)

Microsoft.AspNetCore.Components.ComponentBase.InvokeAsync(System.Action)

Microsoft.AspNetCore.Components.ComponentBase.InvokeAsync(System.Func<System.Threading.Tasks.Task>)

Microsoft.AspNetCore.Components.ComponentBase.Microsoft.AspNetCore.Components.IComponent.Attach(Microsoft.AspNetCore.Components.RenderHandle)

Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView)

Microsoft.AspNetCore.Components.ComponentBase.Microsoft.AspNetCore.Components.IHandleEvent.HandleEventAsync(Microsoft.AspNetCore.Components.EventCallbackWorkItem, System.Object)

Microsoft.AspNetCore.Components.ComponentBase.Microsoft.AspNetCore.Components.IHandleAfterRender.OnAfterRenderAsync()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: CG.Blazor.Wizard

Assembly: CG.Blazor.Wizard.dll

Syntax

public class MuddyWizard : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IAsyncDisposable

Constructors

MuddyWizard()

This constructor creates a new instance of the MuddyWizard class.

Declaration

public MuddyWizard()

Properties

ActiveChips

Thks property indicates whether the chips should respond to user clicks, or not.

Declaration

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

Property Value

Type	Description
System.Boolean

ButtonVariant

This property contains the variant for the wizard buttons.

Declaration

[Parameter]
public Variant ButtonVariant { get; set; }

Property Value

Type	Description
MudBlazor.Variant

CancelColor

This property contains the color for the cancel button.

Declaration

[Parameter]
public Color CancelColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

ChildContent

This property contains the child content for the component.

Declaration

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

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

Classname

This property contains the CSS class for the component.

Declaration

protected string Classname { get; }

Property Value

Type	Description
System.String

Description

This property contains the description for the wizard.

Declaration

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

Property Value

Type	Description
System.String

DescriptionColor

This property contains the color for the wizard descriptions.

Declaration

[Parameter]
public Color DescriptionColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

DescriptionTypo

This property contains the typography for the wizard descriptions.

Declaration

[Parameter]
public Typo DescriptionTypo { get; set; }

Property Value

Type	Description
MudBlazor.Typo

DisableNext

This property indicates whether the next button should be disabled, or not.

Declaration

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

Property Value

Type	Description
System.Boolean

DisablePrevious

This property indicates whether the previous button should be disabled, or not.

Declaration

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

Property Value

Type	Description
System.Boolean

Elevation

This property contains the elevation for the component.

Declaration

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

Property Value

Type	Description
System.Int32

FinishColor

This property contains the color for the finish button.

Declaration

[Parameter]
public Color FinishColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

HeaderChipColor

This property contains the color for non-selected chips in the wizard header.

Declaration

[Parameter]
public Color HeaderChipColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

HeaderChipSelectedColor

This property contains the color for selected chip in the wizard header.

Declaration

[Parameter]
public Color HeaderChipSelectedColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

HeaderChipVariant

This property contains the variant for the chips in the wizard header.

Declaration

[Parameter]
public Variant HeaderChipVariant { get; set; }

Property Value

Type	Description
MudBlazor.Variant

IndexChanged

This event is raised whenever the index changes.

Declaration

[Parameter]
public EventCallback<IndexChangedEventArgs> IndexChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IndexChangedEventArgs>

IsFinishVisible

This property indicates whether the finish button should be hidden, or not. True if it should be hidden; False otherwise.

Declaration

protected bool IsFinishVisible { get; }

Property Value

Type	Description
System.Boolean

IsNextDisabled

This property indicates whether the next button should be disabled, or not. True if it should be disabled; False otherwise.

Declaration

protected bool IsNextDisabled { get; }

Property Value

Type	Description
System.Boolean

IsPreviousDisabled

This property indicates whether the previous button should be disabled, or not. True if it should be disabled; False otherwise.

Declaration

protected bool IsPreviousDisabled { get; }

Property Value

Type	Description
System.Boolean

NextColor

This property contains the color for the next button.

Declaration

[Parameter]
public Color NextColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

Outlined

This property indicates whether the wizard should be outlined, or not. True to outline; False otherwise.

Declaration

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

Property Value

Type	Description
System.Boolean

Panels

This property contains a list of the current wizard panels.

Declaration

public IReadOnlyList<MuddyWizardPanel> Panels { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<MuddyWizardPanel>

PreviousColor

This property contains the color for the previous button.

Declaration

[Parameter]
public Color PreviousColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

SelectedIndex

This property contains the index of the currently selected panel.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>

SelectedPanel

This property contains the currently selected panel.

Declaration

[Parameter]
public MuddyWizardPanel SelectedPanel { get; set; }

Property Value

Type	Description
MuddyWizardPanel

ShowCancel

This property indicates whether to show the cancel button, or not.

Declaration

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

Property Value

Type	Description
System.Boolean

ShowChips

This property indicates whether to show the header chips, or not.

Declaration

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

Property Value

Type	Description
System.Boolean

ShowFinish

This property indicates whether to show the finish button, or not.

Declaration

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

Property Value

Type	Description
System.Boolean

ShowHeaderBorder

This property indicates whether the wizard should draw a bottom border for the wizard header.

Declaration

protected bool ShowHeaderBorder { get; }

Property Value

Type	Description
System.Boolean

Square

This property indicates whether the border radius should be set to zero, or not. True to set the border radius to zero; False otherwise.

Declaration

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

Property Value

Type	Description
System.Boolean

Title

This property contains the title for the wizard.

Declaration

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

Property Value

Type	Description
System.String

TitleColor

This property contains the color for the wizard title.

Declaration

[Parameter]
public Color TitleColor { get; set; }

Property Value

Type	Description
MudBlazor.Color

TitleTypo

This property contains the typography for the wizard title.

Declaration

[Parameter]
public Typo TitleTypo { get; set; }

Property Value

Type	Description
MudBlazor.Typo

WizardCancelled

This event is raised whenever the wizard is cancelled.

Declaration

[Parameter]
public EventCallback WizardCancelled { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback

WizardFinished

This event is raised whenever the wizard is finished.

Declaration

[Parameter]
public EventCallback WizardFinished { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback

Methods

AddPanel(MuddyWizardPanel)

This method adds a new wizard panel to the component.

Declaration

protected void AddPanel(MuddyWizardPanel panel)

Parameters

Type	Name	Description
MuddyWizardPanel	panel	The wizard panel to add.

ChipSelect(MuddyWizardPanel)

Declaration

public void ChipSelect(MuddyWizardPanel panel)

Parameters

Type	Name	Description
MuddyWizardPanel	panel

DisposeAsync()

This method is called to dispose of the component.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
System.Threading.Tasks.ValueTask	A System.Threading.Tasks.ValueTask for the operation.

OnAfterRender(Boolean)

This method is called after a render operation.

Declaration

protected override void OnAfterRender(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Overrides

Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender(System.Boolean)

OnCancel()

This method cancels the wizard.

Declaration

protected async Task OnCancel()

Returns

Type	Description
System.Threading.Tasks.Task	A task to perform the operation.

OnFinish()

This method finishes the wizard.

Declaration

protected async Task OnFinish()

Returns

Type	Description
System.Threading.Tasks.Task	A task to perform the operation.

OnHeaderSelect(MudChip)

This method is called when the wizard header is clicked.

Declaration

protected void OnHeaderSelect(MudChip chip)

Parameters

Type	Name	Description
MudBlazor.MudChip	chip

OnNext()

This method is called to select the next panel in the wizard.

Declaration

protected void OnNext()

OnPrevious()

This method is called to select the previous panel in the wizard.

Declaration

protected void OnPrevious()

RemovePanel(MuddyWizardPanel)

This method removes a panel from the component.

Declaration

protected Task RemovePanel(MuddyWizardPanel panel)

Parameters

Type	Name	Description
MuddyWizardPanel	panel	The wizard panel to remove.

Returns

Type	Description
System.Threading.Tasks.Task

Select(MuddyWizardPanel)

Declaration

public void Select(MuddyWizardPanel panel)

Parameters

Type	Name	Description
MuddyWizardPanel	panel

Select(Nullable<Int32>)

This method causes the wizard to navigate to the specified panel index.

Declaration

public void Select(int? index)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	index	The index to use for the operation.

Implements

Microsoft.AspNetCore.Components.IComponent

Microsoft.AspNetCore.Components.IHandleEvent

Microsoft.AspNetCore.Components.IHandleAfterRender

System.IAsyncDisposable