Class Text

Text

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

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

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

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

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

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

Methoden

MethodeRückgabetypKurzbeschreibung
appendText(text)TextFügt den angegebenen Text am Ende dieses Textbereichs hinzu.
copy()TextGibt eine getrennte, tiefe 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)RangeElementSucht mithilfe von regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementEs wird in den Inhalten des Elements nach dem angegebenen Textmuster gesucht, ausgehend von einem bestimmten Suchergebnis.
getAttributes()ObjectRuft die Attribute des Elements ab.
getAttributes(offset)ObjectRuft die Attribute mit dem angegebenen Zeichenversatz ab.
getBackgroundColor()StringRuft die Einstellung für die Hintergrundfarbe ab.
getBackgroundColor(offset)StringRuft die Hintergrundfarbe bei dem angegebenen Zeichenversatz ab.
getFontFamily()StringRuft die Schriftfamilieneinstellung ab.
getFontFamily(offset)StringRuft die Schriftfamilie mit dem angegebenen Zeichenversatz ab.
getFontSize()NumberRuft die Einstellung für die Schriftgröße ab.
getFontSize(offset)NumberRuft die Schriftgröße mit dem angegebenen Zeichenversatz ab.
getForegroundColor()StringRuft die Vordergrundfarbeinstellung ab.
getForegroundColor(offset)StringRuft die Vordergrundfarbe beim angegebenen Zeichenversatz ab.
getLinkUrl()StringRuft die Link-URL ab.
getLinkUrl(offset)StringRuft die Link-URL mit dem angegebenen Zeichenversatz ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getTextAlignment(offset)TextAlignmentRuft die Textausrichtung für ein einzelnes Zeichen ab.
getTextAttributeIndices()Integer[]Ruft den Satz von Textindexen ab, die dem Start unterschiedlicher Textformatierungsausführungen entsprechen.
getType()ElementTypeRuft die ElementType des Elements ab.
insertText(offset, text)TextFügt den angegebenen Text mit dem angegebenen Zeichenversatz ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
isBold()BooleanRuft die Fetteinstellung ab.
isBold(offset)BooleanRuft die Fetteinstellung mit dem angegebenen Zeichenversatz ab.
isItalic()BooleanRuft die Kursiveinstellung ab.
isItalic(offset)BooleanRuft die Kursivformatierung bei dem angegebenen Zeichenversatz ab.
isStrikethrough()BooleanRuft die Einstellung für das Durchstreichen ab.
isStrikethrough(offset)BooleanRuft die Einstellung für das Durchgestrichen mit dem angegebenen Zeichenversatz ab.
isUnderline()BooleanRuft die Unterstrichen-Einstellung ab.
isUnderline(offset)BooleanRuft die Unterstreichung mit dem angegebenen Zeichenversatz ab.
merge()TextFührt das Element mit dem gleichgeordneten Element desselben Typs zusammen.
removeFromParent()TextEntfernt das Element aus seinem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt mithilfe von regulären Ausdrücken alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring.
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 Fetteinstellung fest.
setBold(startOffset, endOffsetInclusive, bold)TextLegt die Fetteinstellung 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 Kursivformatierung fest.
setItalic(startOffset, endOffsetInclusive, italic)TextLegt die Kursiveinstellung 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 „Durchgestrichen“ fest.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextLegt die Einstellung 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 Unterstreichung fest.
setUnderline(startOffset, endOffsetInclusive, underline)TextLegt die Unterstreichung für den angegebenen Zeichenbereich fest.

Detaillierte Dokumentation

appendText(text)

Fügt den angegebenen Text am Ende dieses Textbereichs hinzu.

// 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
textStringDer Text, der angefügt werden soll.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

copy()

Gibt eine getrennte, tiefe Kopie des aktuellen Elements zurück.

Alle untergeordneten Elemente, die im Element vorhanden sind, werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Zurücksenden

Text: Die neue Kopie.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Zeichenversatz des ersten zu löschenden Zeichens.
endOffsetInclusiveIntegerDer Zeichenversatz des letzten zu löschenden Zeichens.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

editAsText()

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

Mit editAsText kannst du den Inhalt der Elemente als RTF bearbeiten. Im editAsText-Modus werden Nicht-Textelemente ignoriert, z. B. InlineImage und HorizontalRule.

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

var body = DocumentApp.getActiveDocument().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);

Zurücksenden

Text: eine Textversion des aktuellen Elements


findText(searchPattern)

Sucht mithilfe von regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster.

Einige Funktionen von regulären JavaScript-Ausdrücken werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modifikatoren.

Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock abgeglichen, der im aktuellen Element enthalten ist.

Parameter

NameTypBeschreibung
searchPatternStringMuster für die Suche nach

Zurücksenden

RangeElement: ein Suchergebnis, das die Position des Suchtextes angibt, oder null, wenn es keine Übereinstimmung gibt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

findText(searchPattern, from)

Es wird in den Inhalten des Elements nach dem angegebenen Textmuster gesucht, ausgehend von einem bestimmten Suchergebnis.

Einige Funktionen von regulären JavaScript-Ausdrücken werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modifikatoren.

Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock abgeglichen, der im aktuellen Element enthalten ist.

Parameter

NameTypBeschreibung
searchPatternStringMuster für die Suche nach
fromRangeElementdas Suchergebnis, von dem aus gesucht wird

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 ein Attribut für jedes gültige Elementattribut enthält, wobei jeder Attributname einem Element in der Aufzählung DocumentApp.Attribute entspricht.

var body = DocumentApp.getActiveDocument().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]);
}

Zurücksenden

Object: Die Attribute des Elements.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getAttributes(offset)

Ruft die Attribute mit dem angegebenen Zeichenversatz ab.

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

// 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/abc123456/edit');

// Gets the document body.
const body = doc.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 document 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 Zeichenversatz.

Zurücksenden

Object: Die Attribute des Elements.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getBackgroundColor()

Ruft die Einstellung für die Hintergrundfarbe ab.

Zurücksenden

String: die Hintergrundfarbe, die in CSS-Notation (z. B. '#ffffff') formatiert ist, oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getBackgroundColor(offset)

Ruft die Hintergrundfarbe bei dem angegebenen Zeichenversatz 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/abc123456');

// Gets the document body.
const body = doc.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 Zeichenversatz.

Zurücksenden

String: Die Hintergrundfarbe in CSS-Notation (z. B. '#ffffff').

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFontFamily()

Ruft die Schriftfamilieneinstellung ab. Der Name kann eine beliebige Schriftart aus dem Menü „Schriftart“ in Google Docs oder Google Fonts sein und die Groß- und Kleinschreibung wird berücksichtigt. Die Methoden getFontFamily() und setFontFamily(fontFamilyName) verwenden jetzt Stringnamen für Schriftarten anstelle der Aufzählung FontFamily. Diese Aufzählung ist zwar veraltet, bleibt aber für die Kompatibilität mit älteren Skripts verfügbar.

Zurücksenden

String: die Schriftfamilie oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFontFamily(offset)

Ruft die Schriftfamilie mit dem angegebenen Zeichenversatz ab. Der Name kann eine beliebige Schriftart aus dem Menü „Schriftart“ in Google Docs oder Google Fonts sein. Die Groß- und Kleinschreibung wird berücksichtigt. Die Methoden getFontFamily() und setFontFamily(fontFamilyName) verwenden jetzt Stringnamen für Schriftarten anstelle der Aufzählung FontFamily. Diese Aufzählung ist zwar veraltet, bleibt aber für die 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/abc123456/edit');

// Gets the document body.
const body = doc.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 document body.
const fontFamily = text.getFontFamily(15);

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

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichenversatz.

Zurücksenden

String: Die Schriftfamilie.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFontSize()

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

Zurücksenden

Number: die Schriftgröße oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFontSize(offset)

Ruft die Schriftgröße mit dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.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 Zeichenversatz.

Zurücksenden

Number: Die Schriftgröße.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getForegroundColor()

Ruft die Vordergrundfarbeinstellung ab.

Zurücksenden

String: die Vordergrundfarbe, die in CSS-Notation wie '#ffffff' formatiert ist, oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getForegroundColor(offset)

Ruft die Vordergrundfarbe beim angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

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

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichenversatz.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getLinkUrl()

Ruft die Link-URL ab.

Zurücksenden

String: Die Link-URL oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getLinkUrl(offset)

Ruft die Link-URL mit dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.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 Zeichenversatz.

Zurücksenden

String: Die Link-URL.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getNextSibling()

Ruft das nächste gleichgeordnete Element des Elements ab.

Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt dem aktuellen Element.

Zurücksenden

Element: Das nächste gleichgeordnete Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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.

Zurücksenden

ContainerElement: Das übergeordnete Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 steht vor dem aktuellen Element.

Zurücksenden

Element: das vorherige gleichgeordnete Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getText()

Ruft den Inhalt des Elements als Textstring ab.

Zurücksenden

String: der Inhalt des Elements als Textstring

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getTextAlignment()

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

Zurücksenden

TextAlignment: der Typ der Textausrichtung oder null, wenn der Text mehrere Arten von Textausrichtungen enthält oder wenn die Textausrichtung nie festgelegt wurde

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

// Sets the text alignment of the document 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.

Zurücksenden

TextAlignment: Der Typ der Textausrichtung oder null, wenn die Textausrichtung noch nicht festgelegt wurde.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getTextAttributeIndices()

Ruft den Satz von Textindexen ab, die dem Start unterschiedlicher Textformatierungsausführungen 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/abc123456/edit');

// Gets the document body.
const body = doc.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());

Zurücksenden

Integer[]: Die Gruppe der Textindizes, bei der sich die Textformatierung ändert.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getType()

Ruft die ElementType des Elements ab.

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

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

// Obtain the first element in the document 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.');
}

Zurücksenden

ElementType: Der Elementtyp.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

insertText(offset, text)

Fügt den angegebenen Text mit dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.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
offsetIntegerDer Zeichenversatz, an dem der Text eingefügt werden soll.
textStringDer einzufügende Text.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isAtDocumentEnd()

Bestimmt, ob sich das Element am Ende von Document befindet.

Zurücksenden

Boolean: gibt an, ob sich das Element am Ende des Dokuments befindet

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isBold()

Ruft die Fetteinstellung ab.

Zurücksenden

Boolean: gibt an, ob der Text fett ist, oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isBold(offset)

Ruft die Fetteinstellung mit dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

// Bolds the first 4 characters in the document 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 Zeichenversatz.

Zurücksenden

Boolean: Die Einstellung für Fettformatierung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isItalic()

Ruft die Kursiveinstellung ab.

Zurücksenden

Boolean: gibt an, ob der Text kursiv ist, oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isItalic(offset)

Ruft die Kursivformatierung bei dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichenversatz.

Zurücksenden

Boolean: Kursiv

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isStrikethrough()

Ruft die Einstellung für das Durchstreichen ab.

Zurücksenden

Boolean: gibt an, ob der Text durchgestrichen ist, oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isStrikethrough(offset)

Ruft die Einstellung für das Durchgestrichen mit dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichenversatz.

Zurücksenden

Boolean: Die Einstellung zum Durchstreichen.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isUnderline()

Ruft die Unterstrichen-Einstellung ab.

Zurücksenden

Boolean: gibt an, ob der Text unterstrichen ist, oder null, wenn das Element mehrere Werte für dieses Attribut enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

isUnderline(offset)

Ruft die Unterstreichung mit dem angegebenen Zeichenversatz 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

Parameter

NameTypBeschreibung
offsetIntegerDer Zeichenversatz.

Zurücksenden

Boolean: Die unterstrichene Einstellung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

merge()

Führt das Element mit dem gleichgeordneten Element desselben Typs zusammen.

Nur Elemente derselben ElementType können zusammengeführt werden. Alle im aktuellen Element enthaltenen untergeordneten Elemente werden in das entsprechende gleichgeordnete Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Zurücksenden

Text: Das zusammengeführte Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

removeFromParent()

Entfernt das Element aus seinem übergeordneten Element.

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

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

Zurücksenden

Text: Das entfernte Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

replaceText(searchPattern, replacement)

Ersetzt mithilfe von regulären Ausdrücken alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring.

Das Suchmuster wird als String und nicht als JavaScript-Objekt für reguläre Ausdrücke übergeben. Aus diesem Grund ist es erforderlich, umgekehrte Schrägstriche im Muster zu maskieren.

Diese Methode verwendet die RE2-Bibliothek für reguläre Ausdrücke von Google, die die unterstützte Syntax begrenzt.

Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock abgeglichen, der im aktuellen Element enthalten ist.

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Parameter

NameTypBeschreibung
searchPatternStringnach dem Regex-Muster, nach dem gesucht werden soll
replacementStringden zu ersetzenden Text

Zurücksenden

Element: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Attributparameter muss ein Objekt sein, bei dem jeder Attributname ein Element in der Aufzählung DocumentApp.Attribute und jeder Attributwert der neue anzuwendende Wert ist.

// 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/abc123456/edit');

// Gets the document body and edits as text.
const body = doc.getBody().editAsText();

// 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 document body.
const text = body.setAttributes(0, 8, style);

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
attributesObjectDie Attribute des Elements.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setAttributes(attributes)

Legt die Attribute des Elements fest.

Der angegebene Attributparameter muss ein Objekt sein, bei dem jeder Attributname ein Element in der Aufzählung DocumentApp.Attribute und jeder Attributwert der neue anzuwendende Wert ist.

var body = DocumentApp.getActiveDocument().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

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
colorStringDie Hintergrundfarbe in CSS-Notation (z. B. '#ffffff').

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setBackgroundColor(color)

Legt die Hintergrundfarbe fest.

Parameter

NameTypBeschreibung
colorStringHintergrundfarbe, formatiert in CSS-Notation (z. B. '#ffffff')

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setBold(bold)

Legt die Fetteinstellung fest.

Parameter

NameTypBeschreibung
boldBooleandie Fetteinstellung

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setBold(startOffset, endOffsetInclusive, bold)

Legt die Fetteinstellung 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
boldBooleanDie fett gedruckte Einstellung.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Google Docs oder Google Fonts sein. Dabei wird die Groß- und Kleinschreibung berücksichtigt. Nicht erkannte Schriftartennamen werden als Arial gerendert. Die Methoden getFontFamily(offset) und setFontFamily(fontFamilyName) verwenden jetzt Stringnamen für Schriftarten anstelle der Aufzählung FontFamily. Diese Aufzählung ist zwar veraltet, bleibt aber für die 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/abc123456/edit');

// Gets body of the document.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
fontFamilyNameStringDer Name der Schriftfamilie aus dem Menü „Schriftart“ in Google Docs oder Google Fonts.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Google Docs oder Google Fonts sein und die Groß- und Kleinschreibung wird berücksichtigt. Nicht erkannte Schriftartennamen werden als Arial gerendert. Die Methoden getFontFamily() und setFontFamily(fontFamilyName) verwenden jetzt Stringnamen für Schriftarten anstelle der Aufzählung FontFamily. Diese Aufzählung ist zwar veraltet, bleibt aber für die Kompatibilität mit älteren Skripts verfügbar.

Parameter

NameTypBeschreibung
fontFamilyNameStringName der Schriftfamilie aus dem Menü "Schriftart" in Google Docs oder Google Fonts

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
sizeNumberDie Schriftgröße.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setFontSize(size)

Legt die Schriftgröße fest.

Parameter

NameTypBeschreibung
sizeNumberdie Schriftgröße

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
colorStringDie Vordergrundfarbe, formatiert in CSS-Notation (z. B. '#ffffff').

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setForegroundColor(color)

Legt die Vordergrundfarbe fest.

Parameter

NameTypBeschreibung
colorStringVordergrundfarbe, formatiert in CSS-Notation (z. B. '#ffffff')

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setItalic(italic)

Legt die Kursivformatierung fest.

Parameter

NameTypBeschreibung
italicBooleanKursiv-Einstellung

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setItalic(startOffset, endOffsetInclusive, italic)

Legt die Kursiveinstellung 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
italicBooleanKursiv

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
urlStringDie Link-URL

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setLinkUrl(url)

Legt die Link-URL fest.

Parameter

NameTypBeschreibung
urlStringLink-URL

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setStrikethrough(strikethrough)

Legt die Einstellung „Durchgestrichen“ fest.

Parameter

NameTypBeschreibung
strikethroughBooleanDurchgestrichen-Einstellung

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

Legt die Einstellung 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
strikethroughBooleanDurchgestrichene Einstellung

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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/abc123456/edit');

// Gets the document body.
const body = doc.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.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Zeichenbereichs.
endOffsetInclusiveIntegerDer Endversatz des Zeichenbereichs (einschließlich).
textAlignmentTextAlignmentDie Art der Textausrichtung, die angewendet werden soll.

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NameTypBeschreibung
textAlignmentTextAlignmentdie Art der Textausrichtung, die angewendet werden soll

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setUnderline(underline)

Legt die Unterstreichung fest.

Parameter

NameTypBeschreibung
underlineBooleanUnterst.

Zurücksenden

Text: das aktuelle Element

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

setUnderline(startOffset, endOffsetInclusive, underline)

Legt die Unterstreichung 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz des Textbereichs.
endOffsetInclusiveIntegerDer Endversatz des Textbereichs.
underlineBooleanDie Einstellung „Unterstrichen“

Zurücksenden

Text: Das aktuelle Element.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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