TextBoxInput

AMD: require(["esri/form/elements/inputs/TextBoxInput"], (TextBoxInput) => { /* code goes here */ });
ESM: import TextBoxInput from "@arcgis/core/form/elements/inputs/TextBoxInput";
Class: esri/form/elements/inputs/TextBoxInput
Inheritance: TextBoxInput 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
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

When set, defines the text input's maximum length.

more detailsTextBoxInput
Numbermore details

When set, defines the text input's minimum length.

more detailsTextBoxInput
Stringmore details

The type of form element input.

more detailsTextBoxInput

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 text input's maximum length.

minLength Number

When set, defines the text input's minimum length.

type Stringreadonly

The type of form element input.

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

Method Overview

Name Return Type Summary Class
TextBoxInputmore details

Creates a deep clone of the TextBoxInput class.

more detailsTextBoxInput
*more details

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

more detailsTextBoxInput
Objectmore details

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

more detailsTextBoxInput

Method Details

clone(){TextBoxInput}

Creates a deep clone of the TextBoxInput class.

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

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.