Class GridItem

Élément de la grille

Élément de question présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner un choix par ligne parmi une séquence de cases d'option. Vous pouvez accéder aux éléments ou en créer à partir d'un Form.

// Open a form by ID and add a new grid item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addGridItem();
item.setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);

Méthodes

MéthodeType renvoyéBrève description
clearValidation()GridItemSupprime toute validation de données pour cet élément de grille.
createResponse(responses)ItemResponseCrée un ItemResponse pour cet élément de grille.
duplicate()GridItemCré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'indice 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'un SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par un ItemType.
isRequired()BooleanIndique si la personne interrogée doit répondre à la question.
setColumns(columns)GridItemDéfinit les colonnes de la grille en fonction d'un tableau de valeurs.
setHelpText(text)GridItemDé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)GridItemIndique si la personne interrogée doit répondre à la question.
setRows(rows)GridItemDéfinit les lignes de la grille en fonction d'un tableau de valeurs.
setTitle(title)GridItemDéfinit le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un SectionHeaderItem).
setValidation(validation)GridItemDéfinit la validation des données pour cet élément de grille.

Documentation détaillée

clearValidation()

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

Renvois

GridItem : cet élément, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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. L'argument responses doit être un tableau String[] contenant autant de valeurs que le nombre de lignes de la grille. Un élément null pour une question de type grille non obligatoire indique qu'aucune réponse n'a été fournie pour cette ligne. Génère une exception si l'une des valeurs ne correspond pas à un choix valide.

Paramètres

NomTypeDescription
responsesString[]un tableau de réponses valides pour cet élément de grille ;

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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

GridItem : double de cet élément GridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 colonne, que les personnes interrogées voient comme des libellés lorsqu'elles consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 de description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'indice 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 avec 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 de libellés lorsqu'elles consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'un SectionHeaderItem).

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 de l'élément, représenté par un ItemType.

Renvois

ItemType : type de l'élément

Autorisation

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

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

isRequired()

Indique 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 avec 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. Génère une exception si le tableau donné est vide.

Paramètres

NomTypeDescription
columnsString[]un tableau de valeurs de colonne, que les personnes interrogées voient comme des libellés lorsqu'elles consultent le formulaire ;

Renvois

GridItem : cet élément, pour le chaînage

Génère

Error : si le tableau donné est null ou vide

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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

GridItem : GridItem, pour le chaînage

Autorisation

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

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

setRequired(enabled)

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

Paramètres

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

Renvois

GridItem : élément actuel (pour l'association en chaîne)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 de libellés lorsqu'elles consultent le formulaire ;

Renvois

GridItem : cet élément, pour le chaînage

Génère

Error : si le tableau donné est null ou vide

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'un SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou le nouveau texte de l'en-tête ;

Renvois

GridItem : GridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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. Si vous transmettez la valeur nulle ou une validation sans aucune fonction requise appelée, toute validation précédente sera supprimée.

Paramètres

NomTypeDescription
validationGridValidationune validation de grille à appliquer à cet élément.

Renvois

GridItem : GridItem, pour le chaînage

Autorisation

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

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