Interface Item

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Punkt

Ein generisches Formularelement, das Eigenschaften enthält, die für alle Elemente gelten, z. B. den Titel und den Hilfetext. Elemente können über ein Form aufgerufen oder erstellt werden.

Zur Verarbeitung typspezifischer Attribute verwenden Sie getType(), um das ItemType des Elements zu prüfen. Anschließend wandeln Sie das Element 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

NameKurzbeschreibung

Methoden

MethodeRückgabetypKurzbeschreibung
asCheckboxGridItem()CheckboxGridItemGibt das Element als Rasterelement zurück.
asCheckboxItem()CheckboxItemGibt das Element als Kontrollkästchenelement zurück.
asDateItem()DateItemGibt das Element als Datumselement zurück.
asDateTimeItem()DateTimeItemGibt das Element als Datum/Uhrzeit-Element zurück.
asDurationItem()DurationItemGibt das Element als Element mit der Dauer zurück.
asGridItem()GridItemGibt das Element als Rasterelement zurück.
asImageItem()ImageItemGibt das Element als Bildelement zurück.
asListItem()ListItemGibt das Element als Listeneintrag zurück.
asMultipleChoiceItem()MultipleChoiceItemGibt den Artikel als Multiple-Choice-Element zurück.
asPageBreakItem()PageBreakItemGibt das Element als Seitenumbruch zurück.
asParagraphTextItem()ParagraphTextItemGibt das Element als Absatztextelement zurück.
asScaleItem()ScaleItemGibt das Element als skaliertes Element zurück.
asSectionHeaderItem()SectionHeaderItemGibt das Element als Abschnittsheader-Element zurück.
asTextItem()TextItemGibt das Element als Textelement zurück.
asTimeItem()TimeItemGibt das Element als Zeitelement zurück.
asVideoItem()VideoItemGibt das Element als Videoelement zurück.
duplicate()ItemErstellt eine Kopie dieses Elements und hängt es an das Ende des Formulars an.
getHelpText()StringRuft den Hilfetext des Elements ab. Dieser wird manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet.
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab. Dieser wird manchmal als Headertext bezeichnet, falls SectionHeaderItem.
getType()ItemTypeRuft den Elementtyp ab, dargestellt als ItemType.
setHelpText(text)ItemLegt den Hilfetext des Elements fest (manchmal auch Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems).
setTitle(title)ItemLegt den Titel des Elements fest (manchmal auch Headertext bei SectionHeaderItem)

Detaillierte Dokumentation

asCheckboxGridItem()

Gibt das Element als Rasterelement zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits CHECKBOX_GRID war.

Zurücksenden

CheckboxGridItem: das Rasterelement

Throws

Error: Wenn das Element kein Kästchenraster ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asCheckboxItem()

Gibt das Element als Kontrollkästchenelement zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits CHECKBOX war.

Zurücksenden

CheckboxItem: das Kästchenelement

Throws

Error: Wenn das Element kein Kästchen ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

DateItem: das Datum

Throws

Error: Wenn das Element kein Datumselement ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

DateTimeItem: Datum und Uhrzeit

Throws

Error: Wenn das Element kein Datum-Uhrzeit-Element ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asDurationItem()

Gibt das Element als Element mit der Dauer zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits DURATION war.

Zurücksenden

DurationItem: der Wert für die Dauer

Throws

Error: Wenn das Element kein Dauerelement ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

GridItem: das Rasterelement

Throws

Error: Wenn das Element kein Rasterelement ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asImageItem()

Gibt das Element als Bildelement zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits IMAGE war.

Zurücksenden

ImageItem: das Bildelement

Throws

Error: Wenn das Element kein Bildelement ist.


asListItem()

Gibt das Element als Listeneintrag zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits LIST war.

Zurücksenden

ListItem: der Listeneintrag

Throws

Error: Wenn das Element kein Listeneintrag ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asMultipleChoiceItem()

Gibt den Artikel als Multiple-Choice-Element zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits MULTIPLE_CHOICE war.

Zurücksenden

MultipleChoiceItem: Multiple-Choice-Element

Throws

Error: Wenn das Element kein Multiple-Choice-Element ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asPageBreakItem()

Gibt das Element als Seitenumbruch zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits PAGE_BREAK war.

Zurücksenden

PageBreakItem: Der Seitenumbruch

Throws

Error: Wenn das Element kein Seitenumbruch ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asParagraphTextItem()

Gibt das Element als Absatztextelement zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits PARAGRAPH_TEXT war.

Zurücksenden

ParagraphTextItem: Absatztextelement

Throws

Error: Wenn das Element kein Absatztextelement ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asScaleItem()

Gibt das Element als skaliertes Element zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits SCALE war.

Zurücksenden

ScaleItem: das Skalierungselement

Throws

Error: Wenn das Element kein Skalierungselement ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asSectionHeaderItem()

Gibt das Element als Abschnittsheader-Element zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits SECTION_HEADER war.

Zurücksenden

SectionHeaderItem: der Abschnitts-Header-Element

Throws

Error: Wenn das Element kein Abschnittsüberschrift ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

TextItem: das Textelement

Throws

Error: Wenn das Element kein Textelement ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

TimeItem: der Zeiteintrag

Throws

Error: Wenn das Element kein Zeitelement ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

asVideoItem()

Gibt das Element als Videoelement zurück. Löst eine Skriptausnahme aus, wenn ItemType nicht bereits VIDEO war.

Zurücksenden

VideoItem: das Videoelement

Throws

Error: Wenn das Element kein Videoelement ist.


duplicate()

Erstellt eine Kopie dieses Elements und hängt es an das Ende des Formulars an.

Zurücksenden

Item: ein Duplikat dieses Item, für Verkettung

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getHelpText()

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

Zurücksenden

String: der Hilfe- oder Beschreibungstext des Elements

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getId()

Ruft die eindeutige Kennung des Elements ab.

Zurücksenden

Integer: die ID des Elements

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

Integer: Der Index des Elements

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getTitle()

Ruft den Titel des Elements ab. Dieser wird manchmal als Headertext bezeichnet, falls SectionHeaderItem.

Zurücksenden

String: Titel oder Titel des Elements

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getType()

Ruft den Elementtyp ab, dargestellt als ItemType.

Zurücksenden

ItemType: Typ des Elements

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setHelpText(text)

Legt den Hilfetext des Elements fest (manchmal auch Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems).

Parameter

NameTypBeschreibung
textStringden neuen Hilfetext

Zurücksenden

Item – dieser Item für Verkettung

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setTitle(title)

Legt den Titel des Elements fest (manchmal auch Headertext bei SectionHeaderItem)

Parameter

NameTypBeschreibung
titleStringden neuen Titel oder Titel

Zurücksenden

Item – dieser Item für Verkettung

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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