Class Body

Body

Der Inhalt eines Tabs in einem Google Docs-Dokument. Das Body-Element kann ListItem-, Paragraph-, Table- und TableOfContents-Elemente enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Body enthält in der Regel den gesamten Inhalt des Tabs mit Ausnahme der HeaderSection-, FooterSection- und FootnoteSection-Elemente.

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

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt und hängt eine neue ListItem mit dem angegebenen Textinhalt an.
appendPageBreak()PageBreakErstellt und hängt einen neuen PageBreak an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt für jeden angegebenen Stringwert eine neue Table mit einer TableCell an.
appendTable(table)TableHängt die angegebene Table an.
clear()BodyDer Inhalt des Elements wird gelöscht.
copy()BodyGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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.
getHeadingAttributes(paragraphHeading)ObjectRuft die Attribute für die angegebene ParagraphHeading ab.
getImages()InlineImage[]Hiermit werden alle InlineImages im Abschnitt abgerufen.
getListItems()ListItem[]Hiermit werden alle ListItems im Abschnitt abgerufen.
getMarginBottom()NumberRuft den unteren Rand in Punkten ab.
getMarginLeft()NumberRuft den linken Rand in Punkten ab.
getMarginRight()NumberRuft den rechten Rand ab.
getMarginTop()NumberRuft den oberen Rand ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getPageHeight()NumberLiefert die Seitenhöhe in Punkten.
getPageWidth()NumberRuft die Seitenbreite in Punkten ab.
getParagraphs()Paragraph[]Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Hiermit werden alle Tables im Abschnitt abgerufen.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageErstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem an der angegebenen Position ein.
insertListItem(childIndex, text)ListItemErstellt und fügt am angegebenen Index eine neue ListItem mit dem angegebenen Textinhalt ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt eine neue PageBreak an der angegebenen Position ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak an der angegebenen Position ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph an der angegebenen Position ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.
insertTable(childIndex)TableErstellt und fügt eine neue Table an der angegebenen Position ein.
insertTable(childIndex, cells)TableErstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.
insertTable(childIndex, table)TableFügt das angegebene Table an der angegebenen Position ein.
removeChild(child)BodyEntfernt das angegebene untergeordnete Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)BodyHiermit werden die Attribute des Elements festgelegt.
setHeadingAttributes(paragraphHeading, attributes)BodyLegt die Attribute für die angegebene ParagraphHeading fest.
setMarginBottom(marginBottom)BodyLegt den unteren Rand in Punkten fest.
setMarginLeft(marginLeft)BodyLegt den linken Rand in Punkten fest.
setMarginRight(marginRight)BodyLegt den rechten Rand in Punkten fest.
setMarginTop(marginTop)BodyLegt den oberen Rand fest.
setPageHeight(pageHeight)BodyLegt die Seitenhöhe in Punkten fest.
setPageWidth(pageWidth)BodyLegt die Seitenbreite in Punkten fest.
setText(text)BodyDer Inhalt wird als Nur-Text festgelegt.
setTextAlignment(textAlignment)BodyHiermit wird die Textausrichtung festgelegt.

Detaillierte Dokumentation

appendHorizontalRule()

Erstellt und hängt einen neuen HorizontalRule an.

Die HorizontalRule wird in einem neuen Paragraph enthalten sein.

Rückflug

HorizontalRule: Die neue horizontale Linie.

Autorisierung

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

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

appendImage(image)

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

Das Bild wird in einer neuen Paragraph gespeichert.

Parameter

NameTypBeschreibung
imageBlobSourceDie Bilddaten.

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

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

  • 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 einem neuen Paragraph enthalten sein.

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

Parameter

NameTypBeschreibung
imageInlineImageDie Bilddaten.

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

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

  • 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 einer vorhandenen ListItem anhängen.

Parameter

NameTypBeschreibung
listItemListItemDer Listeneintrag, der angehängt werden soll.

Rückflug

ListItem: Der angehängte Listeneintrag.

Autorisierung

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

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

appendListItem(text)

Erstellt und hängt eine neue ListItem mit dem angegebenen Textinhalt an.

Nachfolgende 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendPageBreak()

Erstellt und hängt einen neuen PageBreak an.

Die PageBreak wird in einem neuen Paragraph enthalten sein.

Rückflug

PageBreak – der neue Seitenumbruch.

Autorisierung

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

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

appendPageBreak(pageBreak)

Hängt die angegebene PageBreak an.

Die PageBreak wird in einem neuen Paragraph enthalten sein.

Verwenden Sie diese Version von appendPageBreak, wenn Sie eine Kopie einer vorhandenen PageBreak anhängen.

Parameter

NameTypBeschreibung
pageBreakPageBreakDer einzufügende Seitenumbruch.

Rückflug

PageBreak: Der angehängte Seitenumbruch.

Autorisierung

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

  • 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 einer vorhandenen Paragraph anhängen.

Parameter

NameTypBeschreibung
paragraphParagraphDer Absatz, der angehängt werden soll.

Rückflug

Paragraph: Der angehängte Absatz.

Autorisierung

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

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

appendParagraph(text)

Erstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.

Parameter

NameTypBeschreibung
textStringDer Textinhalt des Absatzes.

Rückflug

Paragraph – der neue Absatz.

Autorisierung

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

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

appendTable()

Erstellt und hängt einen neuen Table an.

Mit dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden dürfen.

Rückflug

Table: Die neue Tabelle.

Autorisierung

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

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

appendTable(cells)

Hängt für jeden angegebenen Stringwert eine neue Table mit einer TableCell an.

Mit dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden dürfen.

Parameter

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

Rückflug

Table: Die angehängte Tabelle.

Autorisierung

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

  • 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 einer vorhandenen Table anhängen. Mit dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden dürfen.

Parameter

NameTypBeschreibung
tableTableDie Tabelle, die angehängt werden soll.

Rückflug

Table: Die angehängte Tabelle.

Autorisierung

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

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

clear()

Der Inhalt des Elements wird gelöscht.

Rückflug

Body: Das aktuelle Element.


copy()

Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.

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

Rückflug

Body – die neue Kopie.

Autorisierung

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

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

Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.

Parameter

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll.

Rückflug

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

Autorisierung

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

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

findElement(elementType, from)

Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der 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, in dem gesucht werden soll.

Rückflug

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

Autorisierung

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

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

findText(searchPattern)

Es wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.

Einige der Funktionen für reguläre Ausdrücke in JavaScript werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas zu suchende Muster

Rückflug

RangeElement: ein Suchergebnis, das die Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung gefunden wurde

Autorisierung

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

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

findText(searchPattern, from)

Es wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.

Einige der Funktionen für reguläre Ausdrücke in JavaScript werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas zu suchende Muster
fromRangeElementdas Suchergebnis, in dem gesucht werden soll

Rückflug

RangeElement: ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung gefunden wurde

Autorisierung

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

  • 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 mit einer Property für jedes gültige Elementattribut, wobei jeder Property-Name einem Element in der DocumentApp.Attribute-Aufzählung entspricht.

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getHeadingAttributes(paragraphHeading)

Ruft die Attribute für die angegebene ParagraphHeading ab.

Parameter

NameTypBeschreibung
paragraphHeadingParagraphHeadingDie Überschrift, deren Attribute abgerufen werden sollen.

Rückflug

Object: Eine Zuordnung der Attribute und ihrer aktuellen Werte.

Autorisierung

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

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

getImages()

Hiermit werden alle InlineImages im Abschnitt abgerufen.

Rückflug

InlineImage[] – die Abschnittsbilder.

Autorisierung

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

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

getListItems()

Hiermit werden alle ListItems im Abschnitt abgerufen.

Rückflug

ListItem[]: Die Elemente der Bereichsliste.

Autorisierung

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

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

getMarginBottom()

Ruft den unteren Rand in Punkten ab.

Rückflug

Number: Der untere Rand in Punkten.

Autorisierung

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

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

getMarginLeft()

Ruft den linken Rand in Punkten ab.

Rückflug

Number: Der linke Rand in Punkten.

Autorisierung

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

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

getMarginRight()

Ruft den rechten Rand ab.

Rückflug

Number: Der rechte Rand in Punkten.

Autorisierung

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

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

getMarginTop()

Ruft den oberen Rand ab.

Rückflug

Number: Der obere Rand in Punkten.

Autorisierung

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

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getPageHeight()

Liefert die Seitenhöhe in Punkten.

Rückflug

Number: Die Seitenhöhe in Punkten.

Autorisierung

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

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

getPageWidth()

Ruft die Seitenbreite in Punkten ab.

Rückflug

Number: Seitenbreite in Punkten.

Autorisierung

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

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

getParagraphs()

Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.

Rückflug

Paragraph[] – die Absätze des Abschnitts.

Autorisierung

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

  • 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: Das übergeordnete Element.

Autorisierung

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

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

getTables()

Hiermit werden alle Tables im Abschnitt abgerufen.

Rückflug

Table[] – die Abschnittstabellen.

Autorisierung

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

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getTextAlignment()

Die Textausrichtung wird abgerufen. Verfügbare Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

Rückflug

TextAlignment – die Art der Textausrichtung oder null, wenn der Text mehrere Textausrichtungen enthält oder die Textausrichtung noch nie festgelegt wurde

Autorisierung

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

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertHorizontalRule(childIndex)

Erstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.

Die HorizontalRule wird in einem 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(childIndex, image)

Erstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.

Parameter

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

Rückflug

InlineImage: Das eingefügte Inline-Bild.

Autorisierung

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

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

insertImage(childIndex, image)

Fügt das angegebene InlineImage an der angegebenen Position ein.

Das Bild wird in einer neuen Paragraph gespeichert.

Parameter

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

Rückflug

InlineImage: Das eingefügte Inline-Bild.

Autorisierung

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

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

insertListItem(childIndex, listItem)

Fügt das angegebene ListItem an der angegebenen Position 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertListItem(childIndex, text)

Erstellt und fügt am angegebenen Index eine neue ListItem mit dem angegebenen Textinhalt ein.

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertPageBreak(childIndex)

Erstellt und fügt eine neue PageBreak an der angegebenen Position ein.

Die PageBreak wird in einem neuen Paragraph enthalten sein.

Parameter

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

Rückflug

PageBreak – der neue Seitenumbruch.

Autorisierung

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

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

insertPageBreak(childIndex, pageBreak)

Fügt das angegebene PageBreak an der angegebenen Position ein.

Die PageBreak wird in einem neuen Paragraph enthalten sein.

Parameter

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

Rückflug

PageBreak: Der eingefügte Seitenumbruch.

Autorisierung

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

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

insertParagraph(childIndex, paragraph)

Fügt das angegebene Paragraph an der angegebenen Position 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertParagraph(childIndex, text)

Erstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertTable(childIndex)

Erstellt und fügt eine neue Table an der angegebenen Position ein.

Parameter

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

Rückflug

Table: Die neue Tabelle.

Autorisierung

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

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

insertTable(childIndex, cells)

Erstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.

Parameter

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

Rückflug

Table: Die neue Tabelle.

Autorisierung

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

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

insertTable(childIndex, table)

Fügt das angegebene Table an der angegebenen Position 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

Body: Das aktuelle Element.

Autorisierung

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

  • 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 mithilfe von regulären Ausdrücken.

Das Suchmuster wird als String übergeben, nicht als JavaScript-Objekt für reguläre Ausdrücke. Aus diesem Grund müssen alle umgekehrten Schrägstriche im Muster maskiert werden.

Bei dieser Methode wird die reguläre Ausdrucksbibliothek RE2 von Google verwendet, was die unterstützte Syntax einschränkt.

Das angegebene reguläre Ausdrucksmuster 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 zu ersetzenden Text

Rückflug

Element – das aktuelle Element

Autorisierung

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

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

setAttributes(attributes)

Hiermit werden die Attribute des Elements festgelegt.

Der angegebene Attributparameter muss ein Objekt sein, bei 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

Body: Das aktuelle Element.

Autorisierung

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

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

setHeadingAttributes(paragraphHeading, attributes)

Legt die Attribute für die angegebene ParagraphHeading fest.

Parameter

NameTypBeschreibung
paragraphHeadingParagraphHeadingDie Überschrift, deren Attribute festgelegt werden sollen.
attributesObjectEine Zuordnung von Attributen und den Werten, die für sie festgelegt werden sollen.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setMarginBottom(marginBottom)

Legt den unteren Rand in Punkten fest.

Parameter

NameTypBeschreibung
marginBottomNumberDer untere Rand in Punkten.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setMarginLeft(marginLeft)

Legt den linken Rand in Punkten fest.

Parameter

NameTypBeschreibung
marginLeftNumberDer linke Rand in Punkten.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setMarginRight(marginRight)

Legt den rechten Rand in Punkten fest.

Parameter

NameTypBeschreibung
marginRightNumberDer rechte Rand.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setMarginTop(marginTop)

Legt den oberen Rand fest.

Parameter

NameTypBeschreibung
marginTopNumberDer obere Rand in Punkten.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setPageHeight(pageHeight)

Legt die Seitenhöhe in Punkten fest.

Parameter

NameTypBeschreibung
pageHeightNumberDie Seitenhöhe in Punkten.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setPageWidth(pageWidth)

Legt die Seitenbreite in Punkten fest.

Parameter

NameTypBeschreibung
pageWidthNumberDie Seitenbreite in Punkten.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setText(text)

Der Inhalt wird als Nur-Text festgelegt.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringDer neue Textinhalt.

Rückflug

Body: Das aktuelle Element.

Autorisierung

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

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

setTextAlignment(textAlignment)

Hiermit wird die Textausrichtung festgelegt. Verfügbare 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 Textausrichtung

Rückflug

Body – das aktuelle Element

Autorisierung

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

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

Eingestellte Methoden