Class FooterSection

FooterSection

Ein Element, das einen Fußzeilenbereich darstellt. Ein Document enthält in der Regel höchstens ein FooterSection. Das FooterSection-Element kann die Elemente ListItem, Paragraph und Table enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt ein neues ListItem mit dem angegebenen Textinhalt und hängt es an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt ein neues Paragraph mit dem angegebenen Textinhalt und hängt es an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt ein neues Table mit einem TableCell für jeden angegebenen String-Wert an.
appendTable(table)TableHängt die angegebene Table an.
clear()FooterSectionLöscht den Inhalt des Elements.
copy()FooterSectionGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getImages()InlineImage[]|nullRuft alle InlineImages ab, die im Abschnitt enthalten sind.
getListItems()ListItem[]|nullRuft alle ListItems ab, die im Abschnitt enthalten sind.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]|nullRuft alle Paragraphs ab, die im Abschnitt enthalten sind (einschließlich ListItems).
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getTables()Table[]|nullRuft alle Tables ab, die im Abschnitt enthalten sind.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt ein neues HorizontalRule am angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem am angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt und fügt ein neues ListItem am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph am angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt ein neues Paragraph am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertTable(childIndex)TableErstellt und fügt ein neues Table am angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt und fügt ein neues Table mit den angegebenen Zellen am angegebenen Index ein.
insertTable(childIndex, table)TableFügt das angegebene Table am angegebenen Index ein.
removeChild(child)FooterSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FooterSection|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)FooterSectionLegt die Attribute des Elements fest.
setText(text)FooterSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FooterSectionLegt die Textausrichtung fest.

Detaillierte Dokumentation

appendHorizontalRule()

Erstellt und hängt einen neuen HorizontalRule an.

Die HorizontalRule wird in einer neuen Paragraph enthalten sein.

Rückflug

HorizontalRule: Die neue horizontale Linie.

Autorisierung

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

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

appendImage(image)

Erstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.

Das Bild wird in einem neuen Paragraph enthalten sein.

Parameter

NameTypBeschreibung
imageBlobSourceDie Bilddaten.

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

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

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

appendImage(image)

Hängt die angegebene InlineImage an.

Die InlineImage wird in einer neuen Paragraph enthalten sein.

Verwenden Sie diese Version von appendImage, wenn Sie eine Kopie eines vorhandenen InlineImage anhängen.

Parameter

NameTypBeschreibung
imageInlineImageDie Bilddaten.

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

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

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

appendListItem(listItem)

Hängt die angegebene ListItem an.

Verwenden Sie diese Version von appendListItem, wenn Sie eine Kopie eines vorhandenen ListItem anhängen.

Parameter

NameTypBeschreibung
listItemListItemDer anzuhängende Listeneintrag.

Rückflug

ListItem: Das angehängte Listenelement.

Autorisierung

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

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

appendListItem(text)

Erstellt ein neues ListItem mit dem angegebenen Textinhalt und hängt es an.

Aufeinanderfolgende Listenelemente werden als Teil derselben Liste hinzugefügt.

Parameter

NameTypBeschreibung
textStringDer Textinhalt des Listenelements.

Rückflug

ListItem – Das neue Listenelement.

Autorisierung

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

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

appendParagraph(paragraph)

Hängt die angegebene Paragraph an.

Verwenden Sie diese Version von appendParagraph, wenn Sie eine Kopie eines vorhandenen Paragraph anhängen.

Parameter

NameTypBeschreibung
paragraphParagraphDer anzuhängende Absatz.

Rückflug

Paragraph – Der angehängte Absatz.

Autorisierung

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

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

appendParagraph(text)

Erstellt ein neues Paragraph mit dem angegebenen Textinhalt und hängt es an.

Parameter

NameTypBeschreibung
textStringDer Textinhalt des Absatzes.

Rückflug

Paragraph – Der neue Absatz.

Autorisierung

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

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

appendTable()

Erstellt und hängt einen neuen Table an.

Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden können.

Rückflug

Table: Die neue Tabelle.

Autorisierung

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

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

appendTable(cells)

Hängt ein neues Table mit einem TableCell für jeden angegebenen String-Wert an.

Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden können.

Parameter

NameTypBeschreibung
cellsString[][]Der Textinhalt der Tabellenzellen, die der neuen Tabelle hinzugefügt werden sollen.

Rückflug

Table: Die angehängte Tabelle.

Autorisierung

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

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

appendTable(table)

Hängt die angegebene Table an.

Verwenden Sie diese Version von appendTable, wenn Sie eine Kopie eines vorhandenen Table anhängen. Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden können.

Parameter

NameTypBeschreibung
tableTableDie anzuhängende Tabelle.

Rückflug

Table: Die angehängte Tabelle.

Autorisierung

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

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

clear()

Löscht den Inhalt des Elements.

Rückflug

FooterSection: Das aktuelle Element.


copy()

Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.

Alle untergeordneten Elemente des Elements werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Rückflug

FooterSection: Der neue Text.

Autorisierung

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

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

editAsText()

Ruft eine Text-Version des aktuellen Elements zur Bearbeitung ab.

Verwenden Sie editAsText, um den Inhalt der Elemente als Rich-Text zu bearbeiten. Im editAsText-Modus werden nicht textbasierte Elemente wie InlineImage und HorizontalRule ignoriert.

Untergeordnete Elemente, die vollständig in einem gelöschten Textbereich enthalten sind, werden aus dem Element entfernt.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Rückflug

Text: eine Textversion des aktuellen Elements


findElement(elementType)

Durchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.

Parameter

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll.

Rückflug

RangeElement|null: Ein Suchergebnis, das die Position des Suchelements angibt.

Autorisierung

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

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

findElement(elementType, from)

Durchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parameter

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll.
fromRangeElementDas Suchergebnis, von dem aus gesucht werden soll.

Rückflug

RangeElement|null: Ein Suchergebnis, das die nächste Position des Suchelements angibt.

Autorisierung

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

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

findText(searchPattern)

Sucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.

Eine Teilmenge der Funktionen für reguläre JavaScript-Ausdrücke wird nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das bereitgestellte Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll

Rückflug

RangeElement|null: Ein Suchergebnis, das die Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung vorliegt.

Autorisierung

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

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

findText(searchPattern, from)

Durchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.

Eine Teilmenge der Funktionen für reguläre JavaScript-Ausdrücke wird nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das bereitgestellte Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, von dem aus gesucht werden soll

Rückflug

RangeElement|null: Ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung vorhanden ist.

Autorisierung

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

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

getAttributes()

Ruft die Attribute des Elements ab.

Das Ergebnis ist ein Objekt, das für jedes gültige Elementattribut eine Property enthält. Jeder Property-Name entspricht einem Element in der DocumentApp.Attribute-Aufzählung.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Rückflug

Object: Die Attribute des Elements.

Autorisierung

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

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

getChild(childIndex)

Ruft das untergeordnete Element am angegebenen untergeordneten Index ab.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parameter

NameTypBeschreibung
childIndexIntegerDer Index des untergeordneten Elements, das abgerufen werden soll.

Rückflug

Element: Das untergeordnete Element am angegebenen Index.

Autorisierung

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

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

getChildIndex(child)

Ruft den untergeordneten Index für das angegebene untergeordnete Element ab.

Parameter

NameTypBeschreibung
childElementDas untergeordnete Element, für das der Index abgerufen werden soll.

Rückflug

Integer – Der untergeordnete Index.

Autorisierung

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

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

getImages()

Ruft alle InlineImages ab, die im Abschnitt enthalten sind.

Rückflug

InlineImage[]|null – Die Bilder des Abschnitts.

Autorisierung

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

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

getListItems()

Ruft alle ListItems ab, die im Abschnitt enthalten sind.

Rückflug

ListItem[]|null: Die Elemente der Bereichsliste.

Autorisierung

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

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

getNumChildren()

Ruft die Anzahl der untergeordneten Elemente ab.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Rückflug

Integer – Die Anzahl der untergeordneten Elemente.

Autorisierung

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

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

getParagraphs()

Ruft alle Paragraphs ab, die im Abschnitt enthalten sind (einschließlich ListItems).

Rückflug

Paragraph[]|null – Die Absätze des Abschnitts.

Autorisierung

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

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

getParent()

Ruft das übergeordnete Element des Elements ab.

Das übergeordnete Element enthält das aktuelle Element.

Rückflug

ContainerElement|null: Das übergeordnete Element.

Autorisierung

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

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

getTables()

Ruft alle Tables ab, die im Abschnitt enthalten sind.

Rückflug

Table[]|null – Die Tabellen im Abschnitt.

Autorisierung

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

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

getText()

Ruft den Inhalt des Elements als Textstring ab.

Rückflug

String – der Inhalt des Elements als Textstring

Autorisierung

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

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

getTextAlignment()

Gibt die Textausrichtung zurück. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

Rückflug

TextAlignment|null: Der Typ der Textausrichtung oder null, wenn der Text mehrere Arten von Textausrichtungen enthält oder die Textausrichtung noch nie festgelegt wurde.

Autorisierung

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

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

getType()

Ruft den ElementType des Elements ab.

Mit getType() können Sie den genauen Typ eines bestimmten Elements ermitteln.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Rückflug

ElementType: Der Elementtyp.

Autorisierung

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

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

insertHorizontalRule(childIndex)

Erstellt und fügt ein neues HorizontalRule am angegebenen Index ein.

Die HorizontalRule wird in einer neuen Paragraph enthalten sein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem das Element eingefügt werden soll.

Rückflug

HorizontalRule: Die neue horizontale Linie.

Autorisierung

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

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

insertImage(childIndex, image)

Erstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem das Element eingefügt werden soll.
imageBlobSourceDie Bilddaten.

Rückflug

InlineImage: Das eingefügte Inlinebild.

Autorisierung

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

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

insertImage(childIndex, image)

Fügt das angegebene InlineImage am angegebenen Index ein.

Das Bild wird in einem neuen Paragraph enthalten sein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem das Element eingefügt werden soll.
imageInlineImageDas einzufügende Bild.

Rückflug

InlineImage: Das eingefügte Inlinebild.

Autorisierung

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

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

insertListItem(childIndex, listItem)

Fügt das angegebene ListItem am angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
listItemListItemDer einzufügende Listeneintrag.

Rückflug

ListItem: Der eingefügte Listeneintrag.

Autorisierung

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

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

insertListItem(childIndex, text)

Erstellt und fügt ein neues ListItem am angegebenen Index ein, das den angegebenen Textinhalt enthält.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
textStringDer Textinhalt des Listenelements.

Rückflug

ListItem – Das neue Listenelement.

Autorisierung

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

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

insertParagraph(childIndex, paragraph)

Fügt das angegebene Paragraph am angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
paragraphParagraphDer einzufügende Absatz.

Rückflug

Paragraph: Der eingefügte Absatz.

Autorisierung

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

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

insertParagraph(childIndex, text)

Erstellt und fügt ein neues Paragraph am angegebenen Index ein, das den angegebenen Textinhalt enthält.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
textStringDer Textinhalt des Absatzes.

Rückflug

Paragraph – Der neue Absatz.

Autorisierung

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

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

insertTable(childIndex)

Erstellt und fügt ein neues Table am angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.

Rückflug

Table: Die neue Tabelle.

Autorisierung

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

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

insertTable(childIndex, cells)

Erstellt und fügt ein neues Table mit den angegebenen Zellen am angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
cellsString[][]Der Textinhalt der Tabellenzellen, die der neuen Tabelle hinzugefügt werden sollen.

Rückflug

Table: Die neue Tabelle.

Autorisierung

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

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

insertTable(childIndex, table)

Fügt das angegebene Table am angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
tableTableDie einzufügende Tabelle.

Rückflug

Table: Die eingefügte Tabelle.

Autorisierung

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

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

removeChild(child)

Entfernt das angegebene untergeordnete Element.

Parameter

NameTypBeschreibung
childElementDas untergeordnete Element, das entfernt werden soll.

Rückflug

FooterSection: Das aktuelle Element.

Autorisierung

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

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

removeFromParent()

Entfernt das Element aus dem übergeordneten Element.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Rückflug

FooterSection|null: Das entfernte Element.

Autorisierung

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

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

replaceText(searchPattern, replacement)

Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.

Das Suchmuster wird als String und nicht als reguläres JavaScript-Ausdrucksobjekt übergeben. Aus diesem Grund müssen Sie alle umgekehrten Schrägstriche im Muster maskieren.

Für diese Methode wird die RE2-Bibliothek für reguläre Ausdrücke von Google verwendet, wodurch die unterstützte Syntax eingeschränkt wird.

Das bereitgestellte Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Parameter

NameTypBeschreibung
searchPatternStringDas Regex-Muster, nach dem gesucht werden soll
replacementStringden Text, der als Ersatz verwendet werden soll

Rückflug

Element – das aktuelle Element

Autorisierung

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

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

setAttributes(attributes)

Legt die Attribute des Elements fest.

Der angegebene Parameter „attributes“ muss ein Objekt sein, in dem jeder Attributname ein Element in der Aufzählung DocumentApp.Attribute ist und jeder Attributwert der neue Wert ist, der angewendet werden soll.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückflug

FooterSection: Das aktuelle Element.

Autorisierung

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

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

setText(text)

Legt den Inhalt als Nur-Text fest.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringDer neue Textinhalt.

Rückflug

FooterSection: Das aktuelle Element.

Autorisierung

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

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

setTextAlignment(textAlignment)

Legt die Textausrichtung fest. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NameTypBeschreibung
textAlignmentTextAlignmentdie Art der anzuwendenden Textausrichtung

Rückflug

FooterSection – das aktuelle Element

Autorisierung

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

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

Eingestellte Methoden