A generic form item that contains properties common to all items, such as title and help text.
Items can be accessed or created from a Form
.
To operate on type-specific properties, use getType()
to check the item's ItemType
, then cast the item to the
appropriate class using a method like asCheckboxItem()
.
// Create a new form and add a text item. var form = FormApp.create('Form Name'); form.addTextItem(); // Access the text item as a generic item. var items = form.getItems(); var item = items[0]; // Cast the generic item to the text-item class. if (item.getType() == 'TEXT') { var textItem = item.asTextItem(); textItem.setRequired(false); }
Implementing classes
Name | Brief description |
---|
Methods
Method | Return type | Brief description |
---|---|---|
asCheckboxGridItem() | CheckboxGridItem | Returns the item as a checkbox grid item. |
asCheckboxItem() | CheckboxItem | Returns the item as a checkbox item. |
asDateItem() | DateItem | Returns the item as a date item. |
asDateTimeItem() | DateTimeItem | Returns the item as a date-time item. |
asDurationItem() | DurationItem | Returns the item as a duration item. |
asGridItem() | GridItem | Returns the item as a grid item. |
asImageItem() | ImageItem | Returns the item as an image item. |
asListItem() | ListItem | Returns the item as a list item. |
asMultipleChoiceItem() | MultipleChoiceItem | Returns the item as a multiple-choice item. |
asPageBreakItem() | PageBreakItem | Returns the item as a page-break item. |
asParagraphTextItem() | ParagraphTextItem | Returns the item as a paragraph-text item. |
asScaleItem() | ScaleItem | Returns the item as a scale item. |
asSectionHeaderItem() | SectionHeaderItem | Returns the item as a section-header item. |
asTextItem() | TextItem | Returns the item as a text item. |
asTimeItem() | TimeItem | Returns the item as a time item. |
asVideoItem() | VideoItem | Returns the item as a video item. |
duplicate() | Item | 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 . |
setHelpText(text) | Item | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setTitle(title) | Item | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
Detailed documentation
asCheckboxGridItem()
Returns the item as a checkbox grid item. Throws a scripting exception if the ItemType
was not already CHECKBOX_GRID
.
Return
CheckboxGridItem
— the checkbox grid item
Throws
Error
— if the item is not a checkbox grid item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asCheckboxItem()
Returns the item as a checkbox item. Throws a scripting exception if the ItemType
was not already CHECKBOX
.
Return
CheckboxItem
— the checkbox item
Throws
Error
— if the item is not a checkbox item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDateItem()
Returns the item as a date item. Throws a scripting exception if the ItemType
was not already DATE
.
Return
DateItem
— the date item
Throws
Error
— if the item is not a date item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDateTimeItem()
Returns the item as a date-time item. Throws a scripting exception if the ItemType
was not already DATETIME
.
Return
DateTimeItem
— the date-time item
Throws
Error
— if the item is not a date-time item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDurationItem()
Returns the item as a duration item. Throws a scripting exception if the ItemType
was not already DURATION
.
Return
DurationItem
— the duration item
Throws
Error
— if the item is not a duration item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asGridItem()
Returns the item as a grid item. Throws a scripting exception if the ItemType
was not already GRID
.
Return
GridItem
— the grid item
Throws
Error
— if the item is not a grid item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asImageItem()
asListItem()
Returns the item as a list item. Throws a scripting exception if the ItemType
was not already LIST
.
Return
ListItem
— the list item
Throws
Error
— if the item is not a list item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asMultipleChoiceItem()
Returns the item as a multiple-choice item. Throws a scripting exception if the ItemType
was not already MULTIPLE_CHOICE
.
Return
MultipleChoiceItem
— the multiple-choice item
Throws
Error
— if the item is not a multiple choice item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asPageBreakItem()
Returns the item as a page-break item. Throws a scripting exception if the ItemType
was not already PAGE_BREAK
.
Return
PageBreakItem
— the page-break item
Throws
Error
— if the item is not a page break item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asParagraphTextItem()
Returns the item as a paragraph-text item. Throws a scripting exception if the ItemType
was not already PARAGRAPH_TEXT
.
Return
ParagraphTextItem
— the paragraph-text item
Throws
Error
— if the item is not a paragraph text item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asScaleItem()
Returns the item as a scale item. Throws a scripting exception if the ItemType
was not already SCALE
.
Return
ScaleItem
— the scale item
Throws
Error
— if the item is not a scale item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asSectionHeaderItem()
Returns the item as a section-header item. Throws a scripting exception if the ItemType
was not already SECTION_HEADER
.
Return
SectionHeaderItem
— the section-header item
Throws
Error
— if the item is not a section header item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asTextItem()
Returns the item as a text item. Throws a scripting exception if the ItemType
was not already TEXT
.
Return
TextItem
— the text item
Throws
Error
— if the item is not a text item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asTimeItem()
Returns the item as a time item. Throws a scripting exception if the ItemType
was not already TIME
.
Return
TimeItem
— the time item
Throws
Error
— if the item is not a time item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asVideoItem()
duplicate()
Creates a copy of this item and appends it to the end of the form.
Return
Item
— a duplicate of this Item
, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
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
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getId()
Gets the item's unique identifier.
Return
Integer
— the item's ID
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getIndex()
Gets the index of the item among all the items in the form.
Return
Integer
— the index of the item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
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
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getType()
Gets the item's type, represented as an ItemType
.
Return
ItemType
— the item's type
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
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
Item
— this Item
, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
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
Item
— this Item
, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms