Class CheckboxItem

CheckboxItem

Question permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'un champ "Autre" facultatif. Vous pouvez accéder aux éléments ou en créer depuis une Form. Lorsqu'ils sont utilisés dans un quiz, ces éléments sont notés automatiquement.

// Open a form by ID and add a new checkbox item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?')
    .setChoices([
          item.createChoice('Ketchup'),
          item.createChoice('Mustard'),
          item.createChoice('Relish')
    ])
    .showOtherOption(true);

Méthodes

MéthodeType renvoyéBrève description
clearValidation()CheckboxItemSupprime toute validation des données pour cet élément de case à cocher.
createChoice(value)ChoiceCrée un choix.
createChoice(value, isCorrect)ChoiceCrée un choix.
createResponse(responses)ItemResponseCrée un ItemResponse pour cet élément de case à cocher.
duplicate()CheckboxItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getChoices()Choice[]Récupère tous les choix pour un élément.
getFeedbackForCorrect()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à 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'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie 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 de l'élément, représenté par ItemType.
hasOtherOption()BooleanDétermine si l'élément comporte une option "autre".
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setChoiceValues(values)CheckboxItemDéfinit les choix pour un élément à partir d'un tableau de chaînes.
setChoices(choices)CheckboxItemDéfinit un tableau d'options pour un article.
setFeedbackForCorrect(feedback)CheckboxItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)CheckboxItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
setHelpText(text)CheckboxItemDé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)CheckboxItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)CheckboxItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)CheckboxItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setValidation(validation)CheckboxItemDéfinit la validation des données pour cet élément de case à cocher.
showOtherOption(enabled)CheckboxItemDétermine si l'élément comporte une option "Autre".

Documentation détaillée

clearValidation()

Supprime toute validation des données pour cet élément de case à cocher.

Renvois

CheckboxItem : cette CheckboxItem, 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

createChoice(value)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les personnes interrogées voient comme une étiquette lorsqu'elles consultent le formulaire

Renvois

Choice : le nouveau choix

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

createChoice(value, isCorrect)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les personnes interrogées voient comme une étiquette lorsqu'elles consultent le formulaire
isCorrectBooleansi c'est une bonne réponse

Renvois

Choice : le nouveau choix

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 case à cocher. L'argument responses est un tableau String[] contenant les valeurs à vérifier. La fonction renvoie une exception si une valeur ne correspond pas à un choix valide pour cet élément, sauf si showOtherOption(enabled) est défini sur true.

Paramètres

NomTypeDescription
responsesString[]un tableau de réponses valides pour cet élément à choix multiples

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

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

getChoices()

Récupère tous les choix pour un élément.

Renvois

Choice[] : tableau de choix

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

getFeedbackForCorrect()

Renvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent correctement à une question.

Renvois

QuizFeedback : commentaires, le cas échéant.

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

getFeedbackForIncorrect()

Renvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.

Renvois

QuizFeedback : commentaires, le cas échéant.

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

getPoints()

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

Renvois

Integer : nombre de points attribués à une 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

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

hasOtherOption()

Détermine si l'élément comporte une option "autre".

Renvois

Boolean : true si l'élément dispose d'une option "autre" ; false dans le cas contraire

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

setChoiceValues(values)

Définit les choix 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[]Tableau des valeurs des choix que les répondants voient en tant que libellés lorsqu'ils consultent le formulaire

Renvois

CheckboxItem : cette CheckboxItem, 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

setChoices(choices)

Définit un tableau d'options pour un article. 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 ensemble de choix

Renvois

CheckboxItem : cette CheckboxItem, 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 associée à 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
feedbackQuizFeedbackle nouveau feedback. Une valeur nulle effacera les commentaires.

Renvois

CheckboxItem : cette CheckboxItem, 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

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

CheckboxItem : cette CheckboxItem, 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

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

CheckboxItem : cette CheckboxItem, 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

setPoints(points)

Définit le nombre de points attribués à un élément pouvant être noté. La valeur par défaut des nouveaux éléments est 0.

Paramètres

NomTypeDescription
pointsIntegerle nombre de points d'un élément de la question ;

Renvois

CheckboxItem : cette CheckboxItem, 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

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

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

CheckboxItem : cette CheckboxItem, 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 case à cocher. 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
validationCheckboxValidationune case à cocher "CheckboxValidation" pour l'appliquer à cet élément.

Renvois

CheckboxItem : cette CheckboxItem, 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

showOtherOption(enabled)

Détermine si l'élément comporte une option "Autre". La valeur par défaut d'un nouveau CheckboxItem ou MultipleChoiceItem est false.

Paramètres

NomTypeDescription
enabledBooleantrue si une option "Autre" est disponible pour l'élément ; false dans le cas contraire

Renvois

CheckboxItem : cette CheckboxItem, 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