Ein generisches Element. Document
-Inhalte werden als Elemente dargestellt. Beispielsweise sind List
, Paragraph
und Table
Elemente und erben alle von Element
definierten Methoden, z. B. get
.
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 einer mathematischen Equation darstellt. |
Equation | Ein Element, das ein Funktionstrennzeichen in einer 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ßnotenabschnitt darstellt. |
Header | Ein Element, das einen Abschnitt mit einer Überschrift 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 darstellt, z. B. zu einer Drive-Datei oder einem YouTube-Video. |
Table | Ein Element, das eine Tabelle darstellt. |
Table | Ein Element, das eine Tabellenzelle darstellt. |
Table | Ein Element mit einem Inhaltsverzeichnis. |
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 Script 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 Tabellen-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 losgelöste, tiefe Kopie des aktuellen Elements zurück. |
get | Object | Ruft die Attribute des Elements ab. |
get | Element | Ruft das nächste gleichgeordnete Element des Elements ab. |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Element | Ruft das vorherige gleichgeordnete Element des Elements ab. |
get | Element | Ruft den Element des Elements ab. |
is | Boolean | Bestimmt, ob sich das Element am Ende des Document befindet. |
merge() | Element | Das Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt. |
remove | Element | Entfernt das Element aus dem übergeordneten Element. |
set | Element | Hiermit werden die Attribute des Elements festgelegt. |
Detaillierte Dokumentation
asBody()
Gibt das aktuelle Element als Body
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
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
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 werden im Apps Script-Editor bei der automatischen Vervollständigung die Methoden angezeigt, die Sie mit einer Date
verwenden können.
Rückflug
Date
: Das aktuelle Element mit dem Typ Date
.
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
asEquation()
Gibt das aktuelle Element als Equation
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Equation
: 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
asEquationFunction()
Gibt das aktuelle Element als Equation
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Equation
: 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
asEquationFunctionArgumentSeparator()
Gibt das aktuelle Element als Equation
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Equation
: 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
asEquationSymbol()
Gibt das aktuelle Element als Equation
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Equation
: 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
asFootnote()
Gibt das aktuelle Element als Footnote
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Footnote
: 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
asFootnoteSection()
Gibt das aktuelle Element als Footnote
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Footnote
: 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
asHeaderSection()
Gibt das aktuelle Element als Header
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Header
: 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
asHorizontalRule()
Gibt das aktuelle Element als Horizontal
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Horizontal
: 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
asInlineDrawing()
Gibt das aktuelle Element als Inline
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Inline
: 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
asInlineImage()
Gibt das aktuelle Element als Inline
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Inline
: 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
asListItem()
Gibt das aktuelle Element als List
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
List
: 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
asPageBreak()
Gibt das aktuelle Element als Page
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Page
: 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
asParagraph()
Gibt das aktuelle Element als Paragraph
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Paragraph
: 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
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.
Dadurch werden im Apps Script-Editor bei der automatischen Vervollständigung die Methoden angezeigt, die Sie mit einem Personenelement verwenden können.
Rückflug
Person
: Das aktuelle Element mit dem Typ Person
.
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
asRichLink()
Gibt das aktuelle Element als Rich
zurück, z. B. einen Link zu einer Google Tabellen-Datei.
Wenn Sie wissen, dass ein Element ein Rich
ist, können Sie mit dieser Methode seinen Typ als Rich
festlegen. Dadurch werden im Apps Script-Editor bei der automatischen Vervollständigung die Methoden angezeigt, die Sie mit einer Rich
verwenden können.
Rückflug
Rich
: Das aktuelle Element mit dem Typ Rich
.
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
asTable()
Gibt das aktuelle Element als Table
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Table
: 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
asTableCell()
Gibt das aktuelle Element als Table
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Table
: 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
asTableOfContents()
Gibt das aktuelle Element als Table
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Table
: 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
asTableRow()
Gibt das aktuelle Element als Table
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Table
: 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
asText()
Gibt das aktuelle Element als Text
zurück.
Verwenden Sie diese Methode, um die automatische Vervollständigung zu unterstützen, wenn ein bestimmtes Element einem bestimmten Typ zugewiesen ist.
Rückflug
Text
: 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
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
Element
– 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
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
getNextSibling()
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
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
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
: 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
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
isAtDocumentEnd()
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
merge()
Das Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
Es können nur Elemente desselben Element
zusammengeführt werden. Alle untergeordneten Elemente, die sich im aktuellen Element befinden, werden zum übergeordneten 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
– das zusammengeführte 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
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
: Das entfernte 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
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