Ein Element, das einen Dokumenttext darstellt. Body
kann die Elemente ListItem
, Paragraph
, Table
und TableOfContents
enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.
Body
enthält in der Regel den vollständigen Dokumentinhalt mit Ausnahme der Elemente HeaderSection
, FooterSection
und FootnoteSection
.
var doc = DocumentApp.getActiveDocument(); var body = doc.getBody(); // Append a paragraph and a page break to the document body section directly. body.appendParagraph("A paragraph."); body.appendPageBreak();
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendHorizontalRule() | HorizontalRule | Erstellt ein neues HorizontalRule -Objekt und hängt es an. |
appendImage(image) | InlineImage | Erstellt ein neues InlineImage -Objekt aus dem angegebenen Bild-Blob und hängt es an. |
appendImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendListItem(listItem) | ListItem | Hängt die angegebene ListItem an. |
appendListItem(text) | ListItem | Erstellt und hängt einen neuen ListItem mit dem angegebenen Textinhalt an. |
appendPageBreak() | PageBreak | Erstellt ein neues PageBreak -Objekt und hängt es an. |
appendPageBreak(pageBreak) | PageBreak | Hängt die angegebene PageBreak an. |
appendParagraph(paragraph) | Paragraph | Hängt die angegebene Paragraph an. |
appendParagraph(text) | Paragraph | Erstellt und hängt einen neuen Paragraph mit dem angegebenen Textinhalt an. |
appendTable() | Table | Erstellt ein neues Table -Objekt und hängt es an. |
appendTable(cells) | Table | Hängt einen neuen Table an, der für jeden angegebenen Stringwert einen TableCell enthält. |
appendTable(table) | Table | Hängt die angegebene Table an. |
clear() | Body | Löscht den Inhalt des Elements. |
copy() | Body | Gibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zum Bearbeiten ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit dem angegebenen RangeElement . |
findText(searchPattern) | RangeElement | Sucht den Inhalt des Elements mithilfe regulärer Ausdrücke nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht den Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten Suchergebnis. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element aus dem angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getHeadingAttributes(paragraphHeading) | Object | Ruft den Satz von Attributen für die angegebene ParagraphHeading ab. |
getImages() | InlineImage[] | Ruft alle im Abschnitt enthaltenen InlineImages ab. |
getListItems() | ListItem[] | Ruft alle im Abschnitt enthaltenen ListItems ab. |
getMarginBottom() | Number | Ruft den unteren Rand in Punkten ab. |
getMarginLeft() | Number | Ruft den linken Rand in Punkten ab. |
getMarginRight() | Number | Ruft den rechten Rand ab. |
getMarginTop() | Number | Ruft den oberen Rand ab. |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getPageHeight() | Number | Ruft die Seitenhöhe in Punkten ab. |
getPageWidth() | Number | Ruft die Seitenbreite in Punkten ab. |
getParagraphs() | Paragraph[] | Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems ). |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getTables() | Table[] | Ruft alle im Abschnitt enthaltenen Tables ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt einen neuen HorizontalRule und fügt ihn im angegebenen Index ein. |
insertImage(childIndex, image) | InlineImage | Erstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob im angegebenen Index ein. |
insertImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage in den angegebenen Index ein. |
insertListItem(childIndex, listItem) | ListItem | Fügt den angegebenen ListItem in den angegebenen Index ein. |
insertListItem(childIndex, text) | ListItem | Erstellt am angegebenen Index einen neuen ListItem und fügt ihn ein, der den angegebenen Textinhalt enthält. |
insertPageBreak(childIndex) | PageBreak | Erstellt einen neuen PageBreak und fügt ihn im angegebenen Index ein. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Fügt den angegebenen PageBreak in den angegebenen Index ein. |
insertParagraph(childIndex, paragraph) | Paragraph | Fügt den angegebenen Paragraph in den angegebenen Index ein. |
insertParagraph(childIndex, text) | Paragraph | Erstellt am angegebenen Index einen neuen Paragraph und fügt ihn ein, der den angegebenen Textinhalt enthält. |
insertTable(childIndex) | Table | Erstellt einen neuen Table und fügt ihn im angegebenen Index ein. |
insertTable(childIndex, cells) | Table | Erstellt einen neuen Table , der die angegebenen Zellen am angegebenen Index enthält, und fügt ihn ein. |
insertTable(childIndex, table) | Table | Fügt den angegebenen Table in den angegebenen Index ein. |
removeChild(child) | Body | Entfernt das angegebene untergeordnete Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters mithilfe regulärer Ausdrücke durch einen bestimmten Ersatzstring. |
setAttributes(attributes) | Body | Legt die Attribute des Elements fest. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Legt die Attribute für die angegebene ParagraphHeading fest. |
setMarginBottom(marginBottom) | Body | Legt den unteren Rand in Punkten fest. |
setMarginLeft(marginLeft) | Body | Legt den linken Rand in Punkten fest. |
setMarginRight(marginRight) | Body | Legt den rechten Rand in Punkten fest. |
setMarginTop(marginTop) | Body | Legt den oberen Rand fest. |
setPageHeight(pageHeight) | Body | Legt die Seitenhöhe in Punkten fest. |
setPageWidth(pageWidth) | Body | Legt die Seitenbreite in Punkten fest. |
setText(text) | Body | Legt den Inhalt als Nur-Text fest. |
setTextAlignment(textAlignment) | Body | Legt die Textausrichtung fest. |
Detaillierte Dokumentation
appendHorizontalRule()
Erstellt ein neues HorizontalRule
-Objekt und hängt es an.
HorizontalRule
wird in einem neuen Paragraph
-Objekt enthalten sein.
Return
HorizontalRule
– die neue horizontale Regel
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Erstellt ein neues InlineImage
-Objekt aus dem angegebenen Bild-Blob und hängt es an.
Das Bild wird in einem neuen Paragraph
enthalten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
image | BlobSource | die Bilddaten |
Return
InlineImage
: das angehängte Bild
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Hängt die angegebene InlineImage
an.
InlineImage
wird in einem neuen Paragraph
-Objekt enthalten sein.
Verwenden Sie diese Version von appendImage
, wenn Sie eine Kopie einer vorhandenen InlineImage
anhängen möchten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
image | InlineImage | die Bilddaten |
Return
InlineImage
: das angehängte Bild
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 möchten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
listItem | ListItem | Listenelement, das angehängt werden soll |
Return
ListItem
: das angehängte Listenelement
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
Erstellt und hängt einen neuen ListItem
mit dem angegebenen Textinhalt an.
Aufeinanderfolgende Listenelemente werden als Teil derselben Liste hinzugefügt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Textinhalt des Listenelements |
Return
ListItem
– das neue Listenelement
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
Erstellt ein neues PageBreak
-Objekt und hängt es an.
PageBreak
wird in einem neuen Paragraph
-Objekt enthalten sein.
Return
PageBreak
– der neue Seitenumbruch
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
Hängt die angegebene PageBreak
an.
PageBreak
wird in einem neuen Paragraph
-Objekt enthalten sein.
Verwenden Sie diese Version von appendPageBreak
, wenn Sie eine Kopie einer vorhandenen PageBreak
anhängen möchten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
pageBreak | PageBreak | den anzufügenden Seitenumbruch |
Return
PageBreak
: der angehängte Seitenumbruch
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 möchten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
paragraph | Paragraph | den hinzuzufügenden Absatz |
Return
Paragraph
: der angehängte Absatz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
Erstellt und hängt einen neuen Paragraph
mit dem angegebenen Textinhalt an.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Textinhalt des Absatzes |
Return
Paragraph
– der neue Absatz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable()
Erstellt ein neues Table
-Objekt und hängt es an.
Bei dieser Methode wird nach der Tabelle auch ein leerer Absatz angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden dürfen.
Return
Table
– die neue Tabelle
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
Hängt einen neuen Table
an, der für jeden angegebenen Stringwert einen TableCell
enthält.
Bei dieser Methode wird nach der Tabelle auch ein leerer Absatz angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden dürfen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
cells | String[][] | den Textinhalt der Tabellenzellen, der der neuen Tabelle hinzugefügt werden soll |
Return
Table
– die angehängte Tabelle
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 möchten.
Bei dieser Methode wird nach der Tabelle auch ein leerer Absatz angehängt, da Google Docs-Dokumente nicht mit einer Tabelle enden dürfen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
table | Table | Tabelle, die angefügt werden soll |
Return
Table
– die angehängte Tabelle
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Gibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.
Alle untergeordneten Elemente, die im Element vorhanden sind, werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.
Return
Body
: Die neue Kopie.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Ruft eine Text
-Version des aktuellen Elements zum Bearbeiten ab.
Verwenden Sie editAsText
, um den Inhalt der Elemente im RTF-Format zu bearbeiten. Im Modus editAsText
werden Nicht-Textelemente wie InlineImage
und HorizontalRule
ignoriert.
Untergeordnete Elemente, die vollständig in einem gelöschten Textbereich enthalten sind, werden aus dem Element entfernt.
var body = DocumentApp.getActiveDocument().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);
Return
Text
: eine Textversion des aktuellen Elements
findElement(elementType)
Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
Parameter
Name | Typ | Beschreibung |
---|---|---|
elementType | ElementType | Elementtyp, nach dem gesucht werden soll |
Return
RangeElement
: ein Suchergebnis, das die Position des Suchelements angibt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit dem angegebenen RangeElement
.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Parameter
Name | Typ | Beschreibung |
---|---|---|
elementType | ElementType | Elementtyp, nach dem gesucht werden soll |
from | RangeElement | das Suchergebnis, in dem gesucht werden soll, |
Return
RangeElement
: ein Suchergebnis, das die nächste Position des Suchelements angibt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Sucht den Inhalt des Elements mithilfe regulärer Ausdrücke nach dem angegebenen Textmuster.
Einige JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.
Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
searchPattern | String | das Muster, nach dem gesucht werden soll |
Return
RangeElement
: ein Suchergebnis, das die Position des Suchtextes angibt, oder null, wenn es keine Übereinstimmung gibt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Sucht den Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten Suchergebnis.
Einige JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.
Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
searchPattern | String | das Muster, nach dem gesucht werden soll |
from | RangeElement | das Suchergebnis, in dem gesucht werden soll, |
Return
RangeElement
: ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder null, wenn es keine Übereinstimmung gibt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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, das ein Attribut für jedes gültige Elementattribut enthält, wobei jeder Attributname einem Element in der DocumentApp.Attribute
-Aufzählung entspricht.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Return
Object
: Die Attribute des Elements.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Ruft das untergeordnete Element aus dem angegebenen untergeordneten Index ab.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var 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
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index des abzurufenden untergeordneten Elements |
Return
Element
: das untergeordnete Element beim angegebenen Index
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
child | Element | Das untergeordnete Element, für das der Index abgerufen werden soll |
Return
Integer
– der untergeordnete Index
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeadingAttributes(paragraphHeading)
Ruft den Satz von Attributen für die angegebene ParagraphHeading
ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
paragraphHeading | ParagraphHeading | Die Überschrift, deren Attribute abgerufen werden |
Return
Object
: Eine Zuordnung der Attribute und ihrer aktuellen Werte
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
Ruft alle im Abschnitt enthaltenen InlineImages
ab.
Return
InlineImage[]
– die Bereichsbilder
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
Ruft alle im Abschnitt enthaltenen ListItems
ab.
Return
ListItem[]
– die Elemente der Abschnittsliste
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginBottom()
Ruft den unteren Rand in Punkten ab.
Return
Number
: der untere Rand in Punkten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginLeft()
Ruft den linken Rand in Punkten ab.
Return
Number
: der linke Rand in Punkten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginRight()
Ruft den rechten Rand ab.
Return
Number
: der rechte Rand in Punkten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginTop()
Ruft den oberen Rand ab.
Return
Number
: der obere Rand in Punkten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Ruft die Anzahl der untergeordneten Elemente ab.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Return
Integer
: die Anzahl der untergeordneten Elemente
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageHeight()
Ruft die Seitenhöhe in Punkten ab.
Return
Number
: die Seitenhöhe in Punkten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageWidth()
Ruft die Seitenbreite in Punkten ab.
Return
Number
: die Seitenbreite in Punkten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
Ruft alle im Abschnitt enthaltenen Paragraphs
ab (einschließlich ListItems
).
Return
Paragraph[]
: die Absätze des Abschnitts
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.
Return
ContainerElement
: Das übergeordnete Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTables()
Ruft alle im Abschnitt enthaltenen Tables
ab.
Return
Table[]
– die Abschnittstabellen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.
Return
String
: der Inhalt des Elements als Textstring
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Ruft die Textausrichtung ab. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
und DocumentApp.TextAlignment.SUPERSCRIPT
.
Return
TextAlignment
: der Typ der Textausrichtung, oder null
, wenn der Text mehrere Arten von Textausrichtungen enthält oder wenn die Textausrichtung nie festgelegt wurde
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Ruft den ElementType
des Elements ab.
Verwenden Sie getType()
, um den genauen Typ eines bestimmten Elements zu bestimmen.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var 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.'); }
Return
ElementType
: Der Elementtyp.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Erstellt einen neuen HorizontalRule
und fügt ihn im angegebenen Index ein.
HorizontalRule
wird in einem neuen Paragraph
-Objekt enthalten sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem das Element eingefügt werden soll |
Return
HorizontalRule
– die neue horizontale Regel
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
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 im angegebenen Index ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem das Element eingefügt werden soll |
image | BlobSource | die Bilddaten |
Return
InlineImage
: das eingefügte Inline-Bild
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Fügt den angegebenen InlineImage
in den angegebenen Index ein.
Das Bild wird in einem neuen Paragraph
enthalten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem das Element eingefügt werden soll |
image | InlineImage | das einzufügende Bild |
Return
InlineImage
: das eingefügte Inline-Bild
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
Fügt den angegebenen ListItem
in den angegebenen Index ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
listItem | ListItem | das einzufügende Listenelement |
Return
ListItem
: das eingefügte Listenelement
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
Erstellt am angegebenen Index einen neuen ListItem
und fügt ihn ein, der den angegebenen Textinhalt enthält.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
text | String | Textinhalt des Listenelements |
Return
ListItem
– das neue Listenelement
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
Erstellt einen neuen PageBreak
und fügt ihn im angegebenen Index ein.
PageBreak
wird in einem neuen Paragraph
-Objekt enthalten sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem das Element eingefügt werden soll |
Return
PageBreak
– der neue Seitenumbruch
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
Fügt den angegebenen PageBreak
in den angegebenen Index ein.
PageBreak
wird in einem neuen Paragraph
-Objekt enthalten sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem das Element eingefügt werden soll |
pageBreak | PageBreak | die einzufügende Seite |
Return
PageBreak
: der eingefügte Seitenumbruch
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
Fügt den angegebenen Paragraph
in den angegebenen Index ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
paragraph | Paragraph | den einzufügenden Absatz |
Return
Paragraph
: der eingefügte Absatz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Erstellt am angegebenen Index einen neuen Paragraph
und fügt ihn ein, der den angegebenen Textinhalt enthält.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
text | String | Textinhalt des Absatzes |
Return
Paragraph
– der neue Absatz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
Erstellt einen neuen Table
und fügt ihn im angegebenen Index ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
Return
Table
– die neue Tabelle
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
Erstellt einen neuen Table
, der die angegebenen Zellen am angegebenen Index enthält, und fügt ihn ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
cells | String[][] | den Textinhalt der Tabellenzellen, der der neuen Tabelle hinzugefügt werden soll |
Return
Table
– die neue Tabelle
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
Fügt den angegebenen Table
in den angegebenen Index ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
childIndex | Integer | Index, an dem eingefügt werden soll |
table | Table | Tabelle, die eingefügt werden soll, |
Return
Table
: die eingefügte Tabelle
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Entfernt das angegebene untergeordnete Element.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Element | Das untergeordnete Element, das entfernt werden soll |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 mithilfe regulärer Ausdrücke durch einen bestimmten Ersatzstring.
Das Suchmuster wird als String und nicht als JavaScript-Objekt für reguläre Ausdrücke übergeben. Aus diesem Grund müssen Sie umgekehrte Schrägstriche im Muster mit Escapezeichen versehen.
Bei dieser Methode wird die RE2 von Google für reguläre Ausdrücke verwendet, die die unterstützte Syntax begrenzt.
Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parameter
Name | Typ | Beschreibung |
---|---|---|
searchPattern | String | Das Regex-Muster, nach dem gesucht werden soll |
replacement | String | den als Ersatz zu verwendenden Text |
Return
Element
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Legt die Attribute des Elements fest.
Der angegebene Attributparameter muss ein Objekt sein, bei dem jeder Attributname ein Element in der DocumentApp.Attribute
-Aufzählung und jeder Attributwert der neue Wert ist, der angewendet werden soll.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var 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. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parameter
Name | Typ | Beschreibung |
---|---|---|
attributes | Object | Die Attribute des Elements. |
Return
Body
: Das aktuelle Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
paragraphHeading | ParagraphHeading | die Überschrift, deren Attribute festgelegt werden |
attributes | Object | eine Zuordnung von Attributen und den Werten, auf die sie gesetzt werden. |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
marginBottom | Number | unterer Rand in Punkten |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
marginLeft | Number | der linke Rand in Punkten |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
marginRight | Number | rechten Rand |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginTop(marginTop)
Legt den oberen Rand fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
marginTop | Number | oberer Rand in Punkten |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
pageHeight | Number | die Seitenhöhe in Punkten |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
Name | Typ | Beschreibung |
---|---|---|
pageWidth | Number | die Seitenbreite in Punkten |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
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
Name | Typ | Beschreibung |
---|---|---|
text | String | den neuen Textinhalt |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parameter
Name | Typ | Beschreibung |
---|---|---|
textAlignment | TextAlignment | die Art der anzuwendenden Textausrichtung |
Return
Body
– das aktuelle Element
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents