Class SfInputTextBase<TValue>

The SfInputBase 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
SfBaseComponent
SfInputTextBase<TValue>
CalendarBase<T>
SfTimePicker<TValue>
NumericTextBoxEvents<TValue>
SfNumericTextBox<TValue>
SfTextBox
Inherited Members
Namespace: Syncfusion.Blazor.Inputs
Assembly: Syncfusion.Blazor.dll
Syntax
public abstract class SfInputTextBase<TValue> : SfBaseComponent
Type Parameters
Name Description
TValue

Constructors

SfInputTextBase()

Declaration
protected SfInputTextBase()

Fields

APPEND

Declaration
protected const string APPEND = "append"
Field Value
Type Description
System.String

APPEND_ICON

Declaration
protected const string APPEND_ICON = "e-append"
Field Value
Type Description
System.String

ARIA_DISABLED

Declaration
protected const string ARIA_DISABLED = "aria-disabled"
Field Value
Type Description
System.String

CLEAR_ICON_HIDE

Declaration
protected const string CLEAR_ICON_HIDE = "e-clear-icon e-clear-icon-hide"
Field Value
Type Description
System.String

CLEARICONHIDE

Declaration
protected const string CLEARICONHIDE = "e-clear-icon-hide"
Field Value
Type Description
System.String

CONTROL_CONTAINER

Declaration
protected const string CONTROL_CONTAINER = "e-control-container"
Field Value
Type Description
System.String

CONTROL_OLD_CONTAINER

Declaration
protected const string CONTROL_OLD_CONTAINER = "e-control-wrapper"
Field Value
Type Description
System.String

DECREMENT

Declaration
protected const string DECREMENT = "Decrement value"
Field Value
Type Description
System.String

DECREMENT_TITLE

Declaration
protected const string DECREMENT_TITLE = "NumericTextBox_DecrementTitle"
Field Value
Type Description
System.String

DISABLE

Declaration
protected const string DISABLE = "e-disabled"
Field Value
Type Description
System.String

DISABLE_ICON

Declaration
protected const string DISABLE_ICON = "e-ddl-disable-icon"
Field Value
Type Description
System.String

DISABLED_ATTR

Declaration
protected const string DISABLED_ATTR = "disabled"
Field Value
Type Description
System.String

FLOATINPUT

Declaration
protected const string FLOATINPUT = "e-float-input"
Field Value
Type Description
System.String

FLOATLABELBOTTOM

Declaration
protected const string FLOATLABELBOTTOM = "e-label-bottom"
Field Value
Type Description
System.String

FLOATLABELTOP

Declaration
protected const string FLOATLABELTOP = "e-label-top"
Field Value
Type Description
System.String

FLOATTEXT

Declaration
protected const string FLOATTEXT = "e-float-text"
Field Value
Type Description
System.String

GROUP_ICON

Declaration
protected const string GROUP_ICON = "e-input-group-icon"
Field Value
Type Description
System.String

INCREMENT

Declaration
protected const string INCREMENT = "Increment value"
Field Value
Type Description
System.String

INCREMENT_TITLE

Declaration
protected const string INCREMENT_TITLE = "NumericTextBox_IncrementTitle"
Field Value
Type Description
System.String

INPUT

Declaration
protected const string INPUT = "e-input"
Field Value
Type Description
System.String

INPUTFOCUS

Declaration
protected const string INPUTFOCUS = "e-input-focus"
Field Value
Type Description
System.String

INPUTGROUP

Declaration
protected const string INPUTGROUP = "e-input-group"
Field Value
Type Description
System.String

MULTILINE

Declaration
protected const string MULTILINE = "e-multi-line-input"
Field Value
Type Description
System.String

PREPEND

Declaration
protected const string PREPEND = "prepend"
Field Value
Type Description
System.String

PREPEND_ICON

Declaration
protected const string PREPEND_ICON = "e-prepend"
Field Value
Type Description
System.String

SPACE

Declaration
protected const string SPACE = " "
Field Value
Type Description
System.String

SPIN_DOWN

Declaration
protected const string SPIN_DOWN = "e-spin-down"
Field Value
Type Description
System.String

SPIN_UP

Declaration
protected const string SPIN_UP = "e-spin-up"
Field Value
Type Description
System.String

Properties

_value

Declaration
protected TValue _value { get; set; }
Property Value
Type Description
TValue

BaseAutocomplete

Declaration
protected virtual string BaseAutocomplete { get; set; }
Property Value
Type Description
System.String

BaseFloatLabelType

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
protected virtual FloatLabelType BaseFloatLabelType { get; set; }
Property Value
Type Description
FloatLabelType

BaseHtmlAttributes

Declaration
protected virtual Dictionary<string, object> BaseHtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

BaseInputAttributes

Declaration
protected virtual Dictionary<string, object> BaseInputAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

BaseIsReadOnlyInput

Declaration
protected virtual bool BaseIsReadOnlyInput { get; set; }
Property Value
Type Description
System.Boolean

BasePlaceholder

Declaration
protected virtual string BasePlaceholder { get; set; }
Property Value
Type Description
System.String

BaseReadonly

Declaration
protected virtual bool BaseReadonly { get; set; }
Property Value
Type Description
System.Boolean

BaseShowClearButton

Declaration
protected virtual bool BaseShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

BaseTabIndex

Declaration
protected virtual int BaseTabIndex { get; set; }
Property Value
Type Description
System.Int32

BaseWidth

Declaration
protected virtual string BaseWidth { get; set; }
Property Value
Type Description
System.String

ClearElement

Declaration
protected ElementReference ClearElement { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.ElementReference

ComponentReference

Declaration
protected virtual string ComponentReference { get; set; }
Property Value
Type Description
System.String

ContainerAttr

Specifies the container attrubute of Input.

Declaration
protected Dictionary<string, object> ContainerAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

containerAttributes

Declaration
protected List<string> containerAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

CssClass

Gets or sets a CSS class string to customize the appearance of the component.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

Accepts a CSS class string separated by space to customize the appearance. The default value is String.Empty.

DataId

Declaration
protected string DataId { get; set; }
Property Value
Type Description
System.String

DecrementTitle

Declaration
protected string DecrementTitle { get; set; }
Property Value
Type Description
System.String

Enabled

Gets or sets a value that indicates whether to enable or disable the component.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

true, if the component is enabled; otherwise, it is disabled. The default value is true.

EnablePersistence

Gets or sets whether to persist component's state between page reloads. When set to true, the Value property is persisted.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

true, if the component's state persistence is enabled. The default value is false.
Remarks

Component's Value property will be stored in browser local storage to persist component's state when page reloads.

EnableRtl

Gets or sets whether the right-to-left direction is enabled or not for the component.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

true, if the right to left direction is enabled for component. The default value is false.

FloatLabel

Declaration
protected string FloatLabel { get; set; }
Property Value
Type Description
System.String

ID

Gets or sets the ID of the component.

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

A string representing the identifier of the component.
Remarks

The ID property allows you to uniquely identify the component in the rendered HTML markup. If you don't set a custom ID, the component's ID will be auto-generated, and it may not be as descriptive as you require.

IncrementTitle

Declaration
protected string IncrementTitle { get; set; }
Property Value
Type Description
System.String

inputAttr

Declaration
protected Dictionary<string, object> inputAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

InputEditContext

Specifies the edit context of the Input.

Declaration
protected EditContext InputEditContext { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.Forms.EditContext

IsClearButtonClicked

Declaration
protected bool IsClearButtonClicked { get; set; }
Property Value
Type Description
System.Boolean

IsFocused

Declaration
protected bool IsFocused { get; set; }
Property Value
Type Description
System.Boolean

ListOfButtons

Declaration
protected List<SfInputTextBase<TValue>.ButtonGroups> ListOfButtons { get; set; }
Property Value
Type Description
System.Collections.Generic.List<SfInputTextBase.ButtonGroups<>>

MultilineInput

Declaration
protected virtual bool MultilineInput { get; set; }
Property Value
Type Description
System.Boolean

ValidateOnInput

Gets or sets a value indicating whether validation should be performed on each input.

Declaration
public bool ValidateOnInput { get; set; }
Property Value
Type Description
System.Boolean

true if validation should be performed on each input; otherwise, false.The default value is false.
Remarks

This property is used to validate the form on typing into the input and updating the model value. The ValueChange event will be fired after the component lost its focus.

Value

Gets or sets the value of the component.

Declaration
public TValue Value { get; set; }
Property Value
Type Description
TValue

The current value of the component.

ValueChanged

Gets or sets the callback to trigger when the value changes.

Declaration
public EventCallback<TValue> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<TValue>

Event callback

Methods

ChangeHandler(ChangeEventArgs)

Declaration
protected virtual Task ChangeHandler(ChangeEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.ChangeEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

FocusHandler(FocusEventArgs)

Declaration
protected virtual Task FocusHandler(FocusEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.FocusEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

FocusOutHandler(FocusEventArgs)

Declaration
protected virtual Task FocusOutHandler(FocusEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.FocusEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

FormatValue(String)

Declaration
protected virtual TValue FormatValue(string genericValue)
Parameters
Type Name Description
System.String genericValue
Returns
Type Description
TValue

FormatValueAsString(TValue)

Declaration
protected virtual string FormatValueAsString(TValue formatValue)
Parameters
Type Name Description
TValue formatValue
Returns
Type Description
System.String

InputHandler(ChangeEventArgs)

Declaration
protected virtual Task InputHandler(ChangeEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.ChangeEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides

OnChangeHandler(ChangeEventArgs)

Declaration
protected Task OnChangeHandler(ChangeEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.ChangeEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

OnInitializedAsync()

Triggers while initial rendering of the component.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

The System.Threading.Tasks.Task.
Overrides

OnInputHandler(ChangeEventArgs)

Declaration
protected Task OnInputHandler(ChangeEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.ChangeEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

OnParametersSetAsync()

Triggers when dynamically changing the component property.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

The System.Threading.Tasks.Task.

OnPasteHandler(ClipboardEventArgs)

Declaration
protected Task OnPasteHandler(ClipboardEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.ClipboardEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

SetEnabled()

The setEnabled.

Declaration
protected void SetEnabled()

WireClearBtnEvents()

Declaration
protected Task WireClearBtnEvents()
Returns
Type Description
System.Threading.Tasks.Task