Class CheckboxItem

Element „Kästchen“

Ein Frageelement, mit dem der Befragte ein oder mehrere Kästchen sowie ein optionales Feld „Sonstiges“ auswählen kann. Auf Elemente kann über eine Form zugegriffen oder sie können über eine Form erstellt werden. Bei Verwendung in einem Quiz werden diese Elemente automatisch bewertet. 

// 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 Kontrollkästchen.
createChoice(value)ChoiceErstellt eine neue Auswahl.
createChoice(value, isCorrect)ChoiceErstellt eine neue Auswahl.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse für dieses Kontrollkästchen.
duplicate()CheckboxItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getChoices()Choice[]Ruft alle Optionen für ein Element ab.
getFeedbackForCorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedback|nullGibt 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 Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
hasOtherOption()BooleanGibt an, ob das Element die Option „Sonstiges“ hat.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setChoiceValues(values)CheckboxItemLegt die Auswahlmöglichkeiten für ein Element aus einem String-Array fest.
setChoices(choices)CheckboxItemLegt ein Array mit Auswahlmöglichkeiten für ein Element fest.
setFeedbackForCorrect(feedback)CheckboxItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)CheckboxItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)CheckboxItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)CheckboxItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)CheckboxItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)CheckboxItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setValidation(validation)CheckboxItemLegt die Datenvalidierung für dieses Kontrollkästchenelement fest.
showOtherOption(enabled)CheckboxItemLegt fest, ob das Element die Option „Sonstiges“ hat.

Detaillierte Dokumentation

clearValidation()

Entfernt die Datenvalidierung für dieses Kontrollkästchen.

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 als Label angezeigt wird, wenn sie das Formular aufrufen

Rückflug

Choice – die neue Option

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 als Label angezeigt wird, wenn sie das Formular aufrufen
isCorrectBooleanob die Auswahl eine richtige Antwort ist

Rückflug

Choice – die neue Option

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

createResponse(responses)

Erstellt ein neues ItemResponse für dieses Kontrollkästchen. 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[]ein Array mit gültigen Antworten für diesen Multiple-Choice-Artikel

Rückflug

ItemResponse – die Antwort auf das Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 – ein Duplikat dieses CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getChoices()

Ruft alle Optionen für ein Element ab.

Rückflug

Choice[]: ein Array mit Auswahlmöglichkeiten

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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|null – das Feedback, sofern vorhanden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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|null – das Feedback, sofern vorhanden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).

Rückflug

String – der Hilfetext oder die Beschreibung des Artikels

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getId()

Ruft die eindeutige Kennung des Elements ab.

Rückflug

Integer: die ID des Artikels

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 Elements

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getPoints()

Gibt den Punktwert eines bewertbaren Elements zurück.

Rückflug

Integer: Die Anzahl der Punkte, die eine Frage wert ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getTitle()

Ruft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

Rückflug

String – der Titel oder Headertext des Elements

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getType()

Ruft den Typ des Elements als ItemType ab.

Rückflug

ItemType: Der Typ des Artikels.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

hasOtherOption()

Gibt an, ob das Element die Option „Sonstiges“ hat.

Rückflug

Boolean – true, wenn das Element die Option „Sonstiges“ hat; false, wenn nicht

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

isRequired()

Gibt an, ob der Befragte die Frage beantworten muss.

Rückflug

Boolean – ob der Befragte die Frage beantworten muss

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setChoiceValues(values)

Legt die Auswahlmöglichkeiten für ein Element 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[]Das Array der Auswahlwerte, die den Teilnehmern als Labels angezeigt werden, wenn sie das Formular aufrufen

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setChoices(choices)

Legt ein Array mit Auswahlmöglichkeiten für ein Element 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 – diese CheckboxItem zur Verkettung

Löst

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFeedbackForCorrect(feedback)

Legt das Feedback fest, das 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 – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFeedbackForIncorrect(feedback)

Legt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.

Parameter

NameTypBeschreibung
feedbackQuizFeedbackdas neue Feedback

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setHelpText(text)

Legt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).

Parameter

NameTypBeschreibung
textStringder neue Hilfetext

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setPoints(points)

Legt die Anzahl der Punkte fest, die ein bewertbares Element wert ist. Der Standardwert für neue Elemente ist 0.

Parameter

NameTypBeschreibung
pointsIntegerdie Anzahl der Punkte, die eine Frage wert ist

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setRequired(enabled)

Legt fest, ob der Befragte die Frage beantworten muss.

Parameter

NameTypBeschreibung
enabledBooleanob der Befragte die Frage beantworten muss

Rückflug

CheckboxItem – das aktuelle Element (zum Verketten)

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setTitle(title)

Legt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

Parameter

NameTypBeschreibung
titleStringden neuen Titel oder Headertext

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setValidation(validation)

Legt die Datenvalidierung für dieses Kontrollkästchenelement fest. Wenn Sie „null“ oder eine Validierung ohne aufgerufene „require“-Funktionen übergeben, wird die vorherige Validierung entfernt.

Parameter

NameTypBeschreibung
validationCheckboxValidationEine CheckboxValidation, die auf dieses Element angewendet werden soll.

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

showOtherOption(enabled)

Legt fest, ob das Element die Option „Sonstiges“ hat. Der Standardwert für ein neues CheckboxItem oder MultipleChoiceItem ist false.

Parameter

NameTypBeschreibung
enabledBooleantrue, wenn der Artikel die Option „Sonstiges“ hat, false, wenn nicht

Rückflug

CheckboxItem – diese CheckboxItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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