Class ContainerElement

ContainerElement

Ein allgemeines Element, das andere Elemente enthalten kann. Alle Elemente, die untergeordnete Elemente enthalten können, z. B. Paragraph, werden von ContainerElement abgeleitet.

Methoden

MethodeRückgabetypKurzbeschreibung
asBody()BodyGibt das aktuelle Element als Body zurück.
asEquation()EquationGibt das aktuelle Element als Equation zurück.
asFooterSection()FooterSectionGibt das aktuelle Element als FooterSection zurück.
asFootnoteSection()FootnoteSectionGibt das aktuelle Element als FootnoteSection zurück.
asHeaderSection()HeaderSectionGibt das aktuelle Element als HeaderSection zurück.
asListItem()ListItemGibt das aktuelle Element als ListItem zurück.
asParagraph()ParagraphGibt das aktuelle Element als Paragraph zurück.
asTable()TableGibt das aktuelle Element als Table zurück.
asTableCell()TableCellGibt das aktuelle Element als TableCell zurück.
asTableOfContents()TableOfContentsGibt das aktuelle Element als TableOfContents zurück.
asTableRow()TableRowGibt das aktuelle Element als TableRow zurück.
clear()ContainerElementLöscht den Inhalt des Elements.
copy()ContainerElementGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()ContainerElement|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()ContainerElement|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)ContainerElementLegt die Attribute des Elements fest.
setLinkUrl(url)ContainerElementLegt die Link-URL fest.
setTextAlignment(textAlignment)ContainerElementLegt die Textausrichtung 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

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

asFooterSection()

Gibt das aktuelle Element als FooterSection zurück.

Mit dieser Methode können Sie die automatische Vervollständigung unterstützen, wenn ein bestimmtes Element einen bestimmten Typ hat.

Rückflug

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

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

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

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

clear()

Löscht den Inhalt des Elements.

Rückflug

ContainerElement: Das aktuelle Element.

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

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

editAsText()

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

Verwenden Sie editAsText, um den Inhalt der Elemente 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

findElement(elementType)

Durchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.

Parameter

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll.

Rückflug

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

findElement(elementType, from)

Durchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs, beginnend mit dem 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

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll.
fromRangeElementDas Suchergebnis, von dem aus gesucht werden soll.

Rückflug

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

findText(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 angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll

Rückflug

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

findText(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 angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, von dem aus gesucht werden soll

Rückflug

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

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

getChild(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

NameTypBeschreibung
childIndexIntegerDer 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

getChildIndex(child)

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

Parameter

NameTypBeschreibung
childElementDas 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

getLinkUrl()

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

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

getNumChildren()

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

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

getText()

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

getTextAlignment()

Gibt die Textausrichtung zurück. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

Rückflug

TextAlignment|null: Die Art 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

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

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

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

replaceText(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 Bibliothek für reguläre Ausdrücke RE2 von Google verwendet, wodurch die unterstützte Syntax eingeschränkt wird.

Das angegebene 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

NameTypBeschreibung
searchPatternStringDas Regex-Muster, nach dem gesucht werden soll
replacementStringden 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

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

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückflug

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

setLinkUrl(url)

Legt die Link-URL fest.

Parameter

NameTypBeschreibung
urlStringdie Link-URL

Rückflug

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

setTextAlignment(textAlignment)

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.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NameTypBeschreibung
textAlignmentTextAlignmentdie Art der anzuwendenden Textausrichtung

Rückflug

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