Class GridItem

GridItem

É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 à partir d'une séquence de cases d'option. Les éléments sont accessibles ou peuvent être créés à 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éthode	Type renvoyé	Brève description
clearValidation()	GridItem	Supprime toute validation des données pour cet élément de grille.
createResponse(responses)	ItemResponse	Crée un ItemResponse pour cet élément de grille.
duplicate()	GridItem	Cré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()	String	Obtient 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()	Integer	Obtient l'identifiant unique de l'élément.
getIndex()	Integer	Obtient 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()	String	Obtient le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).
getType()	ItemType	Obtient le type de l'élément, représenté sous la forme d'un ItemType.
isRequired()	Boolean	Détermine si la personne interrogée doit répondre à la question.
setColumns(columns)	GridItem	Définit les colonnes de la grille en fonction d'un tableau de valeurs.
setHelpText(text)	GridItem	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).
setRequired(enabled)	GridItem	Indique si la personne interrogée doit répondre à la question.
setRows(rows)	GridItem	Définit les lignes de la grille en fonction d'un tableau de valeurs.
setTitle(title)	GridItem	Définit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).
setValidation(validation)	GridItem	Définit la validation des données pour cet élément de grille.

Documentation détaillée

clearValidation()

Supprime toute validation des 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 scopes 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

Nom	Type	Description
responses	String[]	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 scopes 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 ce GridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 répondants voient sous forme de libellés lorsqu'ils consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getHelpText()

Obtient 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 avec un ou plusieurs des scopes suivants :

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

---

getId()

Obtient 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 scopes suivants :

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

---

getIndex()

Obtient 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 avec un ou plusieurs des scopes 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 répondants voient sous forme de libellés lorsqu'ils consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getTitle()

Obtient le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un 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 avec un ou plusieurs des scopes suivants :

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

---

getType()

Obtient le type de l'élément, représenté sous la forme d'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 scopes 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 le répondant doit répondre à la question.

Autorisation

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

Nom	Type	Description
columns	String[]	un tableau de valeurs de colonne, que les répondants voient sous forme de libellés lorsqu'ils 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 scopes 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

Nom	Type	Description
text	String	le 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 scopes 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

Nom	Type	Description
enabled	Boolean	si 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 scopes 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

Nom	Type	Description
rows	String[]	Tableau de valeurs de ligne que les répondants voient sous forme de libellés lorsqu'ils 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 scopes 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

Nom	Type	Description
title	String	le nouveau titre ou texte d'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 scopes 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 null ou une instance GridValidation sur laquelle aucune fonction require n'a été appelée, toute validation antérieure est supprimée.

Paramètres

Nom	Type	Description
validation	GridValidation	GridValidation à 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 scopes suivants :

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