Class CheckboxGridItem

CheckboxGridItem

Un élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet à la personne interrogée de sélectionner plusieurs choix par ligne à partir d'une séquence de cases à cocher. Les éléments peuvent être consultés et créés à partir d'un 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éthodes

MéthodeType renvoyéBrève description
clearValidation()CheckboxGridItemSupprime toute validation des données pour cet élément de grille.
createResponse(responses)ItemResponseCrée un ItemResponse pour cet élément de grille à cases à cocher.
duplicate()CheckboxGridItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getColumns()String[]Récupère les valeurs de chaque colonne de la grille.
getHelpText()StringRécupère le texte d'aide de l'élément (parfois appelé "texte de description" pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()IntegerRécupère l'identifiant unique de l'élément.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getRows()String[]Récupère les valeurs de chaque ligne de la grille.
getTitle()StringRécupère le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type d'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setColumns(columns)CheckboxGridItemDéfinit les colonnes de la grille en fonction d'un tableau de valeurs.
setHelpText(text)CheckboxGridItemDéfinit le texte d'aide de l'élément (parfois appelé "texte de description" pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setRequired(enabled)CheckboxGridItemDétermine si la personne interrogée doit répondre à la question.
setRows(rows)CheckboxGridItemDéfinit les lignes de la grille en fonction d'un tableau de valeurs.
setTitle(title)CheckboxGridItemDéfinit le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une propriété SectionHeaderItem).
setValidation(validation)CheckboxGridItemDéfinit la validation des données pour cet élément de grille à cases à cocher.

Documentation détaillée

clearValidation()

Supprime toute validation des données pour cet élément de grille.

Renvois

CheckboxGridItem : cet élément, pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

createResponse(responses)

Crée un ItemResponse pour cet élément de grille à cases à cocher. L'argument responses doit être un tableau de tableaux String[][] contenant autant de valeurs que le nombre d'entrées dans la grille de cases à cocher. Élément null pour une question de grille de cases à cocher non obligatoire indique l'absence de réponse à cette ligne. La fonction renvoie une exception si l'une des valeurs ne correspond pas à un choix valide.

Paramètres

NomTypeDescription
responsesString[][]Tableau de tableaux de réponses valides pour cet élément de grille à cases à cocher

Renvois

ItemResponse : réponse de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

CheckboxGridItem : doublon de CheckboxGridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getColumns()

Récupère les valeurs de chaque colonne de la grille.

Renvois

String[] : tableau de valeurs de colonnes, que les personnes interrogées voient sous forme d'étiquettes lorsqu'elles consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getHelpText()

Récupère le texte d'aide de l'élément (parfois appelé "texte de description" pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getId()

Récupère l'identifiant unique de l'élément.

Renvois

Integer : ID de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getIndex()

Récupère l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getRows()

Récupère les valeurs de chaque ligne de la grille.

Renvois

String[] : tableau de valeurs de ligne, que les personnes interrogées voient sous forme d'étiquettes lorsqu'elles consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getTitle()

Récupère le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getType()

Récupère le type d'élément, représenté par ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

isRequired()

Détermine si la personne interrogée doit répondre à la question.

Renvois

Boolean : indique si la personne interrogée doit répondre à la question.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setColumns(columns)

Définit les colonnes de la grille en fonction d'un tableau de valeurs. La fonction renvoie une exception si la valeur est vide.

Paramètres

NomTypeDescription
columnsString[]Un tableau de valeurs de colonnes, que les répondants voient sous forme d'étiquettes lorsqu'ils consultent le formulaire

Renvois

CheckboxGridItem : cet élément, pour l'enchaînement

Génère

Error : si le tableau donné est null ou vide

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé "texte de description" pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

NomTypeDescription
textStringle nouveau texte d'aide

Renvois

CheckboxGridItem : CheckboxGridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setRequired(enabled)

Détermine si la personne interrogée doit répondre à la question.

Paramètres

NomTypeDescription
enabledBooleansi la personne interrogée doit répondre à la question ;

Renvois

CheckboxGridItem : élément actuel (pour l'enchaînement)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setRows(rows)

Définit les lignes de la grille en fonction d'un tableau de valeurs. Génère une exception si le tableau donné est vide.

Paramètres

NomTypeDescription
rowsString[]Un tableau de valeurs de ligne, que les personnes interrogées voient sous forme d'étiquettes lorsqu'elles consultent le formulaire

Renvois

CheckboxGridItem : cet élément, pour l'enchaînement

Génère

Error : si le tableau donné est null ou vide

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setTitle(title)

Définit le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une propriété SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte d'en-tête

Renvois

CheckboxGridItem : CheckboxGridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setValidation(validation)

Définit la validation des données pour cet élément de grille à cases à cocher. La transmission d'une valeur nulle ou d'une validation sans toutes les fonctions de demande appelées supprimeront toute validation antérieure.

Paramètres

NomTypeDescription
validationCheckboxGridValidationune CheckboxGridValidation à appliquer à cet élément.

Renvois

CheckboxGridItem : CheckboxGridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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