Class ListItem

ListItem

Question permettant à la personne interrogée de sélectionner une réponse dans une liste déroulante. Les éléments peuvent être accessible ou créé à partir d'un Form. 

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
    .setChoices([
        item.createChoice('Cats'),
        item.createChoice('Dogs')
    ]);

Méthodes

MéthodeType renvoyéBrève description
createChoice(value)ChoiceCrée un choix.
createChoice(value, isCorrect)ChoiceCrée un choix.
createChoice(value, navigationItem)ChoiceCrée un choix avec une option de navigation sur la page qui permet d'accéder directement à un élément de saut de page donné.
createChoice(value, navigationType)ChoiceCrée un choix avec une option de navigation sur les pages.
createResponse(response)ItemResponseCrée une valeur ItemResponse pour cet élément de liste.
duplicate()ListItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getChoices()Choice[]Récupère tous les choix associés à un élément.
getFeedbackForCorrect()QuizFeedbackAffiche les commentaires qui s'affichent lorsque les personnes interrogées répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedbackAffiche les commentaires qui s'affichent lorsque les personnes interrogées répondent incorrectement à une question.
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.
getPoints()IntegerAffiche le barème de notation d'un élément pouvant être noté.
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.
setChoiceValues(values)ListItemDéfinit les options disponibles pour un élément à partir d'un tableau de chaînes.
setChoices(choices)ListItemDéfinit un tableau de choix pour un élément.
setFeedbackForCorrect(feedback)ListItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)ListItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
setHelpText(text)ListItemDé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).
setPoints(points)ListItemDéfinit le nombre de points qu'un élément pouvant être noté.
setRequired(enabled)ListItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)ListItemDéfinit le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une propriété SectionHeaderItem).

Documentation détaillée

createChoice(value)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous la forme d'une étiquette lorsqu'ils consultent le formulaire.

Renvois

Choice : le nouveau choix

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

createChoice(value, isCorrect)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous la forme d'une étiquette lorsqu'ils consultent le formulaire.
isCorrectBooleansi le choix est une bonne réponse

Renvois

Choice : le nouveau choix

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

createChoice(value, navigationItem)

Crée un choix avec une option de navigation sur la page qui permet d'accéder directement à un élément de saut de page donné. Ce équivaut à createChoice(value, navigationType) avec navigationType défini sur FormApp.PageNavigationType.GO_TO_PAGE. Options qui utilisent la page la navigation ne peut pas être combinée dans le même élément avec des options qui n'utilisent pas la navigation sur les pages.

La navigation sur les pages se produit une fois que la personne interrogée a terminé une page contenant l'option, et seulement si la personne interrogée a choisi cette option. Si la personne interrogée a choisi plusieurs réponses instructions de navigation sur les pages, seule la dernière option de navigation a un effet. La navigation sur les pages n'a pas non plus d'effet sur la dernière page d'un formulaire.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous la forme d'une étiquette lorsqu'ils consultent le formulaire.
navigationItemPageBreakIteml'élément auquel accéder

Renvois

Choice : le nouveau choix

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

createChoice(value, navigationType)

Crée un choix avec une option de navigation sur les pages. Les choix qui utilisent la navigation sur les pages ne peuvent pas combinés dans le même élément avec des options qui n'utilisent pas la navigation sur les pages.

La navigation sur les pages se produit une fois que la personne interrogée a terminé une page contenant l'option, et seulement si la personne interrogée a choisi cette option. Si la personne interrogée a choisi plusieurs réponses instructions de navigation sur les pages, seule la dernière option de navigation a un effet. La navigation sur les pages n'a pas non plus d'effet sur la dernière page d'un formulaire.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous la forme d'une étiquette lorsqu'ils consultent le formulaire.
navigationTypePageNavigationTypele type de navigation du choix

Renvois

Choice : le nouveau choix

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(response)

Crée une valeur ItemResponse pour cet élément de liste. La fonction renvoie une exception si l'argument response ne correspond pas à un choix valide pour cet élément.

Paramètres

NomTypeDescription
responseStringune réponse valide pour cet élément de liste

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

ListItem : doublon de ListItem, 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

getChoices()

Récupère tous les choix associés à un élément.

Renvois

Choice[] : un tableau de choix

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

getFeedbackForCorrect()

Affiche les commentaires qui s'affichent lorsque les personnes interrogées répondent correctement à une question.

Renvois

QuizFeedback : commentaires, le cas échéant.

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

getFeedbackForIncorrect()

Affiche les commentaires qui s'affichent lorsque les personnes interrogées répondent incorrectement à une question.

Renvois

QuizFeedback : commentaires, le cas échéant.

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

getPoints()

Affiche le barème de notation d'un élément pouvant être noté.

Renvois

Integer : nombre de points qu'une question vaut.

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

setChoiceValues(values)

Définit les options disponibles pour un élément à partir d'un tableau de chaînes. Génère une exception si le tableau donné est vide. 

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Paramètres

NomTypeDescription
valuesString[]Le tableau de valeurs du choix, que les répondants voient sous forme d'étiquettes lorsqu'ils consultent le formulaire

Renvois

ListItem : ListItem, 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

setChoices(choices)

Définit un tableau de choix pour un élément. La fonction renvoie une exception si le tableau donné est vide ou contient un élément null. 

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
item.setChoices([
    item.createChoice('Cats'),
    item.createChoice('Dogs')
]);

Paramètres

NomTypeDescription
choicesChoice[]un tableau de choix

Renvois

ListItem : ListItem, pour le chaînage

Génère

Error : si le tableau donné est null, vide ou contient un élément null

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

setFeedbackForCorrect(feedback)

Définit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question. 

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false)]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText("Dogs rule, cats drool.").build());

Paramètres

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires. Une valeur nulle efface les commentaires.

Renvois

ListItem : ListItem, 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

setFeedbackForIncorrect(feedback)

Définit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.

Paramètres

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires

Renvois

ListItem : ListItem, 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

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

ListItem : ListItem, 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

setPoints(points)

Définit le nombre de points qu'un élément pouvant être noté. La valeur par défaut pour les nouveaux éléments est 0.

Paramètres

NomTypeDescription
pointsIntegerle nombre de points qu'un élément de question vaut.

Renvois

ListItem : ListItem, 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

ListItem : é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

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

ListItem : ListItem, 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