TextBoxInput

require(["esri/form/elements/inputs/TextBoxInput"], function(TextBoxInput) { /* code goes here */ });
Class: esri/form/elements/inputs/TextBoxInput
Inheritance: TextBoxInput TextInput Input Accessor
Since: ArcGIS API for JavaScript 4.16

The TextBoxInput class defines the desired user interface as a single-line text box.

See also:

Constructors

new TextBoxInput(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
more detailsAccessor
Number

When set, defines the input's maximum length.

more details
more detailsTextInput
Number

When set, defines the input's minimum length.

more details
more detailsTextInput
String

The type of input.

more details
more detailsTextBoxInput

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

maxLength Number inherited

When set, defines the input's maximum length.

minLength Number inherited

When set, defines the input's minimum length.

type String

The type of input.

For TextBoxInput the type is always "text-box".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
TextInput

Creates a deep clone of the TextInput class.

more details
more detailsTextInput
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsTextBoxInput
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsTextBoxInput

Method Details

Creates a deep clone of the TextInput class.

Returns:
Type Description
TextInput A deep clone of the TextInput instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.