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
SfInputTextBase<TValue>
Assembly: Syncfusion.Blazor.dll
Syntax
public abstract class SfInputTextBase<TValue> : SfBaseComponent
Type Parameters
Constructors
SfInputTextBase()
Declaration
protected SfInputTextBase()
Fields
APPEND
Declaration
protected const string APPEND = "append"
Field Value
APPEND_ICON
Declaration
protected const string APPEND_ICON = "e-append"
Field Value
ARIA_DISABLED
Declaration
protected const string ARIA_DISABLED = "aria-disabled"
Field Value
CLEAR_ICON_HIDE
Declaration
protected const string CLEAR_ICON_HIDE = "e-clear-icon e-clear-icon-hide"
Field Value
CLEARICONHIDE
Declaration
protected const string CLEARICONHIDE = "e-clear-icon-hide"
Field Value
CONTROL_CONTAINER
Declaration
protected const string CONTROL_CONTAINER = "e-control-container"
Field Value
CONTROL_OLD_CONTAINER
Declaration
protected const string CONTROL_OLD_CONTAINER = "e-control-wrapper"
Field Value
DECREMENT
Declaration
protected const string DECREMENT = "Decrement value"
Field Value
DECREMENT_TITLE
Declaration
protected const string DECREMENT_TITLE = "NumericTextBox_DecrementTitle"
Field Value
DISABLE
Declaration
protected const string DISABLE = "e-disabled"
Field Value
DISABLE_ICON
Declaration
protected const string DISABLE_ICON = "e-ddl-disable-icon"
Field Value
DISABLED_ATTR
Declaration
protected const string DISABLED_ATTR = "disabled"
Field Value
FLOATINPUT
Declaration
protected const string FLOATINPUT = "e-float-input"
Field Value
FLOATLABELBOTTOM
Declaration
protected const string FLOATLABELBOTTOM = "e-label-bottom"
Field Value
FLOATLABELTOP
Declaration
protected const string FLOATLABELTOP = "e-label-top"
Field Value
FLOATTEXT
Declaration
protected const string FLOATTEXT = "e-float-text"
Field Value
GROUP_ICON
Declaration
protected const string GROUP_ICON = "e-input-group-icon"
Field Value
INCREMENT
Declaration
protected const string INCREMENT = "Increment value"
Field Value
INCREMENT_TITLE
Declaration
protected const string INCREMENT_TITLE = "NumericTextBox_IncrementTitle"
Field Value
INPUT
Declaration
protected const string INPUT = "e-input"
Field Value
INPUTFOCUS
Declaration
protected const string INPUTFOCUS = "e-input-focus"
Field Value
INPUTGROUP
Declaration
protected const string INPUTGROUP = "e-input-group"
Field Value
MULTILINE
Declaration
protected const string MULTILINE = "e-multi-line-input"
Field Value
PREPEND
Declaration
protected const string PREPEND = "prepend"
Field Value
PREPEND_ICON
Declaration
protected const string PREPEND_ICON = "e-prepend"
Field Value
SPACE
Declaration
protected const string SPACE = " "
Field Value
SPIN_DOWN
Declaration
protected const string SPIN_DOWN = "e-spin-down"
Field Value
SPIN_UP
Declaration
protected const string SPIN_UP = "e-spin-up"
Field Value
Properties
_value
Declaration
protected TValue _value { get; set; }
Property Value
BaseAutocomplete
Declaration
protected virtual string BaseAutocomplete { get; set; }
Property Value
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
BaseHtmlAttributes
Declaration
protected virtual Dictionary<string, object> BaseHtmlAttributes { get; set; }
Property Value
Type |
System.Collections.Generic.Dictionary<System.String, System.Object> |
BaseInputAttributes
Declaration
protected virtual Dictionary<string, object> BaseInputAttributes { get; set; }
Property Value
Type |
System.Collections.Generic.Dictionary<System.String, System.Object> |
BaseIsReadOnlyInput
Declaration
protected virtual bool BaseIsReadOnlyInput { get; set; }
Property Value
BasePlaceholder
Declaration
protected virtual string BasePlaceholder { get; set; }
Property Value
BaseReadonly
Declaration
protected virtual bool BaseReadonly { get; set; }
Property Value
BaseShowClearButton
Declaration
protected virtual bool BaseShowClearButton { get; set; }
Property Value
BaseTabIndex
Declaration
protected virtual int BaseTabIndex { get; set; }
Property Value
BaseWidth
Declaration
protected virtual string BaseWidth { get; set; }
Property Value
ClearElement
Declaration
protected ElementReference ClearElement { get; set; }
Property Value
Type |
Microsoft.AspNetCore.Components.ElementReference |
ComponentReference
Declaration
protected virtual string ComponentReference { get; set; }
Property Value
ContainerAttr
Specifies the container attrubute of Input.
Declaration
protected Dictionary<string, object> ContainerAttr { get; set; }
Property Value
Type |
System.Collections.Generic.Dictionary<System.String, System.Object> |
containerAttributes
Declaration
protected List<string> containerAttributes { get; set; }
Property Value
Type |
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
DecrementTitle
Declaration
protected string DecrementTitle { get; set; }
Property Value
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 .
|
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
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.
|
IncrementTitle
Declaration
protected string IncrementTitle { get; set; }
Property Value
inputAttr
Declaration
protected Dictionary<string, object> inputAttr { get; set; }
Property Value
Type |
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 |
Microsoft.AspNetCore.Components.Forms.EditContext |
IsClearButtonClicked
Declaration
protected bool IsClearButtonClicked { get; set; }
Property Value
IsFocused
Declaration
protected bool IsFocused { get; set; }
Property Value
ListOfButtons
Declaration
protected List<SfInputTextBase<TValue>.ButtonGroups> ListOfButtons { get; set; }
Property Value
MultilineInput
Declaration
protected virtual bool MultilineInput { get; set; }
Property Value
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 .
|
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 |
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 |
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 |
System.Threading.Tasks.Task |
FormatValue(String)
Declaration
protected virtual TValue FormatValue(string genericValue)
Parameters
Type |
Name |
Description |
System.String |
genericValue |
|
Returns
FormatValueAsString(TValue)
Declaration
protected virtual string FormatValueAsString(TValue formatValue)
Parameters
Type |
Name |
Description |
TValue |
formatValue |
|
Returns
InputHandler(ChangeEventArgs)
Declaration
protected virtual Task InputHandler(ChangeEventArgs args)
Parameters
Type |
Name |
Description |
Microsoft.AspNetCore.Components.ChangeEventArgs |
args |
|
Returns
Type |
System.Threading.Tasks.Task |
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type |
Name |
Description |
System.Boolean |
firstRender |
|
Returns
Type |
System.Threading.Tasks.Task |
Overrides
OnChangeHandler(ChangeEventArgs)
Declaration
protected Task OnChangeHandler(ChangeEventArgs args)
Parameters
Type |
Name |
Description |
Microsoft.AspNetCore.Components.ChangeEventArgs |
args |
|
Returns
Type |
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 |
System.Threading.Tasks.Task |
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 |
System.Threading.Tasks.Task |
SetEnabled()
Declaration
protected void SetEnabled()
WireClearBtnEvents()
Declaration
protected Task WireClearBtnEvents()
Returns
Type |
System.Threading.Tasks.Task |