Class TextItem

A question item that allows the respondent to enter a single line of text. Items can be accessed or created from a Form.

 // Open a form by ID and add a new text item.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 var item = form.addTextItem();
 item.setTitle('What is your name?');

Methods

Method	Return type	Brief description
`createResponse(response)`	`ItemResponse`	Creates a new `ItemResponse` for this text item.
`duplicate()`	`TextItem`	Creates a copy of this item and appends it to the end of the form.
`getHelpText()`	`String`	Gets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`getId()`	`Integer`	Gets the item's unique identifier.
`getIndex()`	`Integer`	Gets the index of the item among all the items in the form.
`getTitle()`	`String`	Gets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).
`getType()`	`ItemType`	Gets the item's type, represented as an `ItemType`.
`isRequired()`	`Boolean`	Determines whether the respondent must answer the question.
`setHelpText(text)`	`TextItem`	Sets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`setRequired(enabled)`	`TextItem`	Sets whether the respondent must answer the question.
`setTitle(title)`	`TextItem`	Sets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).

Detailed documentation

`createResponse(response)`

Creates a new ItemResponse for this text item.

Parameters

Name	Type	Description
`response`	`String`	an answer to the question posed by the item

Return

ItemResponse — the item response

`duplicate()`

Creates a copy of this item and appends it to the end of the form.

Return

TextItem — a duplicate of this TextItem, for chaining

`getHelpText()`

Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Return

String — the item's help text or description text

`getId()`

Gets the item's unique identifier.

Return

Integer — the item's ID

`getIndex()`

Gets the index of the item among all the items in the form.

Return

Integer — the index of the item

`getTitle()`

Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Return

String — the item's title or header text

`getType()`

Gets the item's type, represented as an ItemType.

Return

ItemType — the item's type

`isRequired()`

Determines whether the respondent must answer the question.

Return

Boolean — whether the respondent must answer the question

`setHelpText(text)`

Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Parameters

Name	Type	Description
`text`	`String`	the new help text

Return

TextItem — this TextItem, for chaining

`setRequired(enabled)`

Sets whether the respondent must answer the question.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether the respondent must answer the question

Return

TextItem — the current item (for chaining)

`setTitle(title)`

Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Parameters

Name	Type	Description
`title`	`String`	the new title or header text

Return

TextItem — this TextItem, for chaining

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.