Um item de formulário genérico que contém propriedades comuns a todos os itens, como título e texto de ajuda.
Os itens podem ser acessados ou criados em um Form
.
Para operar em propriedades específicas do tipo, use getType()
para verificar a ItemType
do item e, em seguida, transmita o item para a
classe adequada usando um método como 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); }
Como implementar classes
Nome | Breve descrição |
---|
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asCheckboxGridItem() | CheckboxGridItem | Retorna o item como um item de grade da caixa de seleção. |
asCheckboxItem() | CheckboxItem | Retorna o item como um item da caixa de seleção. |
asDateItem() | DateItem | Retorna o item como um item de data. |
asDateTimeItem() | DateTimeItem | Retorna o item como um item de data-hora. |
asDurationItem() | DurationItem | Retorna o item como um item de duração. |
asGridItem() | GridItem | Retorna o item como um item de grade. |
asImageItem() | ImageItem | Retorna o item como um item de imagem. |
asListItem() | ListItem | Retorna o item como um item da lista. |
asMultipleChoiceItem() | MultipleChoiceItem | Retorna o item como de múltipla escolha. |
asPageBreakItem() | PageBreakItem | Retorna o item como uma quebra de página. |
asParagraphTextItem() | ParagraphTextItem | Retorna o item como um item de texto de parágrafo. |
asScaleItem() | ScaleItem | Retorna o item como um item de escala. |
asSectionHeaderItem() | SectionHeaderItem | Retorna o item como um item de cabeçalho de seção. |
asTextItem() | TextItem | Retorna o item como um item de texto. |
asTimeItem() | TimeItem | Retorna o item como um item de hora. |
asVideoItem() | VideoItem | Retorna o item como um item de vídeo. |
duplicate() | Item | Cria uma cópia desse item e a anexa ao final do formulário. |
getHelpText() | String | Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems , PageBreakItems e SectionHeaderItems ). |
getId() | Integer | Recebe o identificador exclusivo do item. |
getIndex() | Integer | Recebe o índice do item entre todos os itens do formulário. |
getTitle() | String | Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem ). |
getType() | ItemType | Recebe o tipo do item, representado como um ItemType . |
setHelpText(text) | Item | Define o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems , PageBreakItems e SectionHeaderItems ). |
setTitle(title) | Item | Define o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem ). |
Documentação detalhada
asCheckboxGridItem()
Retorna o item como um item de grade da caixa de seleção. Gera uma exceção de script se o ItemType
ainda não for CHECKBOX_GRID
.
Retorno
CheckboxGridItem
: o item de grade da caixa de seleção
Gera
Error
: se o item não for um item de grade da caixa de seleção
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
asCheckboxItem()
Retorna o item como um item da caixa de seleção. Gera uma exceção de script se o ItemType
ainda não for CHECKBOX
.
Retorno
CheckboxItem
: o item da caixa de seleção
Gera
Error
: se o item não for uma caixa de seleção
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
asDateItem()
Retorna o item como um item de data. Gera uma exceção de script se o ItemType
ainda não for DATE
.
Retorno
DateItem
: o item de data
Gera
Error
: se o item não for de data.
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
asDateTimeItem()
Retorna o item como um item de data-hora. Gera uma exceção de script se o ItemType
ainda não for DATETIME
.
Retorno
DateTimeItem
: o item de data e hora
Gera
Error
: se o item não for de data-hora.
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
asDurationItem()
Retorna o item como um item de duração. Gera uma exceção de script se o ItemType
ainda não for DURATION
.
Retorno
DurationItem
: o item de duração
Gera
Error
: se o item não for de duração.
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
asGridItem()
Retorna o item como um item de grade. Gera uma exceção de script se o ItemType
ainda não for GRID
.
Retorno
GridItem
: item de grade
Gera
Error
: se o item não for de grade.
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
asImageItem()
asListItem()
Retorna o item como um item da lista. Gera uma exceção de script se o ItemType
ainda não for LIST
.
Retorno
ListItem
: o item da lista
Gera
Error
: se o item não for de lista.
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
asMultipleChoiceItem()
Retorna o item como de múltipla escolha. Gera uma exceção de script se o ItemType
ainda não for MULTIPLE_CHOICE
.
Retorno
MultipleChoiceItem
: o item de múltipla escolha
Gera
Error
: se o item não for de múltipla escolha
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
asPageBreakItem()
Retorna o item como uma quebra de página. Gera uma exceção de script se o ItemType
ainda não for PAGE_BREAK
.
Retorno
PageBreakItem
: o item de quebra de página
Gera
Error
: se o item não for uma quebra de página.
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
asParagraphTextItem()
Retorna o item como um item de texto de parágrafo. Gera uma exceção de script se o ItemType
ainda não for PARAGRAPH_TEXT
.
Retorno
ParagraphTextItem
: o item de texto do parágrafo
Gera
Error
: se o item não for um item de texto de parágrafo
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
asScaleItem()
Retorna o item como um item de escala. Gera uma exceção de script se o ItemType
ainda não for SCALE
.
Retorno
ScaleItem
: o item da balança
Gera
Error
: se o item não for um item de escala
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
asSectionHeaderItem()
Retorna o item como um item de cabeçalho de seção. Gera uma exceção de script se o ItemType
ainda não for SECTION_HEADER
.
Retorno
SectionHeaderItem
: o item do cabeçalho da seção
Gera
Error
: se o item não for um item de cabeçalho da seção.
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
asTextItem()
Retorna o item como um item de texto. Gera uma exceção de script se o ItemType
ainda não for TEXT
.
Retorno
TextItem
: o item de texto
Gera
Error
: se o item não for de texto
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
asTimeItem()
Retorna o item como um item de hora. Gera uma exceção de script se o ItemType
ainda não for TIME
.
Retorno
TimeItem
: o item de hora
Gera
Error
: se o item não for um item de data/hora.
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
asVideoItem()
duplicate()
Cria uma cópia desse item e a anexa ao final do formulário.
Retorno
Item
: uma cópia deste Item
, 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
).
Retorno
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.
Retorno
Integer
: 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()
Recebe o índice do item entre todos os itens do formulário.
Retorno
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()
Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem
).
Retorno
String
: título ou 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()
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 |
Retorno
Item
: este Item
, 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 |
Retorno
Item
: este Item
, 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