Class GridItem

GridItem

Question, présentée sous la forme d'une grille de colonnes et de lignes, qui permet à la personne interrogée de sélectionner un choix par ligne à partir d'une séquence de cases d'option. Les éléments sont accessibles ou créés à partir d'un Form.

// Open a form by ID and add a new grid item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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 des 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'article.
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 de l'élément, représenté par ItemType.
isRequired()BooleanDétermine 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)GridItemDétermine 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'une SectionHeaderItem).
setValidation(validation)GridItemDé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 l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 de lignes dans la grille. Un élément null pour une question de grille non obligatoire indique l'absence de réponse pour cette ligne. La fonction renvoie 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 la grille

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 : doublon de ce GridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 répondants voient comme des libellés lorsqu'ils consultent le formulaire

Autorisation

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

Renvois

Integer : ID de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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 répondants voient comme des libellés lorsqu'ils consultent le formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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 ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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 le tableau donné est vide.

Paramètres

NomTypeDescription
columnsString[]un tableau de valeurs de colonnes que les répondants voient comme des libellés lorsqu'ils consultent le formulaire ;

Renvois

GridItem : 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 associée à 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 : cette GridItem, pour le chaînage

Autorisation

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

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 répondants voient comme des libellés lorsqu'ils consultent le formulaire

Renvois

GridItem : 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 associée à 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 SectionHeaderItem).

Paramètres

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

Renvois

GridItem : cette GridItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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. La transmission d'une valeur nulle ou d'une validation sans aucune fonction d'exigence appelée supprime toute validation antérieure.

Paramètres

NomTypeDescription
validationGridValidationune GridValidation à appliquer à cet élément.

Renvois

GridItem : cette GridItem, pour le chaînage

Autorisation

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

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