Ein generisches Element. Der Inhalt von Document wird als Elemente dargestellt. Beispielsweise sind ListItem, Paragraph und Table Elemente und erben alle von Element definierten Methoden wie getType().
Klassen implementieren
| Name | Kurzbeschreibung |
|---|---|
Body | Der Inhalt eines Tabs in einem Google Docs-Dokument. |
Container | Ein allgemeines Element, das andere Elemente enthalten kann. |
Date | Ein Element, das ein formatiertes Datum darstellt |
Equation | Ein Element, das einen mathematischen Ausdruck darstellt. |
Equation | Ein Element, das eine Funktion in einem mathematischen Equation darstellt. |
Equation | Ein Element, das ein Funktionstrennzeichen in einem mathematischen Equation darstellt. |
Equation | Ein Element, das ein Symbol in einer mathematischen Equation darstellt. |
Footer | Ein Element, das einen Fußzeilenbereich darstellt. |
Footnote | Ein Element, das eine Fußnote darstellt. |
Footnote | Ein Element, das einen Fußnotenbereich darstellt. |
Header | Ein Element, das einen Header-Abschnitt darstellt. |
Horizontal | Ein Element, das eine horizontale Linie darstellt. |
Inline | Ein Element, das eine eingebettete Zeichnung darstellt. |
Inline | Ein Element, das ein eingebettetes Bild darstellt. |
List | Ein Element, das ein Listenelement darstellt. |
Page | Ein Element, das einen Seitenumbruch darstellt. |
Paragraph | Ein Element, das einen Absatz darstellt. |
Person | Ein Element, das einen Link zu einer Person darstellt. |
Rich | Ein Element, das einen Link zu einer Google-Ressource wie einer Drive-Datei oder einem YouTube-Video darstellt. |
Table | Ein Element, das eine Tabelle darstellt. |
Table | Ein Element, das eine Tabellenzelle darstellt. |
Table | Ein Element, das ein Inhaltsverzeichnis enthält. |
Table | Ein Element, das eine Tabellenzeile darstellt. |
Text | Ein Element, das einen Rich-Text-Bereich darstellt. |
Unsupported | Ein Element, das eine Region darstellt, die unbekannt ist oder nicht von einem Skript beeinflusst werden kann, z. B. eine Seitenzahl. |
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
as | Body | Gibt das aktuelle Element als Body zurück. |
as | Date | Gibt das aktuelle Element als Date zurück. |
as | Equation | Gibt das aktuelle Element als Equation zurück. |
as | Equation | Gibt das aktuelle Element als Equation zurück. |
as | Equation | Gibt das aktuelle Element als Equation zurück. |
as | Equation | Gibt das aktuelle Element als Equation zurück. |
as | Footer | Gibt das aktuelle Element als Footer zurück. |
as | Footnote | Gibt das aktuelle Element als Footnote zurück. |
as | Footnote | Gibt das aktuelle Element als Footnote zurück. |
as | Header | Gibt das aktuelle Element als Header zurück. |
as | Horizontal | Gibt das aktuelle Element als Horizontal zurück. |
as | Inline | Gibt das aktuelle Element als Inline zurück. |
as | Inline | Gibt das aktuelle Element als Inline zurück. |
as | List | Gibt das aktuelle Element als List zurück. |
as | Page | Gibt das aktuelle Element als Page zurück. |
as | Paragraph | Gibt das aktuelle Element als Paragraph zurück. |
as | Person | Gibt das aktuelle Element als Person zurück. |
as | Rich | Gibt das aktuelle Element als Rich zurück, z. B. einen Link zu einer Google Sheets-Datei. |
as | Table | Gibt das aktuelle Element als Table zurück. |
as | Table | Gibt das aktuelle Element als Table zurück. |
as | Table | Gibt das aktuelle Element als Table zurück. |
as | Table | Gibt das aktuelle Element als Table zurück. |
as | Text | Gibt das aktuelle Element als Text zurück. |
copy() | Element | Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück. |
get | Object | Ruft die Attribute des Elements ab. |
get | Element|null | Ruft das nächste gleichgeordnete Element des Elements ab. |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Element|null | Ruft das vorherige gleichgeordnete Element des Elements ab. |
get | Element | Ruft den Element des Elements ab. |
is | Boolean | Gibt an, ob sich das Element am Ende von Document befindet. |
merge() | Element|null | Führt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen. |
remove | Element|null | Entfernt das Element aus dem übergeordneten Element. |
set | Element | Legt die Attribute des Elements fest. |
Detaillierte Dokumentation
asBody()
Gibt das aktuelle Element als Body zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
Body: 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
asDate()
Gibt das aktuelle Element als Date zurück.
Wenn Sie wissen, dass ein Element ein Date ist, können Sie mit dieser Methode seinen Typ als Date festlegen. Dadurch können Sie sich im Apps Script-Editor mit der automatischen Vervollständigung die Methoden anzeigen lassen, die Sie mit einem Date verwenden können.
Rückflug
Date: Das aktuelle Element mit dem Typ Date.
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
asEquation()
Gibt das aktuelle Element als Equation zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
Equation: 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
asEquationFunction()
Gibt das aktuelle Element als EquationFunction zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
EquationFunction: 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
asEquationFunctionArgumentSeparator()
Gibt das aktuelle Element als EquationFunctionArgumentSeparator zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
EquationFunctionArgumentSeparator: 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
asEquationSymbol()
Gibt das aktuelle Element als EquationSymbol zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
EquationSymbol: 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
asFootnote()
Gibt das aktuelle Element als Footnote zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
Footnote: 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
asFootnoteSection()
Gibt das aktuelle Element als FootnoteSection zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
FootnoteSection: 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
asHeaderSection()
Gibt das aktuelle Element als HeaderSection zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
HeaderSection: 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
asHorizontalRule()
Gibt das aktuelle Element als HorizontalRule zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
HorizontalRule: 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
asInlineDrawing()
Gibt das aktuelle Element als InlineDrawing zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
InlineDrawing: 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
asInlineImage()
Gibt das aktuelle Element als InlineImage zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
InlineImage: 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
asListItem()
Gibt das aktuelle Element als ListItem zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
ListItem: 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
asPageBreak()
Gibt das aktuelle Element als PageBreak zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
PageBreak: 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
asParagraph()
Gibt das aktuelle Element als Paragraph zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
Paragraph: 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
asPerson()
Gibt das aktuelle Element als Person zurück.
Wenn Sie wissen, dass ein Element ein Person ist, verwenden Sie diese Methode, um seinen Typ als Person festzulegen.
So können Sie sich im Apps Script-Editor mit der automatischen Vervollständigung die Methoden anzeigen lassen, die Sie mit einem Personenelement verwenden können.
Rückflug
Person: Das aktuelle Element mit dem Typ Person.
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
asRichLink()
Gibt das aktuelle Element als RichLink zurück, z. B. einen Link zu einer Google Sheets-Datei.
Wenn Sie wissen, dass ein Element ein RichLink ist, können Sie mit dieser Methode seinen Typ als RichLink festlegen. Dadurch werden in der automatischen Vervollständigung im Apps Script-Editor die Methoden angezeigt, die Sie mit einem RichLink verwenden können.
Rückflug
RichLink: Das aktuelle Element mit dem Typ RichLink.
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
asTable()
Gibt das aktuelle Element als Table zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
Table: 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
asTableCell()
Gibt das aktuelle Element als TableCell zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
TableCell: 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
asTableOfContents()
Gibt das aktuelle Element als TableOfContents zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
TableOfContents: 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
asTableRow()
Gibt das aktuelle Element als TableRow zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
TableRow: 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
asText()
Gibt das aktuelle Element als Text zurück.
Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.
Rückflug
Text: 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
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
Element: 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
getAttributes()
Ruft die Attribute des Elements ab.
Das Ergebnis ist ein Objekt, das für jedes gültige Elementattribut eine Property enthält. Jeder Property-Name entspricht einem Element in der DocumentApp.Attribute-Aufzählung.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Rückflug
Object: Die Attribute des Elements.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNextSibling()
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
getParent()
Ruft das übergeordnete Element des Elements ab.
Das übergeordnete Element enthält das aktuelle Element.
Rückflug
ContainerElement|null: Das übergeordnete Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPreviousSibling()
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
getType()
Ruft den ElementType des Elements ab.
Mit getType() können Sie den genauen Typ eines bestimmten Elements ermitteln.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Rückflug
ElementType: Der Elementtyp.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
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
merge()
Führt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
Es können nur Elemente desselben ElementType 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
Element|null: 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
removeFromParent()
Entfernt das Element aus dem übergeordneten Element.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Rückflug
Element|null: Das entfernte Element.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Legt die Attribute des Elements fest.
Der angegebene Parameter „attributes“ muss ein Objekt sein, in dem jeder Attributname ein Element in der Aufzählung DocumentApp.Attribute ist und jeder Attributwert der neue Wert ist, der angewendet werden soll.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
attributes | Object | Die Attribute des Elements. |
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