Ein generisches Formularelement mit Eigenschaften, die alle Elemente gemeinsam haben, z. B. Titel und Hilfetext.
Elemente können über Form
aufgerufen oder erstellt werden.
Wenn Sie mit typspezifischen Attributen arbeiten möchten, prüfen Sie mit getType()
den ItemType
des Elements und wandeln Sie das Element dann mit einer Methode wie asCheckboxItem()
in die entsprechende Klasse um.
// Create a new form and add a text item. var form = FormApp.create('Form Name'); form.addTextItem(); // Access the text item as a generic item. var items = form.getItems(); var item = items[0]; // Cast the generic item to the text-item class. if (item.getType() == 'TEXT') { var textItem = item.asTextItem(); textItem.setRequired(false); }
Klassen implementieren
Name | Kurzbeschreibung |
---|
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
asCheckboxGridItem() | CheckboxGridItem | Gibt das Element als Kästchenrasterelement zurück |
asCheckboxItem() | CheckboxItem | Gibt das Element als Kästchen zurück. |
asDateItem() | DateItem | Gibt das Element als Datumselement zurück |
asDateTimeItem() | DateTimeItem | Gibt das Element als Datum/Uhrzeit-Element zurück. |
asDurationItem() | DurationItem | Gibt das Element als Dauerelement zurück |
asGridItem() | GridItem | Gibt das Element als Rasterelement zurück |
asImageItem() | ImageItem | Gibt das Element als Bildelement zurück |
asListItem() | ListItem | Gibt das Element als Listenelement zurück |
asMultipleChoiceItem() | MultipleChoiceItem | Gibt das Element als Multiple-Choice-Element zurück |
asPageBreakItem() | PageBreakItem | Gibt das Element als Seitenumbruchelement zurück |
asParagraphTextItem() | ParagraphTextItem | Gibt das Element als Absatz-Textelement zurück |
asScaleItem() | ScaleItem | Gibt das Element als Skalenelement zurück. |
asSectionHeaderItem() | SectionHeaderItem | Gibt das Element als Element mit Abschnittsüberschrift zurück |
asTextItem() | TextItem | Gibt das Element als Textelement zurück |
asTimeItem() | TimeItem | Gibt das Element als Zeitelement zurück |
asVideoItem() | VideoItem | Gibt das Element als Videoelement zurück |
duplicate() | Item | Erstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an. |
getHelpText() | String | den Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems , PageBreakItems und SectionHeaderItems bezeichnet) |
getId() | Integer | Ruft die eindeutige ID des Artikels ab. |
getIndex() | Integer | Ruft den Index des Elements aus allen Elementen im Formular ab. |
getTitle() | String | Ruft den Titel des Elements ab (im Fall eines SectionHeaderItem -Elements manchmal auch als Überschrifttext bezeichnet). |
getType() | ItemType | Ruft den Typ des Elements ab, dargestellt als ItemType . |
setHelpText(text) | Item | Legt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems , PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet. |
setTitle(title) | Item | Legt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet. |
Detaillierte Dokumentation
asCheckboxGridItem()
Gibt das Element als Kästchenrasterelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits CHECKBOX_GRID
war.
Return
CheckboxGridItem
: Rasterelement für das Kästchen
Löst aus
Error
: wenn das Element kein Kästchenraster-Element ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asCheckboxItem()
Gibt das Element als Kästchen zurück. Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits CHECKBOX
war.
Return
CheckboxItem
: das Kästchenelement
Löst aus
Error
: wenn das Element kein Kästchenelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDateItem()
Gibt das Element als Datumselement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits DATE
war.
Return
DateItem
: das Datumselement
Löst aus
Error
: Wenn das Element kein Datumselement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDateTimeItem()
Gibt das Element als Datum/Uhrzeit-Element zurück. Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits DATETIME
war.
Return
DateTimeItem
: Datum/Uhrzeit-Element
Löst aus
Error
: Wenn das Element kein Datum/Uhrzeit ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDurationItem()
Gibt das Element als Dauerelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits DURATION
war.
Return
DurationItem
– das Element für die Dauer
Löst aus
Error
: wenn das Element kein Dauerelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asGridItem()
Gibt das Element als Rasterelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits GRID
war.
Return
GridItem
: das Rasterelement
Löst aus
Error
: wenn das Element kein Rasterelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asImageItem()
asListItem()
Gibt das Element als Listenelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits LIST
war.
Return
ListItem
– das Listenelement
Löst aus
Error
: wenn der Artikel kein Listeneintrag ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asMultipleChoiceItem()
Gibt das Element als Multiple-Choice-Element zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits MULTIPLE_CHOICE
war.
Return
MultipleChoiceItem
: Multiple-Choice-Element
Löst aus
Error
: wenn das Element kein Multiple-Choice-Element ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asPageBreakItem()
Gibt das Element als Seitenumbruchelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits PAGE_BREAK
war.
Return
PageBreakItem
: das Seitenumbruchelement
Löst aus
Error
: Wenn das Element kein Seitenumbruchelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asParagraphTextItem()
Gibt das Element als Absatz-Textelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits PARAGRAPH_TEXT
war.
Return
ParagraphTextItem
: das Absatz-Textelement
Löst aus
Error
: wenn das Element kein Absatztextelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asScaleItem()
Gibt das Element als Skalenelement zurück. Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits SCALE
war.
Return
ScaleItem
– das Waagenelement
Löst aus
Error
: wenn das Element kein Waagenelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asSectionHeaderItem()
Gibt das Element als Element mit Abschnittsüberschrift zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits SECTION_HEADER
war.
Return
SectionHeaderItem
– das Element in der Abschnittsüberschrift
Löst aus
Error
: wenn das Element keine Abschnittsüberschrift ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asTextItem()
Gibt das Element als Textelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits TEXT
war.
Return
TextItem
: das Textelement
Löst aus
Error
: wenn das Element kein Textelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asTimeItem()
Gibt das Element als Zeitelement zurück Löst eine Skriptausnahme aus, wenn ItemType
nicht bereits TIME
war.
Return
TimeItem
– das Zeitelement
Löst aus
Error
: Wenn das Element kein Zeitelement ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asVideoItem()
duplicate()
Erstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
Return
Item
– ein Duplikat dieses Item
für die Verkettung
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getHelpText()
den Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems
, PageBreakItems
und SectionHeaderItems
bezeichnet)
Return
String
: Hilfe- oder Beschreibungstext des Elements
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getId()
Ruft die eindeutige ID des Artikels ab.
Return
Integer
: ID des Artikels
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getIndex()
Ruft den Index des Elements aus allen Elementen im Formular ab.
Return
Integer
: der Index des Elements
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getTitle()
Ruft den Titel des Elements ab (im Fall eines SectionHeaderItem
-Elements manchmal auch als Überschrifttext bezeichnet).
Return
String
: Titel oder Überschriftentext des Elements
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getType()
Ruft den Typ des Elements ab, dargestellt als ItemType
.
Return
ItemType
: Typ des Elements
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setHelpText(text)
Legt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems
, PageBreakItems
und SectionHeaderItems
wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | dem neuen Hilfetext |
Return
Item
– dieses Item
für Verkettung
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setTitle(title)
Legt den Titel des Elements fest. Bei SectionHeaderItem
wird dieser Text manchmal auch als Überschrifttext bezeichnet.
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | dem neuen Titel oder Text der Überschrift |
Return
Item
– dieses Item
für Verkettung
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms