Class CheckboxItem

Élément case à cocher

Élément de question permettant au répondant de sélectionner une ou plusieurs cases à cocher, ainsi qu'un champ "Autre" facultatif. Les éléments sont accessibles ou peuvent être créés à partir d'un 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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedback|nullRenvoie les commentaires affichés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
getHelpText()StringObtient 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()IntegerObtient l'identifiant unique de l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie la valeur en points d'un élément pouvant être noté.
getTitle()StringObtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).
getType()ItemTypeObtient le type de l'élément, représenté sous la forme d'un 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 de choix pour un élément.
setFeedbackForCorrect(feedback)CheckboxItemDéfinit les commentaires à afficher aux participants lorsqu'ils répondent correctement à une question.
setFeedbackForIncorrect(feedback)CheckboxItemDéfinit les commentaires à afficher 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 qu'un devoir peut rapporter.
setRequired(enabled)CheckboxItemIndique 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'un SectionHeaderItem).
setValidation(validation)CheckboxItemDéfinit la validation des données pour cet élément de case à cocher.
showOtherOption(enabled)CheckboxItemIndique 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 : CheckboxItem, 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

createChoice(value)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous forme de libellé lorsqu'ils consultent le formulaire.

Renvois

Choice : le nouveau choix

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

createChoice(value, isCorrect)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous forme de libellé 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 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 case à cocher. L'argument responses est un tableau String[] contenant les valeurs à vérifier. Génère 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[]Tableau des réponses valides pour cet élément à choix multiples

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

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

getChoices()

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

Renvois

Choice[] : un éventail de choix

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

getFeedbackForCorrect()

Renvoie les commentaires affichés aux participants lorsqu'ils répondent correctement à une question.

Renvois

QuizFeedback|null : commentaire, le cas échéant.

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

getFeedbackForIncorrect()

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

Renvois

QuizFeedback|null : commentaire, le cas échéant.

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

getPoints()

Renvoie la valeur en points 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 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

hasOtherOption()

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

Renvois

Boolean — true si l'élément comporte une option "Autre", false sinon

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

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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Paramètres

NomTypeDescription
valuesString[]Tableau des valeurs de choix que les personnes interrogées voient sous forme de libellés lorsqu'elles consultent le formulaire

Renvois

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

setChoices(choices)

Définit un tableau de choix pour un élément. Génère 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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

Paramètres

NomTypeDescription
choicesChoice[]un large éventail de choix

Renvois

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

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

setFeedbackForCorrect(feedback)

Définit les commentaires à afficher aux participants lorsqu'ils répondent correctement à une question. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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 le commentaire.

Renvois

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

setFeedbackForIncorrect(feedback)

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

Paramètres

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires

Renvois

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

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

setPoints(points)

Définit le nombre de points qu'un devoir peut rapporter. 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

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

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

Renvois

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

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 d'en-tête.

Renvois

CheckboxItem : CheckboxItem, 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 case à cocher. Si vous transmettez une valeur nulle ou une validation sans aucune fonction require appelée, toute validation précédente sera supprimée.

Paramètres

NomTypeDescription
validationCheckboxValidationune CheckboxValidation à appliquer à cet élément.

Renvois

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

showOtherOption(enabled)

Indique 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 l'élément comporte une option "Autre", false dans le cas contraire

Renvois

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