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

Class CheckboxItem

Élément de question permettant au répondant de cocher une ou plusieurs cases, ainsi qu'un champ "Autre" facultatif. Vous pouvez accéder aux éléments ou en créer à 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éthode	Type renvoyé	Brève description
`clearValidation()`	`CheckboxItem`	Supprime toute validation de données pour cet élément de 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 case à cocher.
`duplicate()`	`CheckboxItem`	Crée une copie de cet élément et l'ajoute à la fin du formulaire.
`getChoices()`	`Choice[]`	Récupère toutes les options d'un élément.
`getFeedbackForCorrect()`	`QuizFeedback`	Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent correctement à une question.
`getFeedbackForIncorrect()`	`QuizFeedback`	Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent de manière incorrecte à 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'indice de l'élément parmi tous les éléments du formulaire.
`getPoints()`	`Integer`	Renvoie la valeur en points d'un élément évaluable.
`getTitle()`	`String`	Récupère le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un `SectionHeaderItem`).
`getType()`	`ItemType`	Récupère le type de l'élément, représenté par un `ItemType`.
`hasOtherOption()`	`Boolean`	Indique si l'élément comporte une option "Autre".
`isRequired()`	`Boolean`	Indique si la personne interrogée doit répondre à la question.
`setChoiceValues(values)`	`CheckboxItem`	Définit les choix pour un élément à partir d'un tableau de chaînes.
`setChoices(choices)`	`CheckboxItem`	Définit un tableau d'options pour un élément.
`setFeedbackForCorrect(feedback)`	`CheckboxItem`	Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent correctement à une question.
`setFeedbackForIncorrect(feedback)`	`CheckboxItem`	Définit les commentaires à afficher 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 d'un élément évaluable.
`setRequired(enabled)`	`CheckboxItem`	Indique 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'un `SectionHeaderItem`).
`setValidation(validation)`	`CheckboxItem`	Définit la validation des données pour cet élément de case à cocher.
`showOtherOption(enabled)`	`CheckboxItem`	Indique si l'élément comporte une option "Autre".

Documentation détaillée

`clearValidation()`

Supprime toute validation de 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 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, qui s'affiche sous forme de libellé pour les personnes interrogées lorsqu'elles 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 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, qui s'affiche sous forme de libellé pour les personnes interrogées lorsqu'elles consultent le formulaire
`isCorrect`	`Boolean`	si la réponse est correcte ;

Renvois

Choice : le nouveau choix

Autorisation

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

Nom	Type	Description
`responses`	`String[]`	un tableau de 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 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 : double de cet élément CheckboxItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 toutes les options d'un élément.

Renvois

Choice[] : tableau d'options

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 s'affichent auprès des 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 avec 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 s'affichent auprès des 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 avec 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 de description de l'élément

Autorisation

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'indice 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 champs d'application suivants:

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

`getPoints()`

Renvoie la valeur en points d'un élément évaluable.

Renvois

Integer : nombre de points qu'une question rapporte.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'un SectionHeaderItem).

Renvois

String : titre ou texte de l'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 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 champs d'application suivants:

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

`hasOtherOption()`

Indique 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 champs d'application suivants:

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

`isRequired()`

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

Paramètres

Nom	Type	Description
`values`	`String[]`	le tableau des valeurs de choix, qui s'affichent sous forme de libellés pour les personnes interrogées 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 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 é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

Nom	Type	Description
`choices`	`Choice[]`	un tableau d'options

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 champs d'application suivants:

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

`setFeedbackForCorrect(feedback)`

Définit les commentaires à afficher aux personnes interrogées lorsqu'elles 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

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 avec 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 à afficher 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 avec 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 avec 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 d'un élément évaluable. 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 avec un ou plusieurs des champs d'application 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

Nom	Type	Description
`enabled`	`Boolean`	si 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 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'un SectionHeaderItem).

Paramètres

Nom	Type	Description
`title`	`String`	le nouveau titre ou le nouveau texte de l'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 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. Si vous transmettez la valeur nulle ou une validation sans aucune fonction requise appelée, toute validation précédente sera supprimée.

Paramètres

Nom	Type	Description
`validation`	`CheckboxValidation`	une validation de case à cocher à 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 champs d'application 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 pour un nouvel élément CheckboxItem ou MultipleChoiceItem est false.

Paramètres

Nom	Type	Description
`enabled`	`Boolean`	`true` 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 champs d'application suivants:

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