InputBase<TValue> Class

Definition

Namespace:

Microsoft.AspNetCore.Components.Forms

Assembly:

Microsoft.AspNetCore.Components.Web.dll

Package:

Microsoft.AspNetCore.Components.Web v8.0.0

Source:

InputBase.cs

A base class for form input components. This base class automatically integrates with an EditContext, which must be supplied as a cascading parameter.

public abstract class InputBase<TValue> : Microsoft.AspNetCore.Components.ComponentBase, IDisposable

type InputBase<'Value> = class
    inherit ComponentBase
    interface IDisposable

Public MustInherit Class InputBase(Of TValue)
Inherits ComponentBase
Implements IDisposable

Type Parameters

TValue

Inheritance

Object

ComponentBase

InputBase<TValue>

Derived

Microsoft.AspNetCore.Components.Forms.InputCheckbox

Microsoft.AspNetCore.Components.Forms.InputDate<TValue>

Microsoft.AspNetCore.Components.Forms.InputNumber<TValue>

Microsoft.AspNetCore.Components.Forms.InputRadioGroup<TValue>

Microsoft.AspNetCore.Components.Forms.InputSelect<TValue>

Microsoft.AspNetCore.Components.Forms.InputText

Microsoft.AspNetCore.Components.Forms.InputTextArea

Implements

IDisposable

Constructors

InputBase<TValue>()

Constructs an instance of InputBase<TValue>.

Properties

AdditionalAttributes	Gets or sets a collection of additional attributes that will be applied to the created element.
CssClass	Gets a CSS class string that combines the class attribute and 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.
CurrentValue	Gets or sets the current value of the input.
CurrentValueAsString	Gets or sets the current value of the input, represented as a string.
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.
EditContext	Gets the associated EditContext. This property is uninitialized if the input does not have a parent EditForm.
FieldIdentifier	Gets the FieldIdentifier for the bound value.
NameAttributeValue	Gets the value to be used for the input's "name" attribute.
Value	Gets or sets the value of the input. This should be used with two-way binding.
ValueChanged	Gets or sets a callback that updates the bound value.
ValueExpression	Gets or sets an expression that identifies the bound value.

Methods

BuildRenderTree(RenderTreeBuilder)	Renders the component to the supplied RenderTreeBuilder. (Inherited from ComponentBase)
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)	System.Object.Dispose(System.Boolean)
FormatValueAsString(T)	Formats the value as a string. Derived classes can override this to determine the formating used for CurrentValueAsString.
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.
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, T, String)	Parses a string to create an instance of T. Derived classes can override this to change how CurrentValueAsString interprets incoming values.

Explicit Interface Implementations

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