Class BoxInput

Namespace

The.Web.Widgets

Assembly

Instagile.Web.Client.dll

public class BoxInput : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, INullableWidget<string?>, IWidget<string?>

Inheritance

object

ComponentBase

BoxInput

Implements

IComponent

IHandleEvent

IHandleAfterRender

INullableWidget<string>

IWidget<string>

Inherited Members

ComponentBase.OnInitialized()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowNulls

If not set, null-state data will be coerced to a non-null value or input will be prevented; IsNull will never be true.

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

Property Value

bool

AttachBottom

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

Property Value

bool

AttachLeft

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

Property Value

bool

AttachRight

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

Property Value

bool

AttachTop

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

Property Value

bool

AutoFocus

If set, the input will be given focus when first rendered. Should generally not be used for controls which are present by default.

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

Property Value

bool

FocusChanged

[Parameter]
public EventCallback<bool> FocusChanged { get; set; }

Property Value

EventCallback<bool>

HasChanges

If true, display a visual indication to the user.

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

Property Value

bool

IsReadOnly

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

Property Value

bool

MaxLength

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

Property Value

int

Splat

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object>? Splat { get; set; }

Property Value

Dictionary<string, object>

Validity

If set, display a visual indication to the user.

[Parameter]
public MessageLevel? Validity { get; set; }

Property Value

MessageLevel?

Value

Bindable typed value.

[Parameter]
public string? Value { get; set; }

Property Value

string

ValueChanged

Triggered when data is entered by the user.

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

Property Value

EventCallback<string>

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnAfterRenderAsync(bool)

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.

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Set to true if this is the first time OnAfterRender(bool) has been invoked on this component instance; otherwise false.

Returns

Task

A Task representing any asynchronous operation.

Remarks

The OnAfterRender(bool) and OnAfterRenderAsync(bool) lifecycle methods are useful for performing interop, or interacting with values received from @ref. Use the firstRender parameter to ensure that initialization work is only performed once.

OnFocusChanged(bool)

protected Task OnFocusChanged(bool focus)

Parameters

focus bool

Returns

Task

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.

protected override void OnParametersSet()