Der Inhalt eines Tabs in einem Google Docs-Dokument. Das Body
-Element kann List
-, Paragraph
-, Table
- und Table
-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 Header
-, Footer
- und Footnote
-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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
append | Horizontal | Erstellt und hängt einen neuen Horizontal an. |
append | Inline | Erstellt und hängt ein neues Inline aus dem angegebenen Bild-Blob an. |
append | Inline | Hängt die angegebene Inline an. |
append | List | Hängt die angegebene List an. |
append | List | Erstellt und hängt eine neue List mit dem angegebenen Textinhalt an. |
append | Page | Erstellt und hängt einen neuen Page an. |
append | Page | Hängt die angegebene Page an. |
append | Paragraph | Hängt die angegebene Paragraph an. |
append | Paragraph | Erstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an. |
append | Table | Erstellt und hängt einen neuen Table an. |
append | Table | Hängt für jeden angegebenen Stringwert eine neue Table mit einer Table an. |
append | Table | Hängt die angegebene Table an. |
clear() | Body | Der Inhalt des Elements wird gelöscht. |
copy() | Body | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
edit | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
find | Range | Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht. |
find | Range | Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen Range . |
find | Range | Es wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht. |
find | Range | Es wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis. |
get | Object | Ruft die Attribute des Elements ab. |
get | Element | Ruft das untergeordnete Element am angegebenen untergeordneten Index ab. |
get | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab. |
get | Object | Ruft die Attribute für die angegebene Paragraph ab. |
get | Inline | Hiermit werden alle Inline im Abschnitt abgerufen. |
get | List | Hiermit werden alle List im Abschnitt abgerufen. |
get | Number | Ruft den unteren Rand in Punkten ab. |
get | Number | Ruft den linken Rand in Punkten ab. |
get | Number | Ruft den rechten Rand ab. |
get | Number | Ruft den oberen Rand ab. |
get | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
get | Number | Liefert die Seitenhöhe in Punkten. |
get | Number | Ruft die Seitenbreite in Punkten ab. |
get | Paragraph[] | Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich List . |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Table[] | Hiermit werden alle Tables im Abschnitt abgerufen. |
get | String | Ruft den Inhalt des Elements als Textstring ab. |
get | Text | Die Textausrichtung wird abgerufen. |
get | Element | Ruft den Element des Elements ab. |
insert | Horizontal | Erstellt und fügt eine neue Horizontal an der angegebenen Position ein. |
insert | Inline | Erstellt und fügt eine Inline aus dem angegebenen Bild-Blob an der angegebenen Position ein. |
insert | Inline | Fügt das angegebene Inline an der angegebenen Position ein. |
insert | List | Fügt das angegebene List an der angegebenen Position ein. |
insert | List | Erstellt und fügt am angegebenen Index eine neue List mit dem angegebenen Textinhalt ein. |
insert | Page | Erstellt und fügt eine neue Page an der angegebenen Position ein. |
insert | Page | Fügt das angegebene Page an der angegebenen Position ein. |
insert | Paragraph | Fügt das angegebene Paragraph an der angegebenen Position ein. |
insert | Paragraph | Erstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein. |
insert | Table | Erstellt und fügt eine neue Table an der angegebenen Position ein. |
insert | Table | Erstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein. |
insert | Table | Fügt das angegebene Table an der angegebenen Position ein. |
remove | Body | Entfernt das angegebene untergeordnete Element. |
replace | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken. |
set | Body | Hiermit werden die Attribute des Elements festgelegt. |
set | Body | Legt die Attribute für die angegebene Paragraph fest. |
set | Body | Legt den unteren Rand in Punkten fest. |
set | Body | Legt den linken Rand in Punkten fest. |
set | Body | Legt den rechten Rand in Punkten fest. |
set | Body | Legt den oberen Rand fest. |
set | Body | Legt die Seitenhöhe in Punkten fest. |
set | Body | Legt die Seitenbreite in Punkten fest. |
set | Body | Der Inhalt wird als Nur-Text festgelegt. |
set | Body | Hiermit wird die Textausrichtung festgelegt. |
Eingestellte Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
| Footnote[] | Hiermit werden alle Footnotes im Abschnitt abgerufen. |
| String | Ruft die Link-URL ab. |
| Element | Ruft das nächste gleichgeordnete Element des Elements ab. |
| Element | Ruft das vorherige gleichgeordnete Element des Elements ab. |
| Boolean | Bestimmt, ob sich das Element am Ende des Document befindet. |
| Body | Legt die Link-URL fest. |
Detaillierte Dokumentation
appendHorizontalRule()
Erstellt und hängt einen neuen Horizontal
an.
Die Horizontal
wird in einem neuen Paragraph
enthalten sein.
Rückflug
Horizontal
: 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 Inline
aus dem angegebenen Bild-Blob an.
Das Bild wird in einer neuen Paragraph
gespeichert.
Parameter
Name | Typ | Beschreibung |
---|---|---|
image | Blob | Die Bilddaten. |
Rückflug
Inline
: 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 Inline
an.
Die Inline
wird in einem neuen Paragraph
enthalten sein.
Verwenden Sie diese Version von append
, wenn Sie eine Kopie einer vorhandenen Inline
anhängen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
image | Inline | Die Bilddaten. |
Rückflug
Inline
: 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 List
an.
Verwenden Sie diese Version von append
, wenn Sie eine Kopie einer vorhandenen List
anhängen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
list | List | Der Listeneintrag, der angehängt werden soll. |
Rückflug
List
: 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 List
mit dem angegebenen Textinhalt an.
Nachfolgende Listenelemente werden als Teil derselben Liste hinzugefügt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Textinhalt des Listenelements. |
Rückflug
List
: 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 Page
an.
Die Page
wird in einem neuen Paragraph
enthalten sein.
Rückflug
Page
– 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 Page
an.
Die Page
wird in einem neuen Paragraph
enthalten sein.
Verwenden Sie diese Version von append
, wenn Sie eine Kopie einer vorhandenen Page
anhängen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
page | Page | Der einzufügende Seitenumbruch. |
Rückflug
Page
: 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 append
, wenn Sie eine Kopie einer vorhandenen Paragraph
anhängen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
paragraph | Paragraph | Der 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
Name | Typ | Beschreibung |
---|---|---|
text | String | Der 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 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.
Parameter
Name | Typ | Beschreibung |
---|---|---|
cells | String[][] | 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 append
, 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
Name | Typ | Beschreibung |
---|---|---|
table | Table | Die 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()
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 edit
, um den Inhalt des Elements als Rich-Text zu bearbeiten. Im edit
-Modus werden nicht textbasierte Elemente wie Inline
und Horizontal
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
Name | Typ | Beschreibung |
---|---|---|
element | Element | Der Elementtyp, nach dem gesucht werden soll. |
Rückflug
Range
: 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 Range
.
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
Name | Typ | Beschreibung |
---|---|---|
element | Element | Der Elementtyp, nach dem gesucht werden soll. |
from | Range | Das Suchergebnis, in dem gesucht werden soll. |
Rückflug
Range
: 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
Name | Typ | Beschreibung |
---|---|---|
search | String | das zu suchende Muster |
Rückflug
Range
: 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
Name | Typ | Beschreibung |
---|---|---|
search | String | das zu suchende Muster |
from | Range | das Suchergebnis, in dem gesucht werden soll |
Rückflug
Range
: 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 Document
-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
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der 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
Name | Typ | Beschreibung |
---|---|---|
child | Element | Das 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 Paragraph
ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
paragraph | Paragraph | Die Ü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 Inline
im Abschnitt abgerufen.
Rückflug
Inline
– 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 List
im Abschnitt abgerufen.
Rückflug
List
: 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 List
.
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
Container
: 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 Document
, Document
und Document
.
Rückflug
Text
– 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 Element
des Elements ab.
Mit get
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
Element
: 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 Horizontal
an der angegebenen Position ein.
Die Horizontal
wird in einem neuen Paragraph
enthalten sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll. |
Rückflug
Horizontal
: 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 Inline
aus dem angegebenen Bild-Blob an der angegebenen Position ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll. |
image | Blob | Die Bilddaten. |
Rückflug
Inline
: 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 Inline
an der angegebenen Position ein.
Das Bild wird in einer neuen Paragraph
gespeichert.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll. |
image | Inline | Das einzufügende Bild. |
Rückflug
Inline
: 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 List
an der angegebenen Position ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
list | List | Der einzufügende Listeneintrag. |
Rückflug
List
: 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 List
mit dem angegebenen Textinhalt ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
text | String | Der Textinhalt des Listenelements. |
Rückflug
List
: 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 Page
an der angegebenen Position ein.
Die Page
wird in einem neuen Paragraph
enthalten sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll. |
Rückflug
Page
– 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 Page
an der angegebenen Position ein.
Die Page
wird in einem neuen Paragraph
enthalten sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll. |
page | Page | Der einzufügende Seitenumbruch. |
Rückflug
Page
: 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
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
paragraph | Paragraph | Der 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
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
text | String | Der 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
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der 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
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
cells | String[][] | 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
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
table | Table | Die 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
Name | Typ | Beschreibung |
---|---|---|
child | Element | Das 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
Name | Typ | Beschreibung |
---|---|---|
search | String | das Regex-Muster, nach dem gesucht werden soll |
replacement | String | den 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 Document
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
Name | Typ | Beschreibung |
---|---|---|
attributes | Object | Die 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 Paragraph
fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
paragraph | Paragraph | Die Überschrift, deren Attribute festgelegt werden sollen. |
attributes | Object | Eine 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
Name | Typ | Beschreibung |
---|---|---|
margin | Number | Der 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
Name | Typ | Beschreibung |
---|---|---|
margin | Number | Der 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
Name | Typ | Beschreibung |
---|---|---|
margin | Number | Der 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
Name | Typ | Beschreibung |
---|---|---|
margin | Number | Der 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
Name | Typ | Beschreibung |
---|---|---|
page | Number | Die 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
Name | Typ | Beschreibung |
---|---|---|
page | Number | Die 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
Name | Typ | Beschreibung |
---|---|---|
text | String | Der 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 Document
, Document
und Document
.
// 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
Name | Typ | Beschreibung |
---|---|---|
text | Text | die 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
getFootnotes()
getFootnotes()
Veraltet. Dieses Element darf kein Footnote
enthalten.
Hiermit werden alle Footnotes
im Abschnitt abgerufen.
Rückflug
Footnote[]
: Fußnoten zum Abschnitt.
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
getLinkUrl()
getLinkUrl()
Veraltet. Anstatt einen Link auf einen ganzen Abschnitt anzuwenden, wenden Sie ihn stattdessen auf ein Element innerhalb des Abschnitts an.
Ruft die Link-URL ab.
Rückflug
String
: die Link-URL oder „null“, wenn das Element mehrere Werte für dieses Attribut enthält
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
getNextSibling()
getNextSibling()
Veraltet. Dieses Element hat keine Geschwister.
Ruft das nächste gleichgeordnete Element des Elements ab.
Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt dem aktuellen Element.
Rückflug
Element
: Das nächste gleichgeordnete 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
getPreviousSibling()
getPreviousSibling()
Veraltet. Dieses Element hat keine Geschwister.
Ruft das vorherige gleichgeordnete Element des Elements ab.
Das vorherige gleichgeordnete Element hat dasselbe übergeordnete Element und geht dem aktuellen Element voraus.
Rückflug
Element
: Das vorherige gleichgeordnete 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
isAtDocumentEnd()
isAtDocumentEnd()
Veraltet. Diese Methode ist für Header
nicht zuverlässig.
Bestimmt, ob sich das Element am Ende des Document
befindet.
Rückflug
Boolean
: Gibt an, ob sich das Element am Ende des Tabs befindet.
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
setLinkUrl(url)
setLinkUrl(url)
Veraltet. Anstatt einen Link auf einen ganzen Abschnitt anzuwenden, wenden Sie ihn stattdessen auf ein Element innerhalb des Abschnitts an.
Legt die Link-URL fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
url | String | die Link-URL |
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