Class Text

Text

Ein Element, das einen Rich-Text-Bereich darstellt. Der gesamte Text in einem Document-Element ist in Text-Elementen enthalten. Ein Text-Element kann in einem Equation-, EquationFunction-, ListItem- oder Paragraph-Element enthalten sein, kann aber selbst kein anderes Element enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

// Gets the body contents of the active tab.
const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Use editAsText to obtain a single text element containing
// all the characters in the tab.
const text = body.editAsText();

// Insert text at the beginning of the tab.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the tab.
text.appendText('\nAppended text.');

// Make the first half of the tab blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

Methoden

MethodeRückgabetypKurzbeschreibung
appendText(text)TextFügt den angegebenen Text am Ende dieser Textregion ein.
copy()TextGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
deleteText(startOffset, endOffsetInclusive)TextLöscht einen Textbereich.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
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.
getAttributes(offset)ObjectRuft die Attribute am angegebenen Zeichen-Offset ab.
getBackgroundColor()String|nullRuft die Einstellung für die Hintergrundfarbe ab.
getBackgroundColor(offset)String|nullRuft die Hintergrundfarbe am angegebenen Zeichen-Offset ab.
getFontFamily()String|nullRuft die Einstellung für die Schriftfamilie ab.
getFontFamily(offset)String|nullRuft die Schriftfamilie am angegebenen Zeichen-Offset ab.
getFontSize()Number|nullRuft die Einstellung für die Schriftgröße ab.
getFontSize(offset)Number|nullRuft die Schriftgröße am angegebenen Zeichen-Offset ab.
getForegroundColor()String|nullRuft die Einstellung für die Vordergrundfarbe ab.
getForegroundColor(offset)String|nullRuft die Vordergrundfarbe am angegebenen Zeichen-Offset ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getLinkUrl(offset)String|nullRuft die Link-URL am angegebenen Zeichen-Offset ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements 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.
getTextAlignment(offset)TextAlignment|nullRuft die Textausrichtung für ein einzelnes Zeichen ab.
getTextAttributeIndices()Integer[]Ruft die Gruppe von Textindizes ab, die dem Beginn der einzelnen Textformatierungsläufe entsprechen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertText(offset, text)TextFügt den angegebenen Text am angegebenen Zeichen-Offset ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
isBold()Boolean|nullRuft die Einstellung für Fettdruck ab.
isBold(offset)Boolean|nullRuft die Einstellung für Fettdruck am angegebenen Zeichen-Offset ab.
isItalic()Boolean|nullRuft die Kursiveinstellung ab.
isItalic(offset)Boolean|nullRuft die Kursiveinstellung am angegebenen Zeichen-Offset ab.
isStrikethrough()Boolean|nullRuft die Einstellung für das Durchstreichen ab.
isStrikethrough(offset)Boolean|nullRuft die Einstellung für das Durchstreichen am angegebenen Zeichen-Offset ab.
isUnderline()Boolean|nullRuft die Unterstreichungseinstellung ab.
isUnderline(offset)Boolean|nullRuft die Unterstreichungseinstellung am angegebenen Zeichen-Offset ab.
merge()Text|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()Text|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(startOffset, endOffsetInclusive, attributes)TextWendet die angegebenen Attribute auf den angegebenen Zeichenbereich an.
setAttributes(attributes)TextLegt die Attribute des Elements fest.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextLegt die Hintergrundfarbe für den angegebenen Zeichenbereich fest.
setBackgroundColor(color)TextLegt die Hintergrundfarbe fest.
setBold(bold)TextLegt die Einstellung für „Fett“ fest.
setBold(startOffset, endOffsetInclusive, bold)TextLegt die Einstellung für Fettdruck für den angegebenen Zeichenbereich fest.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextLegt die Schriftfamilie für den angegebenen Zeichenbereich fest.
setFontFamily(fontFamilyName)TextLegt die Schriftfamilie fest.
setFontSize(startOffset, endOffsetInclusive, size)TextLegt die Schriftgröße für den angegebenen Zeichenbereich fest.
setFontSize(size)TextLegt die Schriftgröße fest.
setForegroundColor(startOffset, endOffsetInclusive, color)TextLegt die Vordergrundfarbe für den angegebenen Zeichenbereich fest.
setForegroundColor(color)TextLegt die Vordergrundfarbe fest.
setItalic(italic)TextLegt die Kursiveinstellung fest.
setItalic(startOffset, endOffsetInclusive, italic)TextLegt die Kursivformatierung für den angegebenen Zeichenbereich fest.
setLinkUrl(startOffset, endOffsetInclusive, url)TextLegt die Link-URL für den angegebenen Zeichenbereich fest.
setLinkUrl(url)TextLegt die Link-URL fest.
setStrikethrough(strikethrough)TextLegt die Einstellung für den durchgestrichenen Text fest.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextLegt die Einstellung für das Durchstreichen für den angegebenen Zeichenbereich fest.
setText(text)TextLegt den Textinhalt fest.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextLegt die Textausrichtung für einen bestimmten Zeichenbereich fest.
setTextAlignment(textAlignment)TextLegt die Textausrichtung fest.
setUnderline(underline)TextLegt die Unterstreichungseinstellung fest.
setUnderline(startOffset, endOffsetInclusive, underline)TextLegt die Unterstreichungseinstellung für den angegebenen Zeichenbereich fest.

Detaillierte Dokumentation

appendText(text)

Fügt den angegebenen Text am Ende dieser Textregion ein.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds the text, 'Sample body text,' to the end of the tab body.
const text = body.editAsText().appendText('Sample body text');

Parameter

NameTypBeschreibung
textStringDer anzufügende Text.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

copy()

Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.

Alle untergeordneten Elemente des Elements werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Rückflug

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

deleteText(startOffset, endOffsetInclusive)

Löscht einen Textbereich.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Deletes the first 10 characters in the body.
const text = body.editAsText().deleteText(0, 9);

Parameter

NameTypBeschreibung
startOffsetIntegerDer Zeichen-Offset des ersten zu löschenden Zeichens.
endOffsetInclusiveIntegerDer Zeichen-Offset des letzten zu löschenden Zeichens.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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


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

getAttributes(offset)

Ruft die Attribute am angegebenen Zeichen-Offset ab.

Das Ergebnis ist ein Objekt, das für jedes gültige Textattribut ein Attribut enthält. Jeder Attributname entspricht einem Element in der DocumentApp.Attribute-Aufzählung.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes.
const style = {};
style[DocumentApp.Attribute.BOLD] = true;
style[DocumentApp.Attribute.ITALIC] = true;
style[DocumentApp.Attribute.FONT_SIZE] = 29;

// Sets the style attributes to the tab's body.
const text = body.editAsText();
text.setAttributes(style);

// Gets the style attributes applied to the eleventh character in the
// body and logs them to the console.
const attributes = text.getAttributes(10);
console.log(attributes);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

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

getBackgroundColor()

Ruft die Einstellung für die Hintergrundfarbe ab.

Rückflug

String|null: Die Hintergrundfarbe im CSS-Format (z. B. '#ffffff') 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

getBackgroundColor(offset)

Ruft die Hintergrundfarbe am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the body.
const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB');

// Gets the background color of the first character in the body.
const backgroundColor = text.getBackgroundColor(0);

// Logs the background color to the console.
console.log(backgroundColor);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

String|null: Die Hintergrundfarbe im CSS-Format (z. B. '#ffffff').

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

getFontFamily()

Ruft die Einstellung für die Schriftfamilie ab. Der Name kann eine beliebige Schriftart aus dem Menü „Schriftart“ in Docs oder Google Fonts sein. Dabei wird zwischen Groß- und Kleinschreibung unterschieden. Für die Methoden getFontFamily() und setFontFamily(fontFamilyName) werden jetzt String-Namen für Schriftarten anstelle des FontFamily-Enums verwendet. Dieses Enum ist zwar veraltet, bleibt aber zur Kompatibilität mit älteren Skripts verfügbar.

Rückflug

String|null: die Schriftfamilie 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

getFontFamily(offset)

Ruft die Schriftfamilie am angegebenen Zeichen-Offset ab. Der Name kann eine beliebige Schriftart aus dem Menü „Schriftart“ in Docs oder Google Fonts sein und muss in der richtigen Groß- und Kleinschreibung angegeben werden. Für die Methoden getFontFamily() und setFontFamily(fontFamilyName) werden jetzt String-Namen für Schriftarten anstelle des FontFamily-Enums verwendet. Dieses Enum ist zwar veraltet, bleibt aber zur Kompatibilität mit älteren Skripts verfügbar.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 16 characters to Impact.
const text = body.editAsText().setFontFamily(0, 15, 'Impact');

// Gets the font family of the 16th character in the tab body.
const fontFamily = text.getFontFamily(15);

// Logs the font family to the console.
console.log(fontFamily);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

String|null – Die Schriftfamilie.

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

getFontSize()

Ruft die Einstellung für die Schriftgröße ab.

Rückflug

Number|null: die Schriftgröße 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

getFontSize(offset)

Ruft die Schriftgröße am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font size of the first 13 characters to 15.
const text = body.editAsText().setFontSize(0, 12, 15);

// Gets the font size of the first character.
const fontSize = text.getFontSize(0);

// Logs the font size to the console.
console.log(fontSize);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

Number|null: Die Schriftgröße.

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

getForegroundColor()

Ruft die Einstellung für die Vordergrundfarbe ab.

Rückflug

String|null: Die Vordergrundfarbe im CSS-Format (z. B. '#ffffff') 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

getForegroundColor(offset)

Ruft die Vordergrundfarbe am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 3 characters in the tab body.
const text = body.editAsText().setForegroundColor(0, 2, '#0000FF');

// Gets the foreground color of the first character in the tab body.
const foregroundColor = text.getForegroundColor(0);

// Logs the foreground color to the console.
console.log(foregroundColor);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

String|null: Die Vordergrundfarbe, formatiert in CSS-Notation (z. B. '#ffffff').

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

getLinkUrl(offset)

Ruft die Link-URL am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 10 characters in the body.
const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/');

// Gets the URL of the link from the first character.
const link = text.getLinkUrl(0);

// Logs the link URL to the console.
console.log(link);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

String|null: Die Link-URL.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getNextSibling()

Ruft das nächste gleichgeordnete Element des Elements ab.

Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt auf das aktuelle Element.

Rückflug

Element|null: Das nächste gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getParent()

Ruft das übergeordnete Element des Elements ab.

Das übergeordnete Element enthält das aktuelle Element.

Rückflug

ContainerElement|null: Das übergeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getPreviousSibling()

Ruft das vorherige gleichgeordnete Element des Elements ab.

Das vorherige gleichgeordnete Element hat dasselbe übergeordnete Element und geht dem aktuellen Element voraus.

Rückflug

Element|null: Das vorherige gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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: Der Typ 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

getTextAlignment(offset)

Ruft die Textausrichtung für ein einzelnes Zeichen ab. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the text alignment of the tab's body to NORMAL.
const text =
    body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL);

// Gets the text alignment of the ninth character.
const alignment = text.getTextAlignment(8);

// Logs the text alignment to the console.
console.log(alignment.toString());

Parameter

NameTypBeschreibung
offsetIntegerDer Offset des Zeichens.

Rückflug

TextAlignment|null – Der Typ der Textausrichtung oder null, wenn 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

getTextAttributeIndices()

Ruft die Gruppe von Textindizes ab, die dem Beginn der einzelnen Textformatierungsläufe entsprechen.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text indices at which text formatting changes.
const indices = body.editAsText().getTextAttributeIndices();

// Logs the indices to the console.
console.log(indices.toString());

Rückflug

Integer[]: Die Menge der Textindizes, an denen sich die Textformatierung ändert.

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

insertText(offset, text)

Fügt den angegebenen Text am angegebenen Zeichen-Offset ein.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Inserts the text, 'Sample inserted text', at the start of the body content.
const text = body.editAsText().insertText(0, 'Sample inserted text');

Parameter

NameTypBeschreibung
offsetIntegerDas Zeichen-Offset, an dem der Text eingefügt werden soll.
textStringDer einzufügende Text.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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

isBold()

Ruft die Einstellung für Fettdruck ab.

Rückflug

Boolean|null: Gibt an, ob der Text fett formatiert ist. Ist 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

isBold(offset)

Ruft die Einstellung für Fettdruck am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Bolds the first 4 characters in the tab body.
const text = body.editAsText().setBold(0, 3, true);

// Gets whether or not the text is bold.
const bold = text.editAsText().isBold(0);

// Logs the text's bold setting to the console
console.log(bold);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

Boolean|null: Die Einstellung für Fettdruck.

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

isItalic()

Ruft die Kursiveinstellung ab.

Rückflug

Boolean|null: Gibt an, ob der Text kursiv ist. Ist das Element mit mehreren Werten für dieses Attribut belegt, wird „null“ zurückgegeben.

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

isItalic(offset)

Ruft die Kursiveinstellung am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to italic.
const text = body.editAsText().setItalic(0, 12, true);

// Gets whether the fifth character in the tab body is set to
// italic and logs it to the console.
const italic = text.isItalic(4);
console.log(italic);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

Boolean|null – Die Einstellung für Kursivschrift.

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

isStrikethrough()

Ruft die Einstellung für das Durchstreichen ab.

Rückflug

Boolean|null: Gibt an, ob der Text durchgestrichen ist. Ist „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

isStrikethrough(offset)

Ruft die Einstellung für das Durchstreichen am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 17 characters of the tab body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 16, true);

// Gets whether the first character in the tab body is set to
// strikethrough and logs it to the console.
const strikethrough = text.isStrikethrough(0);
console.log(strikethrough);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

Boolean|null – Die Einstellung für das Durchstreichen.

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

isUnderline()

Ruft die Unterstreichungseinstellung ab.

Rückflug

Boolean|null: Gibt an, ob der Text unterstrichen ist. Ist „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

isUnderline(offset)

Ruft die Unterstreichungseinstellung am angegebenen Zeichen-Offset ab.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to underline.
const text = body.editAsText().setUnderline(0, 12, false);

// Gets whether the first character in the tab body is set to
// underline and logs it to the console
const underline = text.editAsText().isUnderline(0);
console.log(underline);

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichen-Offset.

Rückflug

Boolean|null – die Einstellung für die Unterstreichung.

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

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

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

Das bereitgestellte 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(startOffset, endOffsetInclusive, attributes)

Wendet die angegebenen Attribute auf den angegebenen Zeichenbereich an.

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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes for font size and font family.
const style = {};
style[DocumentApp.Attribute.FONT_SIZE] = 20;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact';

// Sets the style attributes to the first 9 characters in the tab's body.
const text = body.setAttributes(0, 8, style);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
attributesObjectDie Attribute des Elements.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setBackgroundColor(startOffset, endOffsetInclusive, color)

Legt die Hintergrundfarbe für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the
// tab body to hex color #0000FF.
const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
colorStringDie Hintergrundfarbe im CSS-Format (z. B. '#ffffff').

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setBackgroundColor(color)

Legt die Hintergrundfarbe fest.

Parameter

NameTypBeschreibung
colorStringDie Hintergrundfarbe im CSS-Format (z. B. '#ffffff')

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setBold(bold)

Legt die Einstellung für „Fett“ fest.

Parameter

NameTypBeschreibung
boldBooleandie Einstellung für Fettdruck

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setBold(startOffset, endOffsetInclusive, bold)

Legt die Einstellung für Fettdruck für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to bold.
const text = body.editAsText().setBold(0, 10, true);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
boldBooleanDie Einstellung „Fett“.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

Legt die Schriftfamilie für den angegebenen Zeichenbereich fest. Der Name kann eine beliebige Schriftart aus dem Menü „Schriftart“ in Docs oder Google Fonts sein. Dabei wird zwischen Groß- und Kleinschreibung unterschieden. Nicht erkannte Schriftartnamen werden als Arial gerendert. Für die Methoden getFontFamily(offset) und setFontFamily(fontFamilyName) werden jetzt String-Namen für Schriftarten anstelle des FontFamily-Enums verwendet. Dieses Enum ist zwar veraltet, bleibt aber zur Kompatibilität mit älteren Skripts verfügbar.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 4 characters in the tab's body to Roboto.
const text = body.editAsText().setFontFamily(0, 3, 'Roboto');

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
fontFamilyNameStringDer Name der Schriftfamilie aus dem Menü „Schriftart“ in Docs oder aus Google Fonts.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFontFamily(fontFamilyName)

Legt die Schriftfamilie fest. Der Name kann eine beliebige Schriftart aus dem Menü „Schriftart“ in Docs oder Google Fonts sein. Dabei wird zwischen Groß- und Kleinschreibung unterschieden. Nicht erkannte Schriftartnamen werden als Arial gerendert. Für die Methoden getFontFamily() und setFontFamily(fontFamilyName) werden jetzt String-Namen für Schriftarten anstelle des FontFamily-Enums verwendet. Dieses Enum ist zwar veraltet, bleibt aber zur Kompatibilität mit älteren Skripts verfügbar.

Parameter

NameTypBeschreibung
fontFamilyNameStringden Namen der Schriftfamilie aus dem Schriftartmenü in Docs oder aus Google Fonts

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFontSize(startOffset, endOffsetInclusive, size)

Legt die Schriftgröße für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the size of the first 11 characters in the tab's body to 12.
const text = body.editAsText().setFontSize(0, 10, 12);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
sizeNumberDie Schriftgröße.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFontSize(size)

Legt die Schriftgröße fest.

Parameter

NameTypBeschreibung
sizeNumberSchriftgröße

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setForegroundColor(startOffset, endOffsetInclusive, color)

Legt die Vordergrundfarbe für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 2 characters in the
// tab's body to hex color #FF0000.
const text = body.editAsText().setForegroundColor(0, 1, '#FF0000');

// Gets the foreground color for the second character in the tab's body.
const foregroundColor = text.getForegroundColor(1);

//  Logs the foreground color to the console.
console.log(foregroundColor);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
colorStringDie Vordergrundfarbe, formatiert in CSS-Notation (z. B. '#ffffff').

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setForegroundColor(color)

Legt die Vordergrundfarbe fest.

Parameter

NameTypBeschreibung
colorStringdie Vordergrundfarbe im CSS-Format (z. B. '#ffffff')

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setItalic(italic)

Legt die Kursiveinstellung fest.

Parameter

NameTypBeschreibung
italicBooleandie Kursiveinstellung

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setItalic(startOffset, endOffsetInclusive, italic)

Legt die Kursivformatierung für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to italic.
const text = body.editAsText().setItalic(0, 10, true);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
italicBooleanDie Kursiveinstellung.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setLinkUrl(startOffset, endOffsetInclusive, url)

Legt die Link-URL für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 11 characters in the body.
const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
urlStringDie Link-URL

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setLinkUrl(url)

Legt die Link-URL fest.

Parameter

NameTypBeschreibung
urlStringdie Link-URL

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setStrikethrough(strikethrough)

Legt die Einstellung für den durchgestrichenen Text fest.

Parameter

NameTypBeschreibung
strikethroughBooleandie Einstellung für das Durchstreichen

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

Legt die Einstellung für das Durchstreichen für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 10, true);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
strikethroughBooleanDie Einstellung „Durchgestrichen“.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setText(text)

Legt den Textinhalt fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Replaces the contents of the body with the text, 'New body text.'
const text = body.editAsText().setText('New body text.');

Parameter

NameTypBeschreibung
textStringDer neue Textinhalt.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setTextAlignment(startOffset, endOffsetInclusive, textAlignment)

Legt die Textausrichtung für einen bestimmten Zeichenbereich fest. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

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

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Zeichenbereichs.
endOffsetInclusiveIntegerDer End-Offset des Zeichenbereichs (einschließlich).
textAlignmentTextAlignmentDer Typ der anzuwendenden Textausrichtung.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setUnderline(underline)

Legt die Unterstreichungseinstellung fest.

Parameter

NameTypBeschreibung
underlineBooleandie Unterstreichungseinstellung

Rückflug

Text – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setUnderline(startOffset, endOffsetInclusive, underline)

Legt die Unterstreichungseinstellung für den angegebenen Zeichenbereich fest.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to underline.
const text = body.editAsText().setUnderline(0, 10, true);

Parameter

NameTypBeschreibung
startOffsetIntegerDie Startabweichung des Textbereichs.
endOffsetInclusiveIntegerDer End-Offset des Textbereichs.
underlineBooleanDie Unterstreichungseinstellung.

Rückflug

Text: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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