Skip To ContentArcGIS for DevelopersSign In Dashboard

TextInput

Class: esri/form/elements/inputs/TextInput
Inheritance: TextInput Input Accessor
Since: ArcGIS API for JavaScript 4.16

The base class for both esri/form/elements/TextAreaInput and esri/form/elements/TextBoxInput classes.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
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

Indicates the type of form element input.

more details
more detailsTextInput

Property Details

declaredClass Stringreadonly inherited

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

maxLength Number

When set, defines the input's maximum length.

minLength Number

When set, defines the input's minimum length.

type Stringreadonly

Indicates the type of form element input.

Possible Values:"text-area"|"text-box"

Method Overview

NameReturn TypeSummaryClass
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 detailsTextInput
Object

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

more details
more detailsTextInput

Method Details

clone(){TextInput}

Creates a deep clone of the TextInput class.

Returns:
TypeDescription
TextInputA 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...