Class CheckboxItem

KästchenElement

Ein Frageelement, bei dem die Befragten ein oder mehrere Kästchen ankreuzen können, sowie ein optionales Feld für „Sonstiges“. Auf Elemente kann über ein Form zugegriffen oder sie können dort erstellt werden. Wenn diese Elemente in einem Quiz verwendet werden, werden sie automatisch benotet. 

// 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);

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()CheckboxItemEntfernt die Datenvalidierung für dieses Kästchenelement.
createChoice(value)ChoiceErstellt eine neue Auswahl.
createChoice(value, isCorrect)ChoiceErstellt eine neue Auswahl.
createResponse(responses)ItemResponseErstellt eine neue ItemResponse für dieses Kästchenelement.
duplicate()CheckboxItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getChoices()Choice[]Hiermit werden alle Optionen für einen Artikel abgerufen.
getFeedbackForCorrect()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerDie eindeutige Kennung des Artikels.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benoteten Elements zurück.
getTitle()StringDer Titel des Artikels (im Fall einer SectionHeaderItem auch als Headertext bezeichnet).
getType()ItemTypeDer Typ des Artikels, dargestellt als ItemType.
hasOtherOption()BooleanGibt an, ob für das Element die Option „Sonstiges“ verfügbar ist.
isRequired()BooleanBestimmt, ob die Befragten die Frage beantworten müssen.
setChoiceValues(values)CheckboxItemLegt die Auswahlmöglichkeiten für einen Artikel aus einem String-Array fest.
setChoices(choices)CheckboxItemLegt eine Reihe von Auswahlmöglichkeiten für einen Artikel fest.
setFeedbackForCorrect(feedback)CheckboxItemHier legen Sie fest, welches Feedback den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)CheckboxItemHier legen Sie fest, welches Feedback den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)CheckboxItemHiermit wird der Hilfetext des Elements festgelegt (bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems auch als Beschreibungstext bezeichnet).
setPoints(points)CheckboxItemHiermit wird die Anzahl der Punkte festgelegt, die ein benotetes Element wert ist.
setRequired(enabled)CheckboxItemHier legen Sie fest, ob die Befragten die Frage beantworten müssen.
setTitle(title)CheckboxItemHiermit wird der Titel des Artikels festgelegt (im Fall eines SectionHeaderItem auch als Headertext bezeichnet).
setValidation(validation)CheckboxItemHier legen Sie die Datenvalidierung für dieses Kästchenelement fest.
showOtherOption(enabled)CheckboxItemGibt an, ob für das Element die Option „Sonstiges“ verfügbar ist.

Detaillierte Dokumentation

clearValidation()

Entfernt die Datenvalidierung für dieses Kästchenelement.

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createChoice(value)

Erstellt eine neue Auswahl.

Parameter

NameTypBeschreibung
valueStringDer Wert der Auswahl, der den Teilnehmern im Formular als Label angezeigt wird

Rückflug

Choice – die neue Wahl

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createChoice(value, isCorrect)

Erstellt eine neue Auswahl.

Parameter

NameTypBeschreibung
valueStringDer Wert der Auswahl, der den Teilnehmern im Formular als Label angezeigt wird
isCorrectBooleanob die Auswahl eine richtige Antwort ist

Rückflug

Choice – die neue Wahl

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createResponse(responses)

Erstellt eine neue ItemResponse für dieses Kästchenelement. Das Argument responses ist ein String[]-Array mit Werten, die geprüft werden müssen. Löst eine Ausnahme aus, wenn ein Wert nicht mit einer gültigen Auswahl für dieses Element übereinstimmt, es sei denn, showOtherOption(enabled) ist auf true festgelegt.

Parameter

NameTypBeschreibung
responsesString[]eine Reihe gültiger Antworten für dieses Multiple-Choice-Element

Rückflug

ItemResponse – die Artikelantwort

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

duplicate()

Erstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.

Rückflug

CheckboxItem – Duplikat dieses CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getChoices()

Hiermit werden alle Optionen für einen Artikel abgerufen.

Rückflug

Choice[] – eine Auswahl

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFeedbackForCorrect()

Gibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.

Rückflug

QuizFeedback: gegebenenfalls das Feedback

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFeedbackForIncorrect()

Gibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.

Rückflug

QuizFeedback: gegebenenfalls das Feedback

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getHelpText()

Ruft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).

Rückflug

String: Hilfetext oder Beschreibung des Artikels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getId()

Die eindeutige Kennung des Artikels.

Rückflug

Integer: die Artikel-ID

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getIndex()

Ruft den Index des Elements unter allen Elementen im Formular ab.

Rückflug

Integer: der Index des Artikels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getPoints()

Gibt die Punktzahl eines benoteten Elements zurück.

Rückflug

Integer: Die Punktzahl, die eine Frage wert ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getTitle()

Der Titel des Artikels (im Fall einer SectionHeaderItem auch als Headertext bezeichnet).

Rückflug

String – Titel oder Headertext des Artikels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getType()

Der Typ des Artikels, dargestellt als ItemType.

Rückflug

ItemType: Der Typ des Artikels.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hasOtherOption()

Gibt an, ob für das Element die Option „Sonstiges“ verfügbar ist.

Rückflug

Boolean – true, wenn für den Artikel die Option „Sonstiges“ verfügbar ist; false, wenn nicht

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isRequired()

Bestimmt, ob die Befragten die Frage beantworten müssen.

Rückflug

Boolean – ob die Befragten die Frage beantworten müssen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setChoiceValues(values)

Legt die Auswahlmöglichkeiten für einen Artikel aus einem String-Array fest. Löst eine Ausnahme aus, wenn das angegebene Array leer ist. 

// 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']);

Parameter

NameTypBeschreibung
valuesString[]die Auswahlwerte, die den Teilnehmern im Formular als Labels angezeigt werden

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setChoices(choices)

Legt eine Reihe von Auswahlmöglichkeiten für einen Artikel fest. Löst eine Ausnahme aus, wenn das angegebene Array leer ist oder ein null-Element enthält. 

// 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')]);

Parameter

NameTypBeschreibung
choicesChoice[]eine Reihe von Optionen

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Löst aus

Error – wenn das angegebene Array null ist, leer ist oder ein null-Element enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFeedbackForCorrect(feedback)

Hier legen Sie fest, welches Feedback den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten. 

// 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(),
);

Parameter

NameTypBeschreibung
feedbackQuizFeedbackdas neue Feedback. Bei einem Nullwert wird das Feedback gelöscht.

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFeedbackForIncorrect(feedback)

Hier legen Sie fest, welches Feedback den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.

Parameter

NameTypBeschreibung
feedbackQuizFeedbackdas neue Feedback

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setHelpText(text)

Hiermit wird der Hilfetext des Elements festgelegt (bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems auch als Beschreibungstext bezeichnet).

Parameter

NameTypBeschreibung
textStringden neuen Hilfetext

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setPoints(points)

Hiermit wird die Anzahl der Punkte festgelegt, die ein benotetes Element wert ist. Der Standardwert für neue Elemente ist 0.

Parameter

NameTypBeschreibung
pointsIntegerdie Anzahl der Punkte, die ein Frageelement wert ist

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRequired(enabled)

Hier legen Sie fest, ob die Befragten die Frage beantworten müssen.

Parameter

NameTypBeschreibung
enabledBooleanob die Befragten die Frage beantworten müssen

Rückflug

CheckboxItem – das aktuelle Element (für die Verkettung)

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setTitle(title)

Hiermit wird der Titel des Artikels festgelegt (im Fall eines SectionHeaderItem auch als Headertext bezeichnet).

Parameter

NameTypBeschreibung
titleStringden neuen Titel oder Headertext

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setValidation(validation)

Hier legen Sie die Datenvalidierung für dieses Kästchenelement fest. Wenn Sie „null“ oder eine Validierung ohne Aufrufe von „require“-Funktionen übergeben, wird jede vorherige Validierung entfernt.

Parameter

NameTypBeschreibung
validationCheckboxValidationeine CheckboxValidation, die auf diesen Artikel angewendet werden soll.

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

showOtherOption(enabled)

Gibt an, ob für das Element die Option „Sonstiges“ verfügbar ist. Der Standardwert für eine neue CheckboxItem oder MultipleChoiceItem ist false.

Parameter

NameTypBeschreibung
enabledBooleantrue, wenn für das Element die Option „Sonstiges“ verfügbar ist, false andernfalls

Rückflug

CheckboxItem – dieses CheckboxItem für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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