Cette page a été traduite par l'API Cloud Translation.

Class CheckboxItem

Question permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'une "other" (facultatif) . Les éléments sont accessibles et accessibles depuis un Form. Lorsqu'elle est utilisée 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éthode	Type renvoyé	Brève description
`clearValidation()`	`CheckboxItem`	Supprime toute validation des données pour cet élément de la case à cocher.
`createChoice(value)`	`Choice`	Crée un choix.
`createChoice(value, isCorrect)`	`Choice`	Crée un choix.
`createResponse(responses)`	`ItemResponse`	Crée un `ItemResponse` pour cet élément de la case à cocher.
`duplicate()`	`CheckboxItem`	Cré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()`	`QuizFeedback`	Affiche les commentaires qui s'affichent lorsque les personnes interrogées répondent correctement à une question.
`getFeedbackForIncorrect()`	`QuizFeedback`	Affiche les commentaires qui s'affichent lorsque les personnes interrogées répondent incorrectement à une question.
`getHelpText()`	`String`	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`).
`getId()`	`Integer`	Récupère l'identifiant unique de l'élément.
`getIndex()`	`Integer`	Récupère l'index de l'élément parmi tous les éléments du formulaire.
`getPoints()`	`Integer`	Affiche le barème de notation d'un élément pouvant être noté.
`getTitle()`	`String`	Récupère le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une `SectionHeaderItem`).
`getType()`	`ItemType`	Récupère le type d'élément, représenté par `ItemType`.
`hasOtherOption()`	`Boolean`	Détermine si l'élément a un "autre" .
`isRequired()`	`Boolean`	Détermine si la personne interrogée doit répondre à la question.
`setChoiceValues(values)`	`CheckboxItem`	Définit les options disponibles pour un élément à partir d'un tableau de chaînes.
`setChoices(choices)`	`CheckboxItem`	Définit un tableau de choix pour un élément.
`setFeedbackForCorrect(feedback)`	`CheckboxItem`	Définit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question.
`setFeedbackForIncorrect(feedback)`	`CheckboxItem`	Définit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
`setHelpText(text)`	`CheckboxItem`	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`).
`setPoints(points)`	`CheckboxItem`	Définit le nombre de points qu'un élément pouvant être noté.
`setRequired(enabled)`	`CheckboxItem`	Détermine si la personne interrogée doit répondre à la question.
`setTitle(title)`	`CheckboxItem`	Définit le titre de l'élément (parfois appelé "texte d'en-tête" dans le cas d'une propriété `SectionHeaderItem`).
`setValidation(validation)`	`CheckboxItem`	Définit la validation des données pour cet élément de la case à cocher.
`showOtherOption(enabled)`	`CheckboxItem`	Détermine si l'élément possède une "Autre" .

Documentation détaillée

`clearValidation()`

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

Renvois

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

`createChoice(value)`

Crée un choix.

Paramètres

Nom	Type	Description
`value`	`String`	la 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

Nom	Type	Description
`value`	`String`	la valeur du choix, que les répondants voient sous la forme d'une étiquette lorsqu'ils consultent le formulaire.
`isCorrect`	`Boolean`	si 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

`createResponse(responses)`

Crée un ItemResponse pour cet élément de la case à cocher. L'argument responses est une Tableau String[] contenant les valeurs à vérifier. Une exception est générée, le cas échéant. valeur ne correspond pas à un choix valide pour cet élément, sauf si showOtherOption(enabled) est défini sur true.

Paramètres

Nom	Type	Description
`responses`	`String[]`	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 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

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

`hasOtherOption()`

Détermine si l'élément possède un "autre" .

Renvois

Boolean : true si l'élément possède la mention "autre" cette option ; false si ce n'est pas le cas

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

Nom	Type	Description
`values`	`String[]`	Le tableau de valeurs du choix, que les répondants voient sous forme d'étiquettes lorsqu'ils consultent le formulaire

Renvois

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

Nom	Type	Description
`choices`	`Choice[]`	un tableau 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 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

Nom	Type	Description
`feedback`	`QuizFeedback`	les nouveaux commentaires. Une valeur nulle efface les commentaires.

Renvois

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

Nom	Type	Description
`feedback`	`QuizFeedback`	les nouveaux commentaires

Renvois

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

Nom	Type	Description
`text`	`String`	le nouveau texte d'aide

Renvois

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

Nom	Type	Description
`points`	`Integer`	le 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 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

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

Nom	Type	Description
`title`	`String`	le nouveau titre ou texte d'en-tête

Renvois

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

`setValidation(validation)`

Définit la validation des données pour cet élément de la case à cocher. La transmission d'une valeur nulle ou d'une validation sans aucune nécessiter des fonctions appelées supprimera toute validation antérieure.

Paramètres

Nom	Type	Description
`validation`	`CheckboxValidation`	une case à cocher Validation à appliquer à cet élément.

Renvois

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

`showOtherOption(enabled)`

Détermine si l'élément est associé à une mention "autre" . La valeur par défaut pour un nouveau CheckboxItem ou "MultipleChoiceItem" est "false".

Paramètres

Nom	Type	Description
`enabled`	`Boolean`	`true` si l'élément a la valeur "autre" cette option ; `false` si ce n'est pas le cas

Renvois

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