InputCheckbox Class

Definition

Namespace:

Microsoft.AspNetCore.Components.Forms

Assembly:

Microsoft.AspNetCore.Components.Web.dll

Package:

Microsoft.AspNetCore.Components.Web v9.0.0

Source:

InputCheckbox.cs

An input component for editing Boolean values.

public ref class InputCheckbox : Microsoft::AspNetCore::Components::Forms::InputBase<bool>

public class InputCheckbox : Microsoft.AspNetCore.Components.Forms.InputBase<bool>

type InputCheckbox = class
    inherit InputBase<bool>

Public Class InputCheckbox
Inherits InputBase(Of Boolean)

Inheritance

Object

ComponentBase

InputBase<Boolean>

InputCheckbox

Constructors

InputCheckbox()

Properties

AdditionalAttributes	Gets or sets a collection of additional attributes that will be applied to the created element. (Inherited from InputBase<TValue>)
Assets	Gets the ResourceAssetCollection for the application. (Inherited from ComponentBase)
AssignedRenderMode	Gets the IComponentRenderMode assigned to this component. (Inherited from ComponentBase)
CssClass	Gets a CSS class string that combines the class attribute and a string indicating the status of the field being edited (a combination of "modified", "valid", and "invalid"). Derived components should typically use this value for the primary HTML element's 'class' attribute. (Inherited from InputBase<TValue>)
CurrentValue	Gets or sets the current value of the input. (Inherited from InputBase<TValue>)
CurrentValueAsString	Gets or sets the current value of the input, represented as a string. (Inherited from InputBase<TValue>)
DisplayName	Gets or sets the display name for this field. This value is used when generating error messages when the input value fails to parse correctly. (Inherited from InputBase<TValue>)
EditContext	Gets the associated EditContext. This property is uninitialized if the input does not have a parent EditForm. (Inherited from InputBase<TValue>)
Element	Gets or sets the associated ElementReference. May be null if accessed before the component is rendered.
FieldIdentifier	Gets the FieldIdentifier for the bound value. (Inherited from InputBase<TValue>)
NameAttributeValue	Gets the value to be used for the input's "name" attribute. (Inherited from InputBase<TValue>)
RendererInfo	Gets the RendererInfo the component is running on. (Inherited from ComponentBase)
Value	Gets or sets the value of the input. This should be used with two-way binding. (Inherited from InputBase<TValue>)
ValueChanged	Gets or sets a callback that updates the bound value. (Inherited from InputBase<TValue>)
ValueExpression	Gets or sets an expression that identifies the bound value. (Inherited from InputBase<TValue>)

Methods

BuildRenderTree(RenderTreeBuilder)	Renders the component to the supplied RenderTreeBuilder.
DispatchExceptionAsync(Exception)	Treats the supplied exception as being thrown by this component. This will cause the enclosing ErrorBoundary to transition into a failed state. If there is no enclosing ErrorBoundary, it will be regarded as an exception from the enclosing renderer. This is useful if an exception occurs outside the component lifecycle methods, but you wish to treat it the same as an exception from a component lifecycle method. (Inherited from ComponentBase)
Dispose(Boolean)	(Inherited from InputBase<TValue>)
FormatValueAsString(T)	Formats the value as a string. Derived classes can override this to determine the formating used for CurrentValueAsString. (Inherited from InputBase<TValue>)
InvokeAsync(Action)	Executes the supplied work item on the associated renderer's synchronization context. (Inherited from ComponentBase)
InvokeAsync(Func<Task>)	Executes the supplied work item on the associated renderer's synchronization context. (Inherited from ComponentBase)
OnAfterRender(Boolean)	Method invoked after each time the component has rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs. This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated. (Inherited from ComponentBase)
OnAfterRenderAsync(Boolean)	Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs. This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated. Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop. (Inherited from ComponentBase)
OnInitialized()	Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. (Inherited from ComponentBase)
OnInitializedAsync()	Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed. (Inherited from ComponentBase)
OnParametersSet()	Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties. (Inherited from ComponentBase)
OnParametersSetAsync()	Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties. (Inherited from ComponentBase)
SetParametersAsync(ParameterView)	Sets parameters supplied by the component's parent in the render tree. (Inherited from InputBase<TValue>)
ShouldRender()	Returns a flag to indicate whether the component should render. (Inherited from ComponentBase)
StateHasChanged()	Notifies the component that its state has changed. When applicable, this will cause the component to be re-rendered. (Inherited from ComponentBase)
TryParseValueFromString(String, Boolean, String)	System.Object.TryParseValueFromString(System.String,System.Boolean@,System.String@)
TryParseValueFromString(String, T, String)	Parses a string to create an instance of T. Derived classes can override this to change how CurrentValueAsString interprets incoming values. (Inherited from InputBase<TValue>)

Explicit Interface Implementations

IComponent.Attach(RenderHandle)	(Inherited from ComponentBase)
IDisposable.Dispose()	(Inherited from InputBase<TValue>)
IHandleAfterRender.OnAfterRenderAsync()	(Inherited from ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)	(Inherited from ComponentBase)