Class SectionHeaderItem
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Itemdecabeçalhoda seção
Um item de layout que indica visualmente o início de uma seção. Os itens podem ser acessados ou criados
em um Form
.
// Open a form by ID and add a new section header.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addSectionHeaderItem();
item.setTitle('Title of new section');
Documentação detalhada
duplicate()
Cria uma cópia do item e a anexa ao final do formulário.
Retornar
SectionHeaderItem
: uma cópia desta SectionHeaderItem
, para encadeamento
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getHelpText()
Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems
, PageBreakItems
e SectionHeaderItems
).
Retornar
String
: o texto de ajuda ou de descrição do item.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getId()
Recebe o identificador exclusivo do item.
Retornar
Integer
: o ID do item.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getIndex()
Consegue o índice do item entre todos os itens no formulário.
Retornar
Integer
: o índice do item.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getTitle()
Extrai o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem
).
Retornar
String
: o título ou o texto do cabeçalho do item.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getType()
Recebe o tipo do item, representado como um ItemType
.
Retornar
ItemType
: o tipo do item
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setHelpText(text)
Define o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems
, PageBreakItems
e SectionHeaderItems
).
Parâmetros
Nome | Tipo | Descrição |
text | String | o novo texto de ajuda |
Retornar
SectionHeaderItem
: este SectionHeaderItem
, para encadeamento
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setTitle(title)
Define o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem
).
Parâmetros
Nome | Tipo | Descrição |
title | String | o novo título ou texto do cabeçalho |
Retornar
SectionHeaderItem
: este SectionHeaderItem
, para encadeamento
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eA \u003ccode\u003eSectionHeaderItem\u003c/code\u003e visually separates sections within a Google Form, enhancing organization and readability for respondents.\u003c/p\u003e\n"],["\u003cp\u003eYou can programmatically add, duplicate, and modify \u003ccode\u003eSectionHeaderItems\u003c/code\u003e using Apps Script methods like \u003ccode\u003esetTitle()\u003c/code\u003e, \u003ccode\u003esetHelpText()\u003c/code\u003e, and \u003ccode\u003eduplicate()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSectionHeaderItems\u003c/code\u003e provide methods to retrieve their properties, such as \u003ccode\u003egetTitle()\u003c/code\u003e, \u003ccode\u003egetHelpText()\u003c/code\u003e, \u003ccode\u003egetId()\u003c/code\u003e, \u003ccode\u003egetIndex()\u003c/code\u003e, and \u003ccode\u003egetType()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization with specific scopes like \u003ccode\u003ehttps://www.googleapis.com/auth/forms\u003c/code\u003e is necessary when using Apps Script to interact with \u003ccode\u003eSectionHeaderItems\u003c/code\u003e and other form elements.\u003c/p\u003e\n"]]],[],null,["# Class SectionHeaderItem\n\nSectionHeaderItem\n\nA layout item that visually indicates the start of a section. Items can be accessed or created\nfrom a [Form](/apps-script/reference/forms/form).\n\n```javascript\n// Open a form by ID and add a new section header.\nconst form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');\nconst item = form.addSectionHeaderItem();\nitem.setTitle('Title of new section');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [duplicate()](#duplicate()) | [SectionHeaderItem](#) | Creates a copy of this item and appends it to the end of the form. |\n| [getHelpText()](#getHelpText()) | `String` | Gets the item's help text (sometimes called description text for layout items like [ImageItems](/apps-script/reference/forms/image-item), [PageBreakItems](/apps-script/reference/forms/page-break-item), and [SectionHeaderItems](#)). |\n| [getId()](#getId()) | `Integer` | Gets the item's unique identifier. |\n| [getIndex()](#getIndex()) | `Integer` | Gets the index of the item among all the items in the form. |\n| [getTitle()](#getTitle()) | `String` | Gets the item's title (sometimes called header text, in the case of a [SectionHeaderItem](#)). |\n| [getType()](#getType()) | [ItemType](/apps-script/reference/forms/item-type) | Gets the item's type, represented as an [ItemType](/apps-script/reference/forms/item-type). |\n| [setHelpText(text)](#setHelpText(String)) | [SectionHeaderItem](#) | Sets the item's help text (sometimes called description text for layout items like [ImageItems](/apps-script/reference/forms/image-item), [PageBreakItems](/apps-script/reference/forms/page-break-item), and [SectionHeaderItems](#)). |\n| [setTitle(title)](#setTitle(String)) | [SectionHeaderItem](#) | Sets the item's title (sometimes called header text, in the case of a [SectionHeaderItem](#)). |\n\nDetailed documentation\n----------------------\n\n### `duplicate()`\n\nCreates a copy of this item and appends it to the end of the form.\n\n#### Return\n\n\n[SectionHeaderItem](#) --- a duplicate of this [SectionHeaderItem](#), for chaining\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `get``Help``Text()`\n\nGets the item's help text (sometimes called description text for layout items like [ImageItems](/apps-script/reference/forms/image-item), [PageBreakItems](/apps-script/reference/forms/page-break-item), and [SectionHeaderItems](#)).\n\n#### Return\n\n\n`String` --- the item's help text or description text\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `get``Id()`\n\nGets the item's unique identifier.\n\n#### Return\n\n\n`Integer` --- the item's ID\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `get``Index()`\n\nGets the index of the item among all the items in the form.\n\n#### Return\n\n\n`Integer` --- the index of the item\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `get``Title()`\n\nGets the item's title (sometimes called header text, in the case of a [SectionHeaderItem](#)).\n\n#### Return\n\n\n`String` --- the item's title or header text\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `get``Type()`\n\nGets the item's type, represented as an [ItemType](/apps-script/reference/forms/item-type).\n\n#### Return\n\n\n[ItemType](/apps-script/reference/forms/item-type) --- the item's type\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `set``Help``Text(text)`\n\nSets the item's help text (sometimes called description text for layout items like [ImageItems](/apps-script/reference/forms/image-item), [PageBreakItems](/apps-script/reference/forms/page-break-item), and [SectionHeaderItems](#)).\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-------------------|\n| `text` | `String` | the new help text |\n\n#### Return\n\n\n[SectionHeaderItem](#) --- this [SectionHeaderItem](#), for chaining\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`\n\n*** ** * ** ***\n\n### `set``Title(title)`\n\nSets the item's title (sometimes called header text, in the case of a [SectionHeaderItem](#)).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------------------|\n| `title` | `String` | the new title or header text |\n\n#### Return\n\n\n[SectionHeaderItem](#) --- this [SectionHeaderItem](#), for chaining\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/forms.currentonly`\n- `https://www.googleapis.com/auth/forms`"]]