Class HeaderSection

Erstellt und hängt einen neuen HorizontalRule an.

Die HorizontalRule wird in einem neuen Paragraph enthalten sein.

Rückflug

HorizontalRule: 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

Erstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob an.

Das Bild wird in einer neuen Paragraph gespeichert.

Parameter

Rückflug

InlineImage: 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

Hängt die angegebene InlineImage an.

Die InlineImage wird in einem neuen Paragraph enthalten sein.

Verwenden Sie diese Version von appendImage, wenn Sie eine Kopie einer vorhandenen InlineImage anhängen.

Parameter

Rückflug

InlineImage: 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

Hängt die angegebene ListItem an.

Verwenden Sie diese Version von appendListItem, wenn Sie eine Kopie einer vorhandenen ListItem anhängen.

Parameter

Rückflug

ListItem: 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

Erstellt und hängt eine neue ListItem mit dem angegebenen Textinhalt an.

Nachfolgende Listenelemente werden als Teil derselben Liste hinzugefügt.

Parameter

Rückflug

ListItem: 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

Hängt die angegebene Paragraph an.

Verwenden Sie diese Version von appendParagraph, wenn Sie eine Kopie einer vorhandenen Paragraph anhängen.

Parameter

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

Erstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.

Parameter

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

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

Hängt für jeden angegebenen Stringwert eine neue Table mit einer TableCell 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

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

Hängt die angegebene Table an.

Verwenden Sie diese Version von appendTable, 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

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

Der Inhalt des Elements wird gelöscht.

Rückflug

HeaderSection: Das aktuelle Element.

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

HeaderSection – 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

Ruft eine Text-Version des aktuellen Elements zur Bearbeitung ab.

Verwenden Sie editAsText, um den Inhalt des Elements als Rich-Text zu bearbeiten. Im editAsText-Modus werden nicht textbasierte Elemente wie InlineImage und HorizontalRule 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

Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.

Parameter

Rückflug

RangeElement: 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

Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.

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

Rückflug

RangeElement: 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

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

Rückflug

RangeElement: 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

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

Rückflug

RangeElement: 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

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 DocumentApp.Attribute-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

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

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

Ruft den untergeordneten Index für das angegebene untergeordnete Element ab.

Parameter

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

Hiermit werden alle InlineImages im Abschnitt abgerufen.

Rückflug

InlineImage[] – 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

Hiermit werden alle ListItems im Abschnitt abgerufen.

Rückflug

ListItem[]: 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

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

Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.

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

Ruft das übergeordnete Element des Elements ab.

Das übergeordnete Element enthält das aktuelle Element.

Rückflug

ContainerElement: 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

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

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

Die Textausrichtung wird abgerufen. Verfügbare Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

Rückflug

TextAlignment – 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

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Erstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.

Die HorizontalRule wird in einem neuen Paragraph enthalten sein.

Parameter

Rückflug

HorizontalRule: 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

Erstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.

Parameter

Rückflug

InlineImage: 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

Fügt das angegebene InlineImage an der angegebenen Position ein.

Das Bild wird in einer neuen Paragraph gespeichert.

Parameter

Rückflug

InlineImage: 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

Fügt das angegebene ListItem an der angegebenen Position ein.

Parameter

Rückflug

ListItem: 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

Erstellt und fügt am angegebenen Index eine neue ListItem mit dem angegebenen Textinhalt ein.

Parameter

Rückflug

ListItem: 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

Fügt das angegebene Paragraph an der angegebenen Position ein.

Parameter

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

Erstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.

Parameter

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

Erstellt und fügt eine neue Table an der angegebenen Position ein.

Parameter

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

Erstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.

Parameter

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

Fügt das angegebene Table an der angegebenen Position ein.

Parameter

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

Entfernt das angegebene untergeordnete Element.

Parameter

Rückflug

HeaderSection: 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

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

HeaderSection: 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

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

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

Hiermit werden die Attribute des Elements festgelegt.

Der angegebene Attributparameter muss ein Objekt sein, bei 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

Rückflug

HeaderSection: 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

Der Inhalt wird als Nur-Text festgelegt.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

Rückflug

HeaderSection: 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

Hiermit wird die Textausrichtung festgelegt. Verfügbare Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

// 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

Rückflug

HeaderSection – 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