Skip to main content

TextBoxBuilder Members

A TextBox control.

Constructors

Name Description
TextBoxBuilder(OptionsOwnerContext) For internal use only. Initializes a new TextBoxBuilder class instance.

Methods

Name Description
AccessKey(JS) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
AccessKey(String) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
ActiveStateEnabled(JS) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
Buttons(JS) Allows you to add custom buttons to the input text field. Mirrors the client-side buttons option.
Buttons(Action<CollectionFactory<TextEditorButtonBuilder>>) Provides access to the client-side buttons option that represents an editor button collection.
Buttons(IEnumerable<TextBoxButtonName>) Allows you to add custom buttons to the input text field. Mirrors the client-side buttons option.
Buttons(IEnumerable<String>) Allows you to add custom buttons to the input text field. Mirrors the client-side buttons option.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FocusStateEnabled(JS) Mirrors the client-side focusStateEnabled option.
FocusStateEnabled(Boolean) Mirrors the client-side focusStateEnabled option.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Height(JS) Specifies the UI component's height. Mirrors the client-side height option.
Height(Double) Specifies the UI component's height. Mirrors the client-side height option.
Height(String) Specifies the UI component's height. Mirrors the client-side height option.
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
HoverStateEnabled(JS) Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Mirrors the client-side hoverStateEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
InputAttr(JS) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InputAttr(Dictionary<String, Object>) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InputAttr(Object) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
InputAttr(String, Object) Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
IsDirty(JS)
IsDirty(Boolean)
IsValid(JS) Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option.
IsValid(Boolean) Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option.
Label(JS)
Label(String)
LabelMode(EditorLabelMode)
Mask(JS) The editor mask that specifies the custom format of the entered string. Mirrors the client-side mask option.
Mask(String) The editor mask that specifies the custom format of the entered string. Mirrors the client-side mask option.
MaskChar(JS) Specifies a mask placeholder. A single character is recommended. Mirrors the client-side maskChar option.
MaskChar(String) Specifies a mask placeholder. A single character is recommended. Mirrors the client-side maskChar option.
MaskInvalidMessage(JS) A message displayed when the entered text does not match the specified pattern. Mirrors the client-side maskInvalidMessage option.
MaskInvalidMessage(String) A message displayed when the entered text does not match the specified pattern. Mirrors the client-side maskInvalidMessage option.
MaskRules(Object) Specifies custom mask rules. Mirrors the client-side maskRules option.
MaxLength(JS) Specifies the maximum number of characters you can enter into the textbox. Mirrors the client-side maxLength option.
MaxLength(Int32) Specifies the maximum number of characters you can enter into the textbox. Mirrors the client-side maxLength option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Mode(TextBoxMode) The 'mode' attribute value of the actual HTML input element representing the text box. Mirrors the client-side mode option.
Name(JS) Mirrors the client-side name option.
Name(String) Mirrors the client-side name option.
OnChange(RazorBlock) A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard. Mirrors the client-side onChange option.
OnChange(String) A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard. Mirrors the client-side onChange option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnCopy(RazorBlock) A function that is executed when the UI component's input has been copied. Mirrors the client-side onCopy option.
OnCopy(String) A function that is executed when the UI component's input has been copied. Mirrors the client-side onCopy option.
OnCut(RazorBlock) A function that is executed when the UI component's input has been cut. Mirrors the client-side onCut option.
OnCut(String) A function that is executed when the UI component's input has been cut. Mirrors the client-side onCut option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnEnterKey(RazorBlock) A function that is executed when the Enter key has been pressed while the UI component is focused. Mirrors the client-side onEnterKey option.
OnEnterKey(String) A function that is executed when the Enter key has been pressed while the UI component is focused. Mirrors the client-side onEnterKey option.
OnFocusIn(RazorBlock) A function that is executed when the UI component gets focus. Mirrors the client-side onFocusIn option.
OnFocusIn(String) A function that is executed when the UI component gets focus. Mirrors the client-side onFocusIn option.
OnFocusOut(RazorBlock) A function that is executed when the UI component loses focus. Mirrors the client-side onFocusOut option.
OnFocusOut(String) A function that is executed when the UI component loses focus. Mirrors the client-side onFocusOut option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInput(RazorBlock) A function that is executed each time the UI component's input is changed while the UI component is focused. Mirrors the client-side onInput option.
OnInput(String) A function that is executed each time the UI component's input is changed while the UI component is focused. Mirrors the client-side onInput option.
OnKeyDown(RazorBlock) A function that is executed when a user is pressing a key on the keyboard. Mirrors the client-side onKeyDown option.
OnKeyDown(String) A function that is executed when a user is pressing a key on the keyboard. Mirrors the client-side onKeyDown option.
OnKeyUp(RazorBlock) A function that is executed when a user releases a key on the keyboard. Mirrors the client-side onKeyUp option.
OnKeyUp(String) A function that is executed when a user releases a key on the keyboard. Mirrors the client-side onKeyUp option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnPaste(RazorBlock) A function that is executed when the UI component's input has been pasted. Mirrors the client-side onPaste option.
OnPaste(String) A function that is executed when the UI component's input has been pasted. Mirrors the client-side onPaste option.
OnValueChanged(RazorBlock) A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option.
OnValueChanged(String) A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option.
Option(String, Object) Specifies an option by its name.
Placeholder(JS) Specifies a text string displayed when the editor's value is empty. Mirrors the client-side placeholder option.
Placeholder(String) Specifies a text string displayed when the editor's value is empty. Mirrors the client-side placeholder option.
ReadOnly(JS) Mirrors the client-side readOnly option.
ReadOnly(Boolean) Mirrors the client-side readOnly option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
ShowClearButton(JS) Specifies whether to display the Clear button in the UI component. Mirrors the client-side showClearButton option.
ShowClearButton(Boolean) Specifies whether to display the Clear button in the UI component. Mirrors the client-side showClearButton option.
ShowMaskMode(ShowMaskMode) Specifies when the UI component shows the mask. Applies only if useMaskedValue is true. Mirrors the client-side showMaskMode option.
Spellcheck(JS) Specifies whether or not the UI component checks the inner text for spelling mistakes. Mirrors the client-side spellcheck option.
Spellcheck(Boolean) Specifies whether or not the UI component checks the inner text for spelling mistakes. Mirrors the client-side spellcheck option.
StylingMode(EditorStylingMode) Specifies how the UI component's text field is styled. Mirrors the client-side stylingMode option.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
UseMaskedValue(JS) Specifies whether the value should contain mask characters or not. Mirrors the client-side useMaskedValue option.
UseMaskedValue(Boolean) Specifies whether the value should contain mask characters or not. Mirrors the client-side useMaskedValue option.
ValidationError(Object) Information on the broken validation rule. Contains the first item from the validationErrors array. Mirrors the client-side validationError option.
ValidationErrors(JS) An array of the validation rules that failed. Mirrors the client-side validationErrors option.
ValidationErrors(IEnumerable) An array of the validation rules that failed. Mirrors the client-side validationErrors option.
ValidationMessageMode(ValidationMessageMode) Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. Mirrors the client-side validationMessageMode option.
ValidationMessagePosition(Position) Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. Mirrors the client-side validationMessagePosition option.
ValidationStatus(ValidationStatus) Indicates or specifies the current validation status. Mirrors the client-side validationStatus option.
Value(JS) Specifies a value the UI component displays. Mirrors the client-side value option.
Value(String) Specifies a value the UI component displays. Mirrors the client-side value option.
ValueChangeEvent(JS) Specifies the DOM events after which the UI component's value should be updated. Mirrors the client-side valueChangeEvent option.
ValueChangeEvent(String) Specifies the DOM events after which the UI component's value should be updated. Mirrors the client-side valueChangeEvent option.
Visible(JS) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Visible(Boolean) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Width(JS) Specifies the UI component's width. Mirrors the client-side width option.
Width(Double) Specifies the UI component's width. Mirrors the client-side width option.
Width(String) Specifies the UI component's width. Mirrors the client-side width option.
See Also