Class MudBooleanInput<T>

Namespace

MudBlazor

Assembly

MudBlazor.dll

Represents a form input component which stores a boolean value.

public class MudBooleanInput<T> : MudFormComponent<T?, bool?>, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IFormComponent, IAsyncDisposable

Type Parameters

T

The type of item managed by this component.

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudFormComponent<T, bool?>

MudBooleanInput<T>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

IFormComponent

IAsyncDisposable

Derived

MudCheckBox<T>

MudRadio<T>

MudSwitch<T>

Inherited Members

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

ComponentBaseWithState.SetParametersAsync(ParameterView)

ComponentBaseWithState.OnParametersSet()

ComponentBaseWithState.CreateRegisterScope()

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRenderAsync(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()

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

MudBooleanInput()

public MudBooleanInput()

Properties

BoolValue

protected bool? BoolValue { get; }

Property Value

bool?

ChildContent

[Parameter]
[Category("Behavior")]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

Classname

protected virtual string? Classname { get; set; }

Property Value

string

Color

The color of the component. It supports the theme colors.

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

Property Value

Color

Disabled

Prevents the user from interacting with this input.

[Parameter]
[Category("Behavior")]
public bool Disabled { get; set; }

Property Value

bool

Remarks

Defaults to false.

IconClassname

protected virtual string? IconClassname { get; set; }

Property Value

string

Label

The text/label will be displayed next to the switch if set.

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

Property Value

string

LabelClassname

protected virtual string? LabelClassname { get; set; }

Property Value

string

LabelPlacement

The location of the label relative to the input icon.

[Parameter]
[Category("Appearance")]
public Placement LabelPlacement { get; set; }

Property Value

Placement

ReadOnly

Prevents the user from changing the input.

[Parameter]
[Category("Behavior")]
public bool ReadOnly { get; set; }

Property Value

bool

Remarks

Defaults to false. When true, the user can copy the input but cannot change it.

RightToLeft

[CascadingParameter(Name = "RightToLeft")]
public bool RightToLeft { get; set; }

Property Value

bool

Ripple

Gets or sets whether to show a ripple effect when the user clicks the button. Default is true.

[Parameter]
[Category("Appearance")]
public bool Ripple { get; set; }

Property Value

bool

Size

The Size of the component.

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

Property Value

Size

StopClickPropagation

Prevents the parent component from receiving click events.

[Parameter]
[Category("Behavior")]
public bool StopClickPropagation { get; set; }

Property Value

bool

Remarks

Defaults to true. When true, the click will not bubble up to parent components.

Value

The currently selected value.

[Parameter]
[Category("Data")]
public T? Value { get; set; }

Property Value

T

ValueChanged

Occurs when the Value has changed.

[Parameter]
public EventCallback<T?> ValueChanged { get; set; }

Property Value

EventCallback<T>

Methods

ConvertPlacement(Placement)

protected Placement ConvertPlacement(Placement placement)

Parameters

placement Placement

Returns

Placement

GetDisabledState()

protected bool GetDisabledState()

Returns

bool

GetReadOnlyState()

protected bool GetReadOnlyState()

Returns

bool

HasValue(T?)

A value is required, so if not checked we return ERROR.

protected override bool HasValue(T? value)

Parameters

value T

Returns

bool

OnChange(ChangeEventArgs)

protected virtual Task OnChange(ChangeEventArgs args)

Parameters

args ChangeEventArgs

Returns

Task

SetBoolValueAsync(bool?, bool?)

protected Task SetBoolValueAsync(bool? value, bool? markAsTouched = null)

Parameters

value bool?

markAsTouched bool?

Returns

Task

SetCheckedAsync(T?)

protected Task SetCheckedAsync(T? value)

Parameters

value T

Returns

Task

SetConverter(Converter<T?, bool?>)

protected override bool SetConverter(Converter<T?, bool?> value)

Parameters

value Converter<T, bool?>

Returns

bool