Class CheckboxGridItem

CheckboxGridItem

Item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar várias opções por linha em uma sequência de caixas de seleção. Os itens podem ser acessados ou criados Form:

// Open a form by ID and add a new checkbox grid item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addCheckboxGridItem();
item.setTitle('Where did you celebrate New Years?')
  .setRows(['New York', 'San Francisco', 'London'])
  .setColumns(['2014', '2015', '2016', '2017']);

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()CheckboxGridItemRemove qualquer validação de dados para esse item da grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item de grade da caixa de seleção.
duplicate()CheckboxGridItemCria uma cópia desse item e a anexa ao final do formulário.
getColumns()String[]Recebe os valores de cada coluna na grade.
getHelpText()StringRecebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).
getId()IntegerExtrai o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getRows()String[]Recebe os valores de cada linha na grade.
getTitle()StringRecebe o título do item (às vezes chamado de texto de cabeçalho, no caso de uma SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como ItemType.
isRequired()BooleanDetermina se o respondente precisa responder à pergunta.
setColumns(columns)CheckboxGridItemDefine as colunas da grade com base em uma matriz de valores.
setHelpText(text)CheckboxGridItemDefine o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).
setRequired(enabled)CheckboxGridItemDefine se o participante precisa responder à pergunta.
setRows(rows)CheckboxGridItemDefine as linhas da grade com base em uma matriz de valores.
setTitle(title)CheckboxGridItemDefine o título do item, às vezes chamado de texto de cabeçalho, no caso de uma SectionHeaderItem.
setValidation(validation)CheckboxGridItemDefine a validação de dados para esse item de grade da caixa de seleção.

Documentação detalhada

clearValidation()

Remove qualquer validação de dados para esse item da grade.

Retornar

CheckboxGridItem: este item para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createResponse(responses)

Cria um novo ItemResponse para esse item de grade da caixa de seleção. O argumento responses precisa ser uma matriz String[][] de matrizes contendo tantos valores quanto o número de entradas na grade de caixas de seleção. Um elemento null para uma pergunta de grade com caixas de seleção não obrigatória indica que não há resposta para essa linha. Emite uma exceção se algum dos valores não corresponde a um uma escolha válida.

Parâmetros

NomeTipoDescrição
responsesString[][]uma matriz de matrizes de respostas válidas para este item da grade da caixa de seleção

Retornar

ItemResponse: a resposta do item.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

duplicate()

Cria uma cópia desse item e a anexa ao final do formulário.

Retornar

CheckboxGridItem: uma cópia deste CheckboxGridItem para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getColumns()

Recebe os valores de cada coluna na grade.

Retornar

String[]: uma matriz de valores de coluna, que os entrevistados veem como rótulos ao visualizar o formulário

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

Extrai o identificador exclusivo do item.

Retornar

Integer: o código do item.

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

Integer: o índice do item.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getRows()

Recebe os valores de cada linha na grade.

Retornar

String[]: uma matriz de valores de linha, que os entrevistados veem como rótulos ao visualizar o formulário

Autorização

Os scripts que usam esse método precisam de 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 de cabeçalho, no caso de uma SectionHeaderItem).

Retornar

String: o título ou texto do cabeçalho do item

Autorização

Os scripts que usam esse método precisam de 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 ItemType.

Retornar

ItemType: o tipo do item.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isRequired()

Determina se o respondente precisa responder à pergunta.

Retornar

Boolean: se o participante precisa responder à pergunta.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setColumns(columns)

Define as colunas da grade com base em uma matriz de valores. Gera uma exceção se o tipo matriz está vazia.

Parâmetros

NomeTipoDescrição
columnsString[]uma matriz de valores de coluna, que os entrevistados veem como rótulos ao visualizar o formulário

Retornar

CheckboxGridItem: este item para encadeamento.

Gera

Error: se a matriz fornecida for null ou estiver vazia

Autorização

Os scripts que usam esse método precisam de 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

NomeTipoDescrição
textStringo novo texto de ajuda

Retornar

CheckboxGridItem: este CheckboxGridItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRequired(enabled)

Define se o participante precisa responder à pergunta.

Parâmetros

NomeTipoDescrição
enabledBooleanse o entrevistado deve responder à pergunta

Retornar

CheckboxGridItem: o item atual (para encadeamento).

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRows(rows)

Define as linhas da grade com base em uma matriz de valores. Gera uma exceção se a matriz fornecida está vazio.

Parâmetros

NomeTipoDescrição
rowsString[]uma matriz de valores de linha, que os entrevistados veem como rótulos ao visualizar o formulário

Retornar

CheckboxGridItem: este item para encadeamento.

Gera

Error: se a matriz fornecida for null ou estiver vazia

Autorização

Os scripts que usam esse método precisam de 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 de cabeçalho, no caso de uma SectionHeaderItem.

Parâmetros

NomeTipoDescrição
titleStringo novo título ou texto do cabeçalho

Retornar

CheckboxGridItem: este CheckboxGridItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setValidation(validation)

Define a validação de dados para esse item de grade da caixa de seleção. Transmitir um valor nulo ou uma validação sem de qualquer função "require", chamada, removerá qualquer validação anterior.

Parâmetros

NomeTipoDescrição
validationCheckboxGridValidationum CheckboxGridValidation para aplicar a esse item.

Retornar

CheckboxGridItem: este CheckboxGridItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms