Class HeaderSection

Erstellt eine neue HorizontalRule und hängt sie an.

HorizontalRule wird in einer neuen Paragraph enthalten.

Rückflug

HorizontalRule: Die neue horizontale Regel.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.

Das Bild wird in einem neuen Paragraph enthalten.

Parameter

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Hängt die angegebene InlineImage an.

InlineImage wird in einer neuen Paragraph enthalten.

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

Parameter

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält.

Aufeinanderfolgende Listenelemente werden als Teil derselben Liste hinzugefügt.

Parameter

Rückflug

ListItem: Der neue Listeneintrag.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.

Parameter

Rückflug

Paragraph: Der neue Absatz.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue Table und hängt sie an.

Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente darf nicht mit einer Tabelle enden.

Rückflug

Table: Die neue Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Hängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält.

Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente darf nicht mit einer Tabelle enden.

Parameter

Rückflug

Table: Die angehängte Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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. Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente darf nicht mit einer Tabelle enden.

Parameter

Rückflug

Table: Die angehängte Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Löscht den Inhalt des Elements.

Rückflug

HeaderSection: Das aktuelle Element.

Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.

Alle im Element vorhandenen untergeordneten Elemente werden ebenfalls kopiert. Das neue Element hat kein Parent.

Rückflug

HeaderSection: Die neue Kopie.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 der Elemente als RTF zu bearbeiten. Im Modus editAsText werden Nicht-Textelemente wie InlineImage und HorizontalRule ignoriert.

Untergeordnete Elemente, die vollständig in einem gelöschten Textbereich enthalten sind, werden aus dem Element entfernt.

var 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

Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.

Parameter

Rückflug

RangeElement: Ein Suchergebnis, das die Position des Suchelements angibt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parameter

Rückflug

RangeElement: Ein Suchergebnis, das die nächste Position des Suchelements angibt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.

Einige der JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt. Dazu gehören: Erfassungsgruppen und Modusmodifikatoren.

Das angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock abgeglichen die im aktuellen Element enthalten sind.

Parameter

Rückflug

RangeElement: ein Suchergebnis, das die Position des Suchtexts angibt, oder null, wenn kein Übereinstimmung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.

Einige der JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt. Dazu gehören: Erfassungsgruppen und Modusmodifikatoren.

Das angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock abgeglichen die im aktuellen Element enthalten sind.

Parameter

Rückflug

RangeElement: ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder null, wenn kein Übereinstimmung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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, das eine -Eigenschaft für jedes gültige Elementattribut enthält, wobei jeder Eigenschaftsname entspricht einem Element in der DocumentApp.Attribute-Aufzählung.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Rückflug

Object: Die Attribute des Elements.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft das untergeordnete Element im angegebenen untergeordneten Index ab.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
var 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 beim angegebenen Index.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft alle im Abschnitt enthaltenen InlineImages ab.

Rückflug

InlineImage[]: Die Abschnittsbilder.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft alle im Abschnitt enthaltenen ListItems ab.

Rückflug

ListItem[]: Elemente der Abschnittsliste.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft die Anzahl der untergeordneten Elemente ab.

var 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).

Rückflug

Paragraph[]: Abschnittsabschnitte.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft alle im Abschnitt enthaltenen Tables ab.

Rückflug

Table[]: Die Abschnittstabellen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft die Textausrichtung ab. Die verfügbaren 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 Arten von Text enthält oder wenn die Textausrichtung noch nie

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Ruft den ElementType des Elements ab.

Verwenden Sie getType(), um den genauen Typ eines bestimmten Elements zu bestimmen.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's body.

var 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein.

HorizontalRule wird in einer neuen Paragraph enthalten.

Parameter

Rückflug

HorizontalRule: Die neue horizontale Regel.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.

Parameter

Rückflug

InlineImage: Das eingefügte Inline-Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Fügt den angegebenen InlineImage im angegebenen Index ein.

Das Bild wird in einem neuen Paragraph enthalten.

Parameter

Rückflug

InlineImage: Das eingefügte Inline-Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Fügt den angegebenen ListItem im angegebenen Index ein.

Parameter

Rückflug

ListItem: Der eingefügte Listeneintrag.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.

Parameter

Rückflug

ListItem: Der neue Listeneintrag.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Fügt den angegebenen Paragraph im angegebenen Index ein.

Parameter

Rückflug

Paragraph: Der eingefügte Absatz.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.

Parameter

Rückflug

Paragraph: Der neue Absatz.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue Table und fügt sie im angegebenen Index ein.

Parameter

Rückflug

Table: Die neue Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Erstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.

Parameter

Rückflug

Table: Die neue Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Fügt den angegebenen Table im angegebenen Index ein.

Parameter

Rückflug

Table: Die eingefügte Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Entfernt das Element aus dem übergeordneten Element.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Rückflug

HeaderSection: Das entfernte Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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, wobei die reguläre Ausdrücke.

Das Suchmuster wird als String übergeben, nicht als JavaScript-Objekt für reguläre Ausdrücke. Daher müssen Sie alle umgekehrten Schrägstriche im Muster mit Escapezeichen versehen.

Bei dieser Methode wird das reguläre RE2-Protokoll von Google Ausdrucksbibliothek, die die unterstützte Syntax einschränkt.

Das angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock abgeglichen die im aktuellen Element enthalten sind.

var 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Legt die Attribute des Elements fest.

Der angegebene Attributparameter muss ein Objekt sein, in dem jeder Eigenschaftsname ein Element in DocumentApp.Attribute und jeder Attributwert ist der neue Wert, angewendet.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

Rückflug

HeaderSection: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Legt den Inhalt als Nur-Text fest.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

Rückflug

HeaderSection: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Legt die Textausrichtung fest. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

Rückflug

HeaderSection – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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