Class Paragraph

Absatz

Ein Element, das einen Absatz darstellt. Ein Paragraph kann die Elemente Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak und Text enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zur Erweiterung von Google Docs.

Paragraphs darf keine Zeilenumbrüche enthalten. Zeilenvorschubzeichen („\n“) werden in Zeilenumbrüche („ã“) umgewandelt.

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

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
var section = body.appendParagraph("Section 1");
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph("This is a typical paragraph.");

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt ein neues PositionedImage-Element aus dem angegebenen Bild-Blob und fügt es ein.
appendHorizontalRule()HorizontalRuleErstellt ein neues HorizontalRule-Objekt und hängt es an.
appendInlineImage(image)InlineImageErstellt ein neues InlineImage-Element aus dem angegebenen Bild-Blob und hängt es an.
appendInlineImage(image)InlineImageFügt die angegebenen InlineImage-Elemente an.
appendPageBreak()PageBreakErstellt ein neues PageBreak-Objekt und hängt es an.
appendPageBreak(pageBreak)PageBreakFügt die angegebenen PageBreak-Elemente an.
appendText(text)TextErstellt ein neues Text-Element mit den angegebenen Inhalten und hängt es an.
appendText(text)TextFügt das angegebene Text-Element an.
clear()ParagraphLöscht den Inhalt des Elements.
copy()ParagraphGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab
findElement(elementType)RangeElementEs wird in den Inhalten des Elements nach einem Nachfolger des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolger des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElementDer Inhalt des Elements wird mit regulären Ausdrücken nach dem angegebenen Textmuster durchsucht.
findText(searchPattern, from)RangeElementDer Inhalt des Elements wird nach dem angegebenen Textmuster durchsucht, beginnend mit einem bestimmten Suchergebnis.
getAlignment()HorizontalAlignmentRuft die HorizontalAlignment ab
getAttributes()ObjectRuft die Attribute des Elements ab
getChild(childIndex)ElementRuft das untergeordnete Element beim angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getHeading()ParagraphHeadingRuft die ParagraphHeading ab
getIndentEnd()NumberRuft den Einzug am Ende in Punkten ab
getIndentFirstLine()NumberRuft den ersten Zeileneinzug in Punkten ab
getIndentStart()NumberRuft den Einzug am Anfang ab
getLineSpacing()NumberRuft den Zeilenabstand in Punkten ab
getLinkUrl()StringRuft die Link-URL ab
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPositionedImage(id)PositionedImageRuft ein PositionedImage anhand der ID des Bildes ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die am Absatz verankert sind
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getSpacingAfter()NumberRuft den Abstand nach dem Element in Punkten ab
getSpacingBefore()NumberRuft den Abstand vor dem Element in Punkten ab
getText()StringRuft den Inhalt des Elements als Textstring ab
getTextAlignment()TextAlignmentRuft die Textausrichtung ab
getType()ElementTypeRuft die ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt eine HorizontalRule und fügt sie am angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageErstellt aus dem angegebenen Bild-Blob und im angegebenen Index ein neues InlineImage.
insertInlineImage(childIndex, image)InlineImageFügt den angegebenen InlineImage-Wert im angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt ein PageBreak-Objekt im angegebenen Index und fügt es ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt den angegebenen PageBreak-Wert im angegebenen Index ein.
insertText(childIndex, text)TextErstellt ein neues Textelement am angegebenen Index und fügt es ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element mit dem angegebenen Textinhalt im angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
isLeftToRight()BooleanRuft die Einstellung für die Leserichtung von links nach rechts ab
merge()ParagraphFührt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen.
removeChild(child)ParagraphEntfernt das angegebene untergeordnete Element.
removeFromParent()ParagraphEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt eine PositionedImage nach Bild-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen regulären String durch reguläre Ausdrücke.
setAlignment(alignment)ParagraphLegt HorizontalAlignment fest.
setAttributes(attributes)ParagraphLegt die Attribute des Elements fest.
setHeading(heading)ParagraphLegt ParagraphHeading fest.
setIndentEnd(indentEnd)ParagraphLegt den Einzug am Ende in Punkten fest
setIndentFirstLine(indentFirstLine)ParagraphLegt den ersten Zeileneinzug in Punkten fest.
setIndentStart(indentStart)ParagraphLegt den Einzug am Anfang in Punkten fest.
setLeftToRight(leftToRight)ParagraphLegt die Einstellung von links nach rechts fest.
setLineSpacing(multiplier)ParagraphLegt den Zeilenabstand als Menge fest, die die Anzahl der Zeilen für den Abstand angibt.
setLinkUrl(url)ParagraphLegt die Link-URL fest.
setSpacingAfter(spacingAfter)ParagraphLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ParagraphLegt den Abstand vor dem Element in Punkten fest
setText(text)voidLegt den Inhalt des Absatzes als Text fest.
setTextAlignment(textAlignment)ParagraphLegt die Textausrichtung fest.

Detaillierte Dokumentation

addPositionedImage(image)

Erstellt ein neues PositionedImage-Element aus dem angegebenen Bild-Blob und fügt es ein.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image =
  UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png');

// Adds the image to the document, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parameter

NameTypBeschreibung
imageBlobSourceDie Bilddaten.

Rückflug

PositionedImage: Das neue Positionsbild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendHorizontalRule()

Erstellt ein neues HorizontalRule-Objekt und hängt es an.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

Rückflug

HorizontalRule: Die neue horizontale Regel.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendInlineImage(image)

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp
  .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png');

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parameter

NameTypBeschreibung
imageBlobSourceDie Bilddaten.

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendInlineImage(image)

Fügt die angegebenen InlineImage-Elemente an.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();;

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parameter

NameTypBeschreibung
imageInlineImageDie Bilddaten.

Rückflug

InlineImage: Das angehängte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendPageBreak()

Erstellt ein neues PageBreak-Objekt und hängt es an.

Hinweis: PageBreaks darf nicht in TableCells enthalten sein. Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

Rückflug

PageBreak: Das neue Seitenumbruchelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendPageBreak(pageBreak)

Fügt die angegebenen PageBreak-Elemente an.

Hinweis: PageBreaks darf nicht in TableCells enthalten sein. Wenn das aktuelle Element in einer Tabellenzelle vorhanden ist, löst das Skript eine Ausnahme aus.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

Parameter

NameTypBeschreibung
pageBreakPageBreakDer anzufügende Seitenumbruch.

Rückflug

PageBreak: Das angehängte Seitenumbruchelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendText(text)

Erstellt ein neues Text-Element mit den angegebenen Inhalten und hängt es an.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

Parameter

NameTypBeschreibung
textStringDer Textinhalt.

Rückflug

Text: Das neue Textelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendText(text)

Fügt das angegebene Text-Element an.

 // Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

Parameter

NameTypBeschreibung
textTextDas Textelement, das angefügt werden soll.

Rückflug

Text: Das angehängte Textelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

clear()

Löscht den Inhalt des Elements.

Rückflug

Paragraph: Das aktuelle Element.


copy()

Gibt eine losgelöste, 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.

Rückflug

Paragraph: Die neue Kopie.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Elementinhalt als RTF bearbeiten. Im editAsText-Modus werden Nicht-Text-Elemente wie InlineImage und HorizontalRule ignoriert.

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

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Rückflug

Text: eine Textversion des aktuellen Elements


findElement(elementType)

Es wird in den Inhalten des Elements nach einem Nachfolger des angegebenen Typs gesucht.

Parameter

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll

Rückflug

RangeElement: Ein Suchergebnis, das die Position des Suchelements angibt

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

findElement(elementType, from)

Sucht im Inhalt des Elements nach einem Nachfolger des angegebenen Typs, beginnend mit dem angegebenen RangeElement.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

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

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

Parameter

NameTypBeschreibung
elementTypeElementTypeDer Elementtyp, nach dem gesucht werden soll
fromRangeElementin den Suchergebnissen

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

findText(searchPattern)

Der Inhalt des Elements wird mit regulären Ausdrücken nach dem angegebenen Textmuster durchsucht.

Ein Teil der Funktionen des regulären JavaScript-Ausdrucks wird nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modifikatoren.

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

Parameter

NameTypBeschreibung
searchPatternStringMuster für die Suche nach

Rückflug

RangeElement: Ein Suchergebnis, das die Position des Suchtexts angibt, oder null, wenn es keine Übereinstimmung gibt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

findText(searchPattern, from)

Der Inhalt des Elements wird nach dem angegebenen Textmuster durchsucht, beginnend mit einem bestimmten Suchergebnis.

Ein Teil der Funktionen des regulären JavaScript-Ausdrucks wird nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modifikatoren.

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

Parameter

NameTypBeschreibung
searchPatternStringMuster für die Suche nach
fromRangeElementin den Suchergebnissen

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getAlignment()

Ruft die HorizontalAlignment ab

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the console.
console.log(paragraph.getAlignment().toString());

Rückflug

HorizontalAlignment: Die Ausrichtung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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]);
}

Rückflug

Object: die Attribute des Elements

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getChild(childIndex)

Ruft das untergeordnete Element beim angegebenen untergeordneten Index ab.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Parameter

NameTypBeschreibung
childIndexIntegerIndex des untergeordneten Elements, das abgerufen werden soll

Rückflug

Element: Das untergeordnete Element im angegebenen Index

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getChildIndex(child)

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

Parameter

NameTypBeschreibung
childElementdas untergeordnete Element, für das der Index abgerufen werden soll

Rückflug

Integer: Der untergeordnete Index

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getHeading()

Ruft die ParagraphHeading ab

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

Rückflug

ParagraphHeading: Die Überschrift.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getIndentEnd()

Ruft den Einzug am Ende in Punkten ab

Rückflug

Number: Der Einzug am Ende, in Punkten

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getIndentFirstLine()

Ruft den ersten Zeileneinzug in Punkten ab

Rückflug

Number: der erste Zeileneinzug in Punkten

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getIndentStart()

Ruft den Einzug am Anfang ab

Rückflug

Number: Starteinzug

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLineSpacing()

Ruft den Zeilenabstand in Punkten ab

Rückflug

Number: der Zeilenabstand in Punkten

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLinkUrl()

Ruft die Link-URL ab

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Rückflug

Element: Das nächste gleichgeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNumChildren()

Ruft die Anzahl der untergeordneten Elemente ab

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Rückflug

Integer: Die Anzahl von Kindern

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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: Das übergeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getPositionedImage(id)

Ruft ein PositionedImage anhand der ID des Bildes ab.

Parameter

NameTypBeschreibung
idStringBild-ID

Rückflug

PositionedImage: das positionierte Bild

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getPositionedImages()

Ruft alle PositionedImage-Objekte ab, die am Absatz verankert sind

Rückflug

PositionedImage[]: eine Liste der positionierten Bilder

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Rückflug

Element: das vorherige gleichgeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSpacingAfter()

Ruft den Abstand nach dem Element in Punkten ab

Rückflug

Number: Abstand in Punkten nach dem Element

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSpacingBefore()

Ruft den Abstand vor dem Element in Punkten ab

Rückflug

Number: Abstand in Punkten

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getType()

Ruft die ElementType des Elements ab.

Mit getType() lässt sich der genaue Typ eines bestimmten Elements ermitteln.

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.');
}

Rückflug

ElementType: der Elementtyp.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertHorizontalRule(childIndex)

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

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll

Rückflug

HorizontalRule: Das neue horizontale Regelelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertInlineImage(childIndex, image)

Erstellt aus dem angegebenen Bild-Blob und im angegebenen Index ein neues InlineImage.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll
imageBlobSourcedie Bilddaten

Rückflug

InlineImage: Das eingefügte Inline-Bildelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertInlineImage(childIndex, image)

Fügt den angegebenen InlineImage-Wert im angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll
imageInlineImagedie Bilddaten

Rückflug

InlineImage: Das eingefügte Inline-Bildelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertPageBreak(childIndex)

Erstellt ein PageBreak-Objekt im angegebenen Index und fügt es ein.

Hinweis: PageBreaks darf nicht in TableCells enthalten sein. Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll

Rückflug

PageBreak: das neue Element für den Seitenumbruch

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertPageBreak(childIndex, pageBreak)

Fügt den angegebenen PageBreak-Wert im angegebenen Index ein.

Hinweis: PageBreaks darf nicht in TableCells enthalten sein. Wenn das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll
pageBreakPageBreakp[Altersempfehlung zum Einfügen

Rückflug

PageBreak: Das eingefügte Seitenumbruchelement

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertText(childIndex, text)

Erstellt ein neues Textelement am angegebenen Index und fügt es ein.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll
textStringden Textinhalt

Rückflug

Text: Das neue Textelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertText(childIndex, text)

Fügt das angegebene Text-Element mit dem angegebenen Textinhalt im angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem das Element eingefügt werden soll
textTextdas einzufügende Textelement

Rückflug

Text: Das eingefügte Textelement.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isAtDocumentEnd()

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isLeftToRight()

Ruft die Einstellung für die Leserichtung von links nach rechts ab

Rückflug

Boolean: Die Einstellung von links nach rechts

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

merge()

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

Nur Elemente desselben ElementType können zusammengeführt werden. Alle im aktuellen Element enthaltenen untergeordneten Elemente werden in das vorherige 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();

Rückflug

Paragraph: Das zusammengeführte Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeChild(child)

Entfernt das angegebene untergeordnete Element.

Parameter

NameTypBeschreibung
childElementdas zu entfernende untergeordnete Element

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeFromParent()

Entfernt das Element aus dem ü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();
}

Rückflug

Paragraph: Das entfernte Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removePositionedImage(id)

Entfernt eine PositionedImage nach Bild-ID.

Parameter

NameTypBeschreibung
idStringBild-ID

Rückflug

Boolean: Gibt an, ob das angegebene Bild entfernt wurde.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

replaceText(searchPattern, replacement)

Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen regulären String durch reguläre Ausdrücke.

Das Suchmuster wird als String übergeben und nicht als JavaScript-Objekt für reguläre Ausdrücke. Daher müssen Sie umgekehrte Schrägstriche im entsprechenden Escape-Code maskieren.

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

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

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

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

Parameter

NameTypBeschreibung
searchPatternStringRegex-Muster für die Suche
replacementStringden zu ersetzenden Text

Rückflug

Element: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setAlignment(alignment)

Legt HorizontalAlignment fest.

Parameter

NameTypBeschreibung
alignmentHorizontalAlignmentdie horizontale Ausrichtung

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 ist und jeder Attributwert der neue 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.

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setHeading(heading)

Legt ParagraphHeading fest.

Parameter

NameTypBeschreibung
headingParagraphHeadingdie Überschrift

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setIndentEnd(indentEnd)

Legt den Einzug am Ende in Punkten fest

Parameter

NameTypBeschreibung
indentEndNumberEinzug am Ende, in Punkten

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setIndentFirstLine(indentFirstLine)

Legt den ersten Zeileneinzug in Punkten fest.

Parameter

NameTypBeschreibung
indentFirstLineNumberEinzug der ersten Zeile in Punkten

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setIndentStart(indentStart)

Legt den Einzug am Anfang in Punkten fest.

Parameter

NameTypBeschreibung
indentStartNumberEinzug am Anfang, in Punkten

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setLeftToRight(leftToRight)

Legt die Einstellung von links nach rechts fest.

Parameter

NameTypBeschreibung
leftToRightBooleanvon links nach rechts

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setLineSpacing(multiplier)

Legt den Zeilenabstand als Menge fest, die die Anzahl der Zeilen für den Abstand angibt.

Parameter

NameTypBeschreibung
multiplierNumberdie Anzahl der Zeilen

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setSpacingAfter(spacingAfter)

Legt den Abstand nach dem Element in Punkten fest.

Parameter

NameTypBeschreibung
spacingAfterNumberAbstand nach dem Element, in Punkten

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setSpacingBefore(spacingBefore)

Legt den Abstand vor dem Element in Punkten fest

Parameter

NameTypBeschreibung
spacingBeforeNumberAbstand vor dem Element, in Punkten

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setText(text)

Legt den Inhalt des Absatzes als Text fest.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringder neue Textinhalt

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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
textAlignmentTextAlignmentArt der Textausrichtung, die angewendet werden soll

Rückflug

Paragraph: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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