Class MudSwitch<T>

Namespace

MudBlazor

Assembly

MudBlazor.dll

A component which switches between two values.

public class MudSwitch<T> : MudBooleanInput<T>, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IFormComponent, IAsyncDisposable

Type Parameters

T

The kind of value being switched, typically a bool.

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudFormComponent<T, bool?>

MudBooleanInput<T>

MudSwitch<T>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

IFormComponent

IAsyncDisposable

Inherited Members

MudBooleanInput<T>.GetDisabledState()

MudBooleanInput<T>.GetReadOnlyState()

MudBooleanInput<T>.OnChange(ChangeEventArgs)

MudBooleanInput<T>.SetBoolValueAsync(bool?, bool?)

MudBooleanInput<T>.SetCheckedAsync(T)

MudBooleanInput<T>.SetConverter(Converter<T, bool?>)

MudBooleanInput<T>.HasValue(T)

MudBooleanInput<T>.ConvertPlacement(Placement)

MudBooleanInput<T>.IconClassname

MudBooleanInput<T>.Disabled

MudBooleanInput<T>.ReadOnly

MudBooleanInput<T>.Value

MudBooleanInput<T>.StopClickPropagation

MudBooleanInput<T>.RightToLeft

MudBooleanInput<T>.LabelPlacement

MudBooleanInput<T>.Label

MudBooleanInput<T>.Ripple

MudBooleanInput<T>.Size

MudBooleanInput<T>.Color

MudBooleanInput<T>.ChildContent

MudBooleanInput<T>.ValueChanged

MudBooleanInput<T>.BoolValue

MudFormComponent<T, bool?>._value

MudFormComponent<T, bool?>.SetConverter(Converter<T, bool?>)

MudFormComponent<T, bool?>.SetCulture(CultureInfo)

MudFormComponent<T, bool?>.OnConversionErrorOccurred(string)

MudFormComponent<T, bool?>.GetErrorText()

MudFormComponent<T, bool?>.BeginValidationAfterAsync(Task)

MudFormComponent<T, bool?>.BeginValidateAsync()

MudFormComponent<T, bool?>.Validate()

MudFormComponent<T, bool?>.ValidateValue()

MudFormComponent<T, bool?>.HasValue(T)

MudFormComponent<T, bool?>.ValidateWithAttribute(ValidationAttribute, T, List<string>)

MudFormComponent<T, bool?>.ValidateWithFunc(Func<T, bool>, T, List<string>)

MudFormComponent<T, bool?>.ValidateWithFunc(Func<T, string>, T, List<string>)

MudFormComponent<T, bool?>.ValidateWithFunc(Func<T, IEnumerable<string>>, T, List<string>)

MudFormComponent<T, bool?>.ValidateModelWithFullPathOfMember(Func<object, string, IEnumerable<string>>, List<string>)

MudFormComponent<T, bool?>.ValidateWithFunc(Func<T, Task<bool>>, T, List<string>)

MudFormComponent<T, bool?>.ValidateWithFunc(Func<T, Task<string>>, T, List<string>)

MudFormComponent<T, bool?>.ValidateWithFunc(Func<T, Task<IEnumerable<string>>>, T, List<string>)

MudFormComponent<T, bool?>.ValidateModelWithFullPathOfMember(Func<object, string, Task<IEnumerable<string>>>, List<string>)

MudFormComponent<T, bool?>.FieldChanged(object)

MudFormComponent<T, bool?>.ResetAsync()

MudFormComponent<T, bool?>.ResetValueAsync()

MudFormComponent<T, bool?>.ResetValidation()

MudFormComponent<T, bool?>.OnParametersSet()

MudFormComponent<T, bool?>.OnInitializedAsync()

MudFormComponent<T, bool?>.RegisterAsFormComponent()

MudFormComponent<T, bool?>.ReadValue()

MudFormComponent<T, bool?>.WriteValueAsync(T)

MudFormComponent<T, bool?>.DisposeAsyncCore()

MudFormComponent<T, bool?>.DisposeAsync()

MudFormComponent<T, bool?>.Required

MudFormComponent<T, bool?>.RequiredError

MudFormComponent<T, bool?>.ErrorText

MudFormComponent<T, bool?>.Error

MudFormComponent<T, bool?>.ErrorId

MudFormComponent<T, bool?>.Converter

MudFormComponent<T, bool?>.Culture

MudFormComponent<T, bool?>.ConversionError

MudFormComponent<T, bool?>.ConversionErrorMessage

MudFormComponent<T, bool?>.HasErrors

MudFormComponent<T, bool?>.Touched

MudFormComponent<T, bool?>.ValidationErrors

MudFormComponent<T, bool?>.Validation

MudFormComponent<T, bool?>.For

MudFormComponent<T, bool?>.IsForNull

MudComponentBase.OnAfterRender(bool)

MudComponentBase.Logger

MudComponentBase.Class

MudComponentBase.Style

MudComponentBase.Tag

MudComponentBase.UserAttributes

MudComponentBase.IsJSRuntimeAvailable

MudComponentBase.FieldId

ComponentBaseWithState.SetParametersAsync(ParameterView)

ComponentBaseWithState.OnParametersSet()

ComponentBaseWithState.CreateRegisterScope()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

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

Extension Methods

EventUtil.AsNonRenderingEventHandler(ComponentBase, Action)

EventUtil.AsNonRenderingEventHandler(ComponentBase, Func<Task>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Action<TValue>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Func<TValue, Task>)

ComponentBaseWithStateExtensions.GetState<T>(ComponentBaseWithState, string)

ComponentBaseWithStateExtensions.GetState<TComponent, T>(TComponent, Func<TComponent, T>, string?)

ObjectExtensions.As<T>(object?)

Constructors

MudSwitch()

public MudSwitch()

Properties

Classname

protected override string Classname { get; }

Property Value

string

LabelClassname

protected override string LabelClassname { get; }

Property Value

string

SpanClassname

protected string SpanClassname { get; }

Property Value

string

SwitchClassname

protected string SwitchClassname { get; }

Property Value

string

ThumbClassname

protected string ThumbClassname { get; }

Property Value

string

ThumbIcon

The icon to display for the switch thumb.

[Parameter]
[Category("Appearance")]
public string? ThumbIcon { get; set; }

Property Value

string

Remarks

Defaults to null.

ThumbIconColor

The color of the thumb icon.

[Parameter]
[Category("Appearance")]
public Color ThumbIconColor { get; set; }

Property Value

Color

Remarks

Defaults to Default. Only applies when ThumbIcon is set.

TrackClassname

protected string TrackClassname { get; }

Property Value

string

UncheckedColor

The color of this switch when in an unchecked state.

[Parameter]
[Category("Appearance")]
public Color UncheckedColor { get; set; }

Property Value

Color

Remarks

Defaults to Default.

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsyncCore()

Called to dispose this instance.

protected override ValueTask DisposeAsyncCore()

Returns

ValueTask

HandleKeyDownAsync(KeyboardEventArgs)

Occurs when a key is pressed.

protected Task HandleKeyDownAsync(KeyboardEventArgs obj)

Parameters

obj KeyboardEventArgs

Information about which key was pressed.

Returns

Task

Remarks

Supported keys are:
ArrowLeft or Delete to uncheck the switch.
ArrowRight, Enter, or NumpadEnter to check the switch.
Space to toggle the selected value.

OnAfterRenderAsync(bool)

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnInitialized()

protected override void OnInitialized()