Class SectionHeaderItem

SectionHeaderItem

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

MethodReturn typeBrief description
duplicate()SectionHeaderItemCreates a copy of this item and appends it to the end of the form.
getHelpText()StringGets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
getId()IntegerGets the item's unique identifier.
getIndex()IntegerGets the index of the item among all the items in the form.
getTitle()StringGets the item's title (sometimes called header text, in the case of a SectionHeaderItem).
getType()ItemTypeGets the item's type, represented as an ItemType.
setHelpText(text)SectionHeaderItemSets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
setTitle(title)SectionHeaderItemSets 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


getType()

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

Return

ItemType — the item's type


setHelpText(text)

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

Parameters

NameTypeDescription
textStringthe 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

NameTypeDescription
titleStringthe new title or header text

Return

SectionHeaderItem — this SectionHeaderItem, for chaining

Send feedback about...

Apps Script
Apps Script