Class SfTextBox

The TextBox is an input element that allows to get input from the user. It allows the user to edit or display the text value.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfTextBox

Namespace: Syncfusion.Blazor.Inputs

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfTextBox : SfBaseComponent, IInputBase

Constructors

SfTextBox()

Declaration

public SfTextBox()

Properties

Autocomplete

Specifies whether the browser is allowed to automatically enter or select a value for the TextBox.

By default, autocomplete is enabled for TextBox.

Possible values are:

• OnSpecifies that autocomplete is enabled
• OffSpecifies that autocomplete is disabled.

Declaration

public AutoComplete Autocomplete { get; set; }

Property Value

Type	Description
AutoComplete

Blur

Triggers when the TextBox has focus-out.

Declaration

public EventCallback<FocusOutEventArgs> Blur { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FocusOutEventArgs>

Created

Triggers when the TextBox component is created.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CssClass

Specifies the CSS class name that can be appended with the root element of the TextBox. One or more custom CSS classes can be added to a TextBox.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

Destroyed

Triggers when the TextBox component is destroyed.

Declaration

public EventCallback<object> Destroyed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Enabled

Specifies a boolean value that indicates whether the TextBox allows the user to interact with it.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Enable or disable the persisting TextBox state between page reloads. If enabled, the Value state will be persisted.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in the right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

FloatLabelType

Specifies the floating label behavior of the TextBox that the placeholder text floats above the TextBox based on the following values.

Possible values are:

• NeverNever floats the label in the TextBox when the placeholder is available.
• AlwaysThe floating label always floats above the TextBox.
• AutoThe floating label floats above the TextBox after focusing it or when enters the value in it.

Declaration

public FloatLabelType FloatLabelType { get; set; }

Property Value

Type	Description
FloatLabelType

Focus

Triggers when the TextBox gets focus.

Declaration

public EventCallback<FocusInEventArgs> Focus { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FocusInEventArgs>

HtmlAttributes

You can add the additional html attributes such as styles, class, and more to the root element. If you configured both property and equivalent html attributes, then the component considers the property value.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Specifies the id of the TextBox component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Input

Triggers each time when the value of TextBox has changed.

Declaration

public EventCallback<InputEventArgs> Input { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<InputEventArgs>

InputAttributes

You can add the additional input attributes such as disabled, value, and more to the root element. If you configured both property and equivalent input attribute, then the component considers the property value.

Declaration

public Dictionary<string, object> InputAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

Locale

Specifies the global culture and localization of the TextBox component.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Multiline

Specifies a boolean value that enables or disables the multiline on the TextBox. The TextBox changes from a single line to multiline when enabling this multiline mode.

Declaration

public bool Multiline { get; set; }

Property Value

Type	Description
System.Boolean

Placeholder

Specifies the text that is shown as a hint or placeholder until the user focuses or enter a value in TextBox. The property is depending on the FloatLabelType property.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String

Readonly

Specifies the boolean value whether the TextBox allows user to change the text.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean

ShowClearButton

Specifies a boolean value that indicates whether the clear button is displayed in TextBox.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean

TabIndex

Specifies the tab order of the TextBox component.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32

TextBoxEditContext

Declaration

protected EditContext TextBoxEditContext { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.Forms.EditContext

TextBoxParent

Declaration

protected dynamic TextBoxParent { get; set; }

Property Value

Type	Description
System.Object

Type

Specifies the behavior of the TextBox such as text, password, email, and more.

Declaration

public InputType Type { get; set; }

Property Value

Type	Description
InputType

Value

Sets the content of the TextBox.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String

ValueChange

Triggers when the content of TextBox has changed and gets focus-out.

Declaration

public EventCallback<ChangedEventArgs> ValueChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ChangedEventArgs>

ValueChanged

Specifies the callback to trigger when the value changes.

Declaration

public EventCallback<string> ValueChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.String>

Width

Specifies the width of the TextBox component.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

AddIcon(String, String)

Adding the icons to the TextBox component.

The icons class is added to icon element. The adding icons to the component based on position for prepend/append.

Declaration

public Task AddIcon(string position, string icons)

Parameters

Type	Name	Description
System.String	position
System.String	icons

Returns

Type	Description
System.Threading.Tasks.Task

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

FocusIn()

Sets the focus to TextBox component for interaction.

Declaration

public Task FocusIn()

Returns

Type	Description
System.Threading.Tasks.Task

FocusOut()

Remove the focus from TextBox component, if the component is in focus state.

Declaration

public Task FocusOut()

Returns

Type	Description
System.Threading.Tasks.Task

GetPersistData()

Gets the properties to be maintained in the persisted state.

Declaration

public Task<string> GetPersistData()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task