Ein Element, das ein Listenelement darstellt. Ein List ist ein Paragraph, das mit einer Listen-ID verknüpft ist. Ein List-Element kann die Elemente Equation, Footnote, Horizontal, Inline, Inline, Page und Text enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.
List darf keine Zeilenumbruchzeichen enthalten. Zeilenumbruchzeichen („\n“) werden in Zeilenumbruchzeichen („\r“) umgewandelt.
List mit derselben Listen-ID gehören zur selben Liste und werden entsprechend nummeriert.
Die List für eine bestimmte Liste müssen nicht nebeneinander auf dem Tab stehen oder dasselbe übergeordnete Element haben. Zwei Elemente, die zur selben Liste gehören, können sich an beliebiger Stelle auf dem Tab befinden, ohne dass die fortlaufende Nummerierung unterbrochen wird. Das folgende Beispiel veranschaulicht dies:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Positioned | Erstellt und fügt ein neues Positioned aus dem angegebenen Image-Blob ein. |
append | Horizontal | Erstellt und hängt einen neuen Horizontal an. |
append | Inline | Erstellt ein neues Inline aus dem angegebenen Bild-Blob und hängt es an. |
append | Inline | Hängt die angegebene Inline an. |
append | Page | Erstellt und hängt einen neuen Page an. |
append | Page | Hängt die angegebene Page an. |
append | Text | Erstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an. |
append | Text | Hängt das angegebene Text-Element an. |
clear() | List | Löscht den Inhalt des Elements. |
copy() | List | Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück. |
edit | Text | Ruft eine Text-Version des aktuellen Elements zur Bearbeitung ab. |
find | Range | Durchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs. |
find | Range | Durchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen Range. |
find | Range | Sucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster. |
find | Range | Durchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster. |
get | Horizontal | Ruft die Horizontal ab. |
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 | Glyph | Ruft die Glyph des Listeneintrags ab. |
get | Paragraph | Ruft die Paragraph ab. |
get | Number|null | Ruft den Einzug am Ende in Punkten ab. |
get | Number|null | Ruft den Einzug der ersten Zeile in Punkten ab. |
get | Number|null | Ruft die Start-Einrückung ab. |
get | Number|null | Ruft den Zeilenabstand in Punkten ab. |
get | String|null | Ruft die Link-URL ab. |
get | String|null | Ruft die Listen-ID ab. |
get | Integer | Ruft die Verschachtelungsebene des Listeneintrags ab. |
get | Element|null | Ruft das nächste gleichgeordnete Element des Elements ab. |
get | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Positioned | Ruft ein Positioned anhand der Bild-ID ab. |
get | Positioned | Ruft alle Positioned-Objekte ab, die im Absatz verankert sind. |
get | Element|null | Ruft das vorherige gleichgeordnete Element des Elements ab. |
get | Number|null | Ruft den Abstand nach dem Element in Punkten ab. |
get | Number|null | Ruft den Abstand vor dem Element in Punkten ab. |
get | String | Ruft den Inhalt des Elements als Textstring ab. |
get | Text | Gibt die Textausrichtung zurück. |
get | Element | Ruft den Element des Elements ab. |
insert | Horizontal | Erstellt und fügt eine Horizontal am angegebenen Index ein. |
insert | Inline | Erstellt und fügt ein neues Inline aus dem angegebenen Bild-Blob am angegebenen Index ein. |
insert | Inline | Fügt das angegebene Inline am angegebenen Index ein. |
insert | Page | Erstellt und fügt ein neues Page am angegebenen Index ein. |
insert | Page | Fügt das angegebene Page am angegebenen Index ein. |
insert | Text | Erstellt ein neues Textelement und fügt es am angegebenen Index ein. |
insert | Text | Fügt das angegebene Text-Element am angegebenen Index mit dem angegebenen Textinhalt ein. |
is | Boolean | Gibt an, ob sich das Element am Ende von Document befindet. |
is | Boolean|null | Ruft die Einstellung für die Schreibrichtung von links nach rechts ab. |
merge() | List | Führt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen. |
remove | List | Entfernt das angegebene untergeordnete Element. |
remove | List | Entfernt das Element aus dem übergeordneten Element. |
remove | Boolean | Entfernt ein Positioned anhand der Bild-ID. |
replace | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet. |
set | List | Legt Horizontal fest. |
set | List | Legt die Attribute des Elements fest. |
set | List | Legt die Glyph des Listenelements fest. |
set | List | Legt Paragraph fest. |
set | List | Legt den Einzug am Ende in Punkten fest. |
set | List | Legt den Einzug der ersten Zeile in Punkten fest. |
set | List | Legt den Einzug am Anfang in Punkten fest. |
set | List | Legt die Einstellung für die Leserichtung von links nach rechts fest. |
set | List | Legt den Zeilenabstand als Menge fest, die die Anzahl der für den Abstand zu verwendenden Zeilen angibt. |
set | List | Legt die Link-URL fest. |
set | List | Legt die Listen-ID fest. |
set | List | Legt die Verschachtelungsebene des Listeneintrags fest. |
set | List | Legt den Abstand nach dem Element in Punkten fest. |
set | List | Legt den Abstand vor dem Element in Punkten fest. |
set | void | Legt den Inhalt des Listenelements als Text fest. |
set | List | Legt die Textausrichtung fest. |
Detaillierte Dokumentation
add Positioned Image(image)
Erstellt und fügt ein neues Positioned aus dem angegebenen Image-Blob ein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
image | Blob | die Bilddaten |
Rückflug
Positioned: das neue positionierte Bild
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Horizontal Rule()
Erstellt und hängt einen neuen Horizontal an.
Rückflug
Horizontal – die neue horizontale Linie
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Inline Image(image)
Erstellt ein neues Inline aus dem angegebenen Bild-Blob und hängt es an.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
image | Blob | die Bilddaten |
Rückflug
Inline – das angehängte Bild
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Inline Image(image)
Hängt die angegebene Inline an.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
image | Inline | die Bilddaten |
Rückflug
Inline – das angehängte Bild
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Page Break()
Erstellt und hängt einen neuen Page an.
Hinweis: Page ist möglicherweise nicht in Table enthalten.
Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.
Rückflug
Page: Das neue Seitenumbruchelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Page Break(pageBreak)
Hängt die angegebene Page an.
Hinweis: Page ist möglicherweise nicht in Table enthalten.
Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
page | Page | Der anzuhängende Seitenumbruch |
Rückflug
Page – das angehängte Seitenumbruchelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Text(text)
Erstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
text | String | die Textinhalte |
Rückflug
Text – das neue Textelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Text(text)
Hängt das angegebene Text-Element an.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
text | Text | das anzufügende Textelement |
Rückflug
Text – das angehängte Textelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
Alle untergeordneten Elemente des Elements werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.
Rückflug
List: Der neue Text.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
edit As Text()
Ruft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
Verwenden Sie edit, um den Inhalt der Elemente 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
find Element(elementType)
Durchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Element(elementType, from)
Durchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem 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, von dem aus gesucht werden soll. |
Rückflug
Range: Ein Suchergebnis, das die nächste Position des Suchelements angibt.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern)
Sucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
Eine Teilmenge der Funktionen für reguläre JavaScript-Ausdrücke wird nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.
Das bereitgestellte Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
search | String | das Muster, nach dem gesucht werden soll |
Rückflug
Range: Ein Suchergebnis, das die Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung vorliegt.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
Durchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
Eine Teilmenge der Funktionen für reguläre JavaScript-Ausdrücke wird nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.
Das bereitgestellte Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
search | String | das Muster, nach dem gesucht werden soll |
from | Range | das Suchergebnis, von dem aus gesucht werden soll |
Rückflug
Range: Ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung vorhanden ist.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alignment()
Ruft die Horizontal ab.
Rückflug
Horizontal – die Ausrichtung
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Attributes()
Ruft die Attribute des Elements ab.
Das Ergebnis ist ein Objekt, das für jedes gültige Elementattribut eine Property enthält. Jeder Property-Name entspricht einem Element in der Document-Aufzählung.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Rückflug
Object: Die Attribute des Elements.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child(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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child Index(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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Glyph Type()
Ruft die Glyph des Listeneintrags ab.
Rückflug
Glyph: Der Symboltyp.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Heading()
Ruft die Paragraph ab.
Rückflug
Paragraph – die Überschrift
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Indent End()
Ruft den Einzug am Ende in Punkten ab.
Rückflug
Number|null – der Einzug am Ende in Punkten
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Indent First Line()
Ruft den Einzug der ersten Zeile in Punkten ab.
Rückflug
Number|null – der Einzug der ersten Zeile in Punkten
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Indent Start()
Ruft die Start-Einrückung ab.
Rückflug
Number|null – der Einzug am Anfang
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Line Spacing()
Ruft den Zeilenabstand in Punkten ab.
Rückflug
Number|null: Der Zeilenabstand in Punkten
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Link Url()
Ruft die Link-URL ab.
Rückflug
String|null: Die Link-URL oder „null“, wenn das Element mehrere Werte für dieses Attribut enthält.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get List Id()
Ruft die Listen-ID ab.
Rückflug
String|null: die Listen-ID
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Nesting Level()
Ruft die Verschachtelungsebene des Listeneintrags ab.
Standardmäßig haben Listenelemente die Verschachtelungsebene 0. Die Schachtelungsebene bestimmt das Glyphen, das für das Listenelement verwendet wird.
Rückflug
Integer – die Verschachtelungsebene
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Next Sibling()
Ruft das nächste gleichgeordnete Element des Elements ab.
Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt auf das aktuelle Element.
Rückflug
Element|null: Das nächste gleichgeordnete Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Num Children()
Ruft die Anzahl der untergeordneten Elemente ab.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Rückflug
Integer – Die Anzahl der untergeordneten Elemente.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Positioned Image(id)
Ruft ein Positioned anhand der Bild-ID ab.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
id | String | die Bild-ID |
Rückflug
Positioned: das positionierte Bild
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Positioned Images()
Ruft alle Positioned-Objekte ab, die im Absatz verankert sind.
Rückflug
Positioned: Eine Liste mit positionierten Bildern
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Previous Sibling()
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|null: Das vorherige gleichgeordnete Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Spacing After()
Ruft den Abstand nach dem Element in Punkten ab.
Rückflug
Number|null: Der Abstand nach dem Element in Punkten.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Spacing Before()
Ruft den Abstand vor dem Element in Punkten ab.
Rückflug
Number|null: Der Abstand vor dem Element in Punkten
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text()
Ruft den Inhalt des Elements als Textstring ab.
Rückflug
String – der Inhalt des Elements als Textstring
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text Alignment()
Gibt die Textausrichtung zurück. Die verfügbaren Ausrichtungstypen sind Document, Document und Document.
Rückflug
Text: Der Typ der Textausrichtung oder null, wenn der Text mehrere Arten von Textausrichtungen enthält oder die Textausrichtung noch nie festgelegt wurde.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Horizontal Rule(childIndex)
Erstellt und fügt eine Horizontal am angegebenen Index ein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll |
Rückflug
Horizontal: Das neue Element für horizontale Linien
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
Erstellt und fügt ein neues Inline aus dem angegebenen Bild-Blob am angegebenen Index 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-Bildelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
Fügt das angegebene Inline am angegebenen Index ein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll |
image | Inline | die Bilddaten |
Rückflug
Inline: Das eingefügte Inline-Bildelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Page Break(childIndex)
Erstellt und fügt ein neues Page am angegebenen Index ein.
Hinweis: Page ist möglicherweise nicht in Table enthalten.
Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll |
Rückflug
Page: Das neue Seitenumbruchelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Page Break(childIndex, pageBreak)
Fügt das angegebene Page am angegebenen Index ein.
Hinweis: Page ist möglicherweise nicht in Table enthalten.
Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.
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: Das eingefügte Seitenumbruchelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
Erstellt ein neues Textelement und fügt es am angegebenen Index ein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll |
text | String | die Textinhalte |
Rückflug
Text – das neue Textelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
Fügt das angegebene Text-Element am angegebenen Index mit dem angegebenen Textinhalt ein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
child | Integer | Der Index, an dem das Element eingefügt werden soll |
text | Text | das einzufügende Textelement |
Rückflug
Text – das eingefügte Textelement
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is At Document End()
Gibt an, ob sich das Element am Ende von Document befindet.
Rückflug
Boolean: Gibt an, ob sich das Element am Ende des Tabs befindet.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is Left To Right()
Ruft die Einstellung für die Schreibrichtung von links nach rechts ab.
Rückflug
Boolean|null – die Einstellung für die rechtsläufige Schreibrichtung
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
merge()
Führt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
Es können nur Elemente desselben Element zusammengeführt werden. Alle untergeordneten Elemente des aktuellen Elements werden in das vorhergehende gleichgeordnete Element verschoben.
Das aktuelle Element wird aus dem Dokument entfernt.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Rückflug
List: Das zusammengeführte Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Child(child)
Entfernt das angegebene untergeordnete Element.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
child | Element | Das zu entfernende untergeordnete Element |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove From Parent()
Entfernt das Element aus dem übergeordneten Element.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Rückflug
List: Das entfernte Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Positioned Image(id)
Entfernt ein Positioned anhand der Bild-ID.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
id | String |
Rückflug
Boolean – gibt an, ob das angegebene Bild entfernt wurde
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
Das Suchmuster wird als String und nicht als reguläres JavaScript-Ausdrucksobjekt übergeben. Aus diesem Grund müssen Sie alle umgekehrten Schrägstriche im Muster maskieren.
Für diese Methode wird die RE2-Bibliothek für reguläre Ausdrücke von Google verwendet, wodurch die unterstützte Syntax eingeschränkt wird.
Das bereitgestellte Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
search | String | Das Regex-Muster, nach dem gesucht werden soll |
replacement | String | den Text, der als Ersatz verwendet werden soll |
Rückflug
Element – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alignment(alignment)
Legt Horizontal fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
alignment | Horizontal | die horizontale Ausrichtung |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Legt die Attribute des Elements fest.
Der angegebene Parameter „attributes“ muss ein Objekt sein, in dem jeder Attributname ein Element in der Aufzählung 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
List: Das aktuelle Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Glyph Type(glyphType)
Legt die Glyph des Listenelements fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
glyph | Glyph | Glyphentyp |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Heading(heading)
Legt Paragraph fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
heading | Paragraph | die Überschrift |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Indent End(indentEnd)
Legt den Einzug am Ende in Punkten fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
indent | Number | den Einzug am Ende in Punkten |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Indent First Line(indentFirstLine)
Legt den Einzug der ersten Zeile in Punkten fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
indent | Number | Einzug der ersten Zeile in Punkten |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Indent Start(indentStart)
Legt den Einzug am Anfang in Punkten fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
indent | Number | den Start des Einzugs in Punkten |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Left To Right(leftToRight)
Legt die Einstellung für die Leserichtung von links nach rechts fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
left | Boolean | die Einstellung „Rechtsläufig“ |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Line Spacing(multiplier)
Legt den Zeilenabstand als Menge fest, die die Anzahl der für den Abstand zu verwendenden Zeilen angibt.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
multiplier | Number | die Anzahl der Zeilen |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Link Url(url)
Legt die Link-URL fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
url | String | die Link-URL |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set List Id(listItem)
Legt die Listen-ID fest.
Die Listen-ID wird für die angegebene List auf denselben Wert festgelegt. Die beiden List werden als Mitglieder derselben Liste behandelt.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
list | List | Das Listenelement, dessen Listen-ID verwendet werden soll. |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Nesting Level(nestingLevel)
Legt die Verschachtelungsebene des Listeneintrags fest.
Standardmäßig haben Listenelemente die Verschachtelungsebene 0. Die Schachtelungsebene bestimmt das Glyphen, das für das Listenelement verwendet wird.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
nesting | Integer | die Verschachtelungstiefe |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Spacing After(spacingAfter)
Legt den Abstand nach dem Element in Punkten fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
spacing | Number | Abstand nach dem Element in Punkten |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Spacing Before(spacingBefore)
Legt den Abstand vor dem Element in Punkten fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
spacing | Number | Der Abstand vor dem Element in Punkten |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text(text)
Legt den Inhalt des Listenelements als Text fest.
Hinweis: Vorhandene Inhalte werden gelöscht.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
text | String | die neuen Textinhalte |
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
Legt die Textausrichtung fest. Die verfügbaren 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 anzuwendenden Textausrichtung |
Rückflug
List – das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents