TextBoxInput
require(["esri/form/elements/inputs/TextBoxInput"], function(TextBoxInput) { /* code goes here */ });esri/form/elements/inputs/TextBoxInputThe TextBoxInput class defines the desired user interface as a single-line text box.
- See also:
Constructors
- new TextBoxInput(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| Number | When set, defines the input's maximum length. more details | more details | TextInput | |
| Number | When set, defines the input's minimum length. more details | more details | TextInput | |
| String | The type of input. more details | more details | TextBoxInput |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
When set, defines the input's maximum length.
When set, defines the input's minimum length.
- type String
The type of input.
For TextBoxInput the type is always "text-box".
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| TextInput | Creates a deep clone of the | more details | TextInput | |
| * | 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 details | TextBoxInput | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | TextBoxInput |
Method Details
Creates a deep clone of the
TextInputclass.Returns:Type Description TextInput A deep clone of the TextInputinstance.
- 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
jsonparameter 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 ObjectA 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.