A layout item that visually indicates the start of a section. Items can be accessed or created
from a Form
.
// Open a form by ID and add a new section header. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addSectionHeaderItem(); item.setTitle('Title of new section');
Methods
Method | Return type | Brief description |
---|---|---|
duplicate() | SectionHeaderItem | 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) | SectionHeaderItem | Sets the item's help text (sometimes called description text for layout
items like ImageItems ,
PageBreakItems , and
SectionHeaderItems ). |
setTitle(title) | SectionHeaderItem | Sets the item's title (sometimes called header text, in the case of a
SectionHeaderItem ). |
Detailed documentation
duplicate()
Creates a copy of this item and appends it to the end of the form.
Return
SectionHeaderItem
— a duplicate of this SectionHeaderItem
, 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
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
SectionHeaderItem
— this SectionHeaderItem
, 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
SectionHeaderItem
— this SectionHeaderItem
, for chaining