Class ListItem

ListItem

Ein Element, das ein Listenelement darstellt. Ein ListItem ist ein Paragraph, das mit einer Listen-ID verknüpft ist. Ein ListItem-Element kann die Elemente Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak und Text enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

ListItems darf keine Zeilenumbruchzeichen enthalten. Zeilenumbruchzeichen ("\n") werden in Zeilenumbruchzeichen ("\r") umgewandelt.

ListItems mit derselben Listen-ID gehören zur selben Liste und sind entsprechend nummeriert. Die ListItems für eine bestimmte Liste müssen nicht nebeneinander auf dem Tab stehen oder dasselbe übergeordnete Element haben. Zwei Elemente, die zu derselben Liste gehören, können sich überall auf dem Tab befinden und dabei eine fortlaufende Nummerierung beibehalten, wie das folgende Beispiel zeigt:

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

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt und fügt ein neues PositionedImage aus dem angegebenen Bild-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendInlineImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt und hängt einen neuen PageBreak an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendText(text)TextErstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.
appendText(text)TextHängt das angegebene Text-Element an.
clear()ListItemDer Inhalt des Elements wird gelöscht.
copy()ListItemGibt 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 im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAlignment()HorizontalAlignmentRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getGlyphType()GlyphTypeRuft die GlyphType des Listenelements ab.
getHeading()ParagraphHeadingRuft die ParagraphHeading ab.
getIndentEnd()NumberRuft die Einzug am Ende in Punkten ab.
getIndentFirstLine()NumberRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()NumberRuft den Anfangseinzug ab.
getLineSpacing()NumberRuft den Zeilenabstand in Punkten ab.
getLinkUrl()StringRuft die Link-URL ab.
getListId()StringRuft die Listen-ID ab.
getNestingLevel()IntegerRuft die Verschachtelungsebene des Listenelements 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 einen 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()NumberDer Abstand nach dem Element in Punkten.
getSpacingBefore()NumberRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine HorizontalRule an der angegebenen Position ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt eine neue InlineImage aus dem angegebenen Bild-Blob an der angegebenen Indexposition ein.
insertInlineImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt eine neue PageBreak an der angegebenen Position ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak an der angegebenen Position ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es an der angegebenen Position ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element mit dem angegebenen Textinhalt am angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
isLeftToRight()BooleanRuft die Einstellung für die linksläufige Schreibrichtung ab.
merge()ListItemDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeChild(child)ListItemEntfernt das angegebene untergeordnete Element.
removeFromParent()ListItemEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt eine PositionedImage anhand der ID des Bilds.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAlignment(alignment)ListItemLegt HorizontalAlignment fest.
setAttributes(attributes)ListItemHiermit werden die Attribute des Elements festgelegt.
setGlyphType(glyphType)ListItemLegt den GlyphType des Listenelements fest.
setHeading(heading)ListItemLegt ParagraphHeading fest.
setIndentEnd(indentEnd)ListItemLegt den Einzug am Ende in Punkten fest.
setIndentFirstLine(indentFirstLine)ListItemLegt den Einzug der ersten Zeile in Punkten fest.
setIndentStart(indentStart)ListItemLegt den Einzug am Anfang in Punkten fest.
setLeftToRight(leftToRight)ListItemHier wird die Einstellung „Linksläufig“ festgelegt.
setLineSpacing(multiplier)ListItemHiermit wird der Zeilenabstand festgelegt. Dabei wird die Anzahl der Zeilen angegeben, die für den Abstand verwendet werden sollen.
setLinkUrl(url)ListItemLegt die Link-URL fest.
setListId(listItem)ListItemLegt die Listen-ID fest.
setNestingLevel(nestingLevel)ListItemHiermit wird die Verschachtelungsebene des Listenelements festgelegt.
setSpacingAfter(spacingAfter)ListItemLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ListItemLegt den Abstand vor dem Element in Punkten fest.
setText(text)voidHiermit wird der Inhalt des Listenelements als Text festgelegt.
setTextAlignment(textAlignment)ListItemHiermit wird die Textausrichtung festgelegt.

Detaillierte Dokumentation

addPositionedImage(image)

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

Parameter

NameTypBeschreibung
imageBlobSourcedie Bilddaten

Rückflug

PositionedImage – das neu positionierte Bild

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendHorizontalRule()

Erstellt und hängt einen neuen HorizontalRule an.

Rückflug

HorizontalRule – die neue horizontale Linie

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendInlineImage(image)

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

Parameter

NameTypBeschreibung
imageBlobSourcedie Bilddaten

Rückflug

InlineImage – das angehängte Bild

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendInlineImage(image)

Hängt die angegebene InlineImage an.

Parameter

NameTypBeschreibung
imageInlineImagedie Bilddaten

Rückflug

InlineImage – das angehängte Bild

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendPageBreak()

Erstellt und hängt einen neuen PageBreak an.

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

Rückflug

PageBreak – das neue Seitenumbruch-Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendPageBreak(pageBreak)

Hängt die angegebene PageBreak an.

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

Parameter

NameTypBeschreibung
pageBreakPageBreakden einzufügenden Seitenumbruch

Rückflug

PageBreak – das angehängte Seitenumbruchelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendText(text)

Erstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.

Parameter

NameTypBeschreibung
textStringden Textinhalt

Rückflug

Text – das neue Textelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendText(text)

Hängt das angegebene Text-Element an.

Parameter

NameTypBeschreibung
textTextdas anzufügende Textelement

Rückflug

Text – das angehängte Textelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clear()

Der Inhalt des Elements wird gelöscht.

Rückflug

ListItem: Das aktuelle Element.


copy()

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

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

Rückflug

ListItem – die neue Kopie.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

editAsText()

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

Verwenden Sie editAsText, um den Inhalt des Elements als Rich-Text zu bearbeiten. Im editAsText-Modus werden nicht textbasierte Elemente wie InlineImage und HorizontalRule ignoriert.

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

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

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

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

Rückflug

Text: eine Textversion des aktuellen Elements


findElement(elementType)

Es wird im Inhalt des Elements nach einem Nachkommen 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

findElement(elementType, from)

Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parameter

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

findText(searchPattern)

Es wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.

Einige der Funktionen für reguläre Ausdrücke in JavaScript werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas zu suchende Muster

Rückflug

RangeElement: ein Suchergebnis, das die Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung gefunden wurde

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

findText(searchPattern, from)

Es wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.

Einige der Funktionen für reguläre Ausdrücke in JavaScript werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas zu suchende Muster
fromRangeElementdas Suchergebnis, in dem gesucht werden soll

Rückflug

RangeElement: ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung gefunden wurde

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getAlignment()

Ruft die HorizontalAlignment ab.

Rückflug

HorizontalAlignment – die Ausrichtung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 mit einer Property für jedes gültige Elementattribut, wobei jeder Property-Name einem Element in der DocumentApp.Attribute-Aufzählung entspricht.

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Rückflug

Object: Die Attribute des Elements.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getChild(childIndex)

Ruft das untergeordnete Element am angegebenen untergeordneten Index ab.

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

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

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

Parameter

NameTypBeschreibung
childIndexIntegerDer Index des untergeordneten Elements, das abgerufen werden soll.

Rückflug

Element: Das untergeordnete Element am angegebenen Index.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getChildIndex(child)

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

Parameter

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

Rückflug

Integer: Der untergeordnete Index.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getGlyphType()

Ruft die GlyphType des Listenelements ab.

Rückflug

GlyphType: Glyphentyp

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getHeading()

Ruft die ParagraphHeading ab.

Rückflug

ParagraphHeading – die Überschrift

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getIndentEnd()

Ruft die Einzug am Ende in Punkten ab.

Rückflug

Number: Einzug am Ende, in Punkten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getIndentFirstLine()

Ruft den Einzug der ersten Zeile in Punkten ab.

Rückflug

Number: Einzug der ersten Zeile in Punkten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getIndentStart()

Ruft den Anfangseinzug ab.

Rückflug

Number – der Anfangseinzug

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getLineSpacing()

Ruft den Zeilenabstand in Punkten ab.

Rückflug

Number: Zeilenabstand in Punkten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getListId()

Ruft die Listen-ID ab.

Rückflug

String: die Listen-ID

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getNestingLevel()

Ruft die Verschachtelungsebene des Listenelements ab.

Listenelemente haben standardmäßig die Verschachtelungsebene 0. Die Verschachtelungsebene bestimmt das Glyph, das vom Listenelement verwendet wird.

Rückflug

Integer – die Verschachtelungsebene

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getNumChildren()

Ruft die Anzahl der untergeordneten Elemente ab.

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

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Rückflug

Integer – Die Anzahl der untergeordneten Elemente.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getPositionedImage(id)

Ruft einen PositionedImage anhand der ID des Bildes ab.

Parameter

NameTypBeschreibung
idStringdie Bild-ID

Rückflug

PositionedImage – das positionierte Bild

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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[] – Liste der positionierten Bilder

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getPreviousSibling()

Ruft das vorherige gleichgeordnete Element des Elements ab.

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

Rückflug

Element: Das vorherige gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSpacingAfter()

Der Abstand nach dem Element in Punkten.

Rückflug

Number: Abstand nach dem Element in Punkten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 vor dem Element in Punkten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getText()

Ruft den Inhalt des Elements als Textstring ab.

Rückflug

String: Der Inhalt des Elements als Textstring

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getTextAlignment()

Die Textausrichtung wird abgerufen. Verfügbare Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

Rückflug

TextAlignment – die Art der Textausrichtung oder null, wenn der Text mehrere Textausrichtungen enthält oder die Textausrichtung noch nie festgelegt wurde

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getType()

Ruft den ElementType des Elements ab.

Mit getType() können Sie den genauen Typ eines bestimmten Elements ermitteln.

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

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

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Rückflug

ElementType: Der Elementtyp.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertHorizontalRule(childIndex)

Erstellt und fügt eine HorizontalRule an der angegebenen Position ein.

Parameter

NameTypBeschreibung
childIndexIntegerden Index, an dem das Element eingefügt werden soll

Rückflug

HorizontalRule – das neue Element für horizontale Linien

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertInlineImage(childIndex, image)

Erstellt und fügt eine neue InlineImage aus dem angegebenen Bild-Blob an der angegebenen Indexposition ein.

Parameter

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

Rückflug

InlineImage – das eingefügte Inline-Bildelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertInlineImage(childIndex, image)

Fügt das angegebene InlineImage an der angegebenen Position ein.

Parameter

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

Rückflug

InlineImage – das eingefügte Inline-Bildelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertPageBreak(childIndex)

Erstellt und fügt eine neue PageBreak an der angegebenen Position ein.

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

Parameter

NameTypBeschreibung
childIndexIntegerden Index, an dem das Element eingefügt werden soll

Rückflug

PageBreak – das neue Seitenumbruch-Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertPageBreak(childIndex, pageBreak)

Fügt das angegebene PageBreak an der angegebenen Position ein.

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

Parameter

NameTypBeschreibung
childIndexIntegerden Index, an dem das Element eingefügt werden soll
pageBreakPageBreakden einzufügenden Seitenumbruch

Rückflug

PageBreak – das eingefügte Seitenumbruchelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertText(childIndex, text)

Erstellt ein neues Textelement und fügt es an der angegebenen Position ein.

Parameter

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

Rückflug

Text – das neue Textelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 am angegebenen Index ein.

Parameter

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

Rückflug

Text – das eingefügte Textelement

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isAtDocumentEnd()

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

Rückflug

Boolean: Gibt an, ob sich das Element am Ende des Tabs befindet.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isLeftToRight()

Ruft die Einstellung für die linksläufige Schreibrichtung ab.

Rückflug

Boolean – die Einstellung „Rechtsläufig“

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

merge()

Das Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.

Es können nur Elemente desselben ElementType zusammengeführt werden. Alle untergeordneten Elemente, die sich im aktuellen Element befinden, werden zum übergeordneten Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Rückflug

ListItem – das zusammengeführte Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeChild(child)

Entfernt das angegebene untergeordnete Element.

Parameter

NameTypBeschreibung
childElementdas untergeordnete Element, das entfernt werden soll

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeFromParent()

Entfernt das Element aus dem übergeordneten Element.

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

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

Rückflug

ListItem: Das entfernte Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removePositionedImage(id)

Entfernt eine PositionedImage anhand der ID des Bilds.

Parameter

NameTypBeschreibung
idString

Rückflug

Boolean – ob das angegebene Bild entfernt wurde

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

replaceText(searchPattern, replacement)

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

Das Suchmuster wird als String übergeben, nicht als JavaScript-Objekt für reguläre Ausdrücke. Aus diesem Grund müssen alle umgekehrten Schrägstriche im Muster maskiert werden.

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

Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

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

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

Parameter

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

Rückflug

Element – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setAttributes(attributes)

Hiermit werden die Attribute des Elements festgelegt.

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, der angewendet werden soll.

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

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

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

Parameter

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückflug

ListItem: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setGlyphType(glyphType)

Legt den GlyphType des Listenelements fest.

Parameter

NameTypBeschreibung
glyphTypeGlyphTypeden Glyphentyp

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setHeading(heading)

Legt ParagraphHeading fest.

Parameter

NameTypBeschreibung
headingParagraphHeadingdie Überschrift

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setIndentFirstLine(indentFirstLine)

Legt den Einzug der ersten Zeile in Punkten fest.

Parameter

NameTypBeschreibung
indentFirstLineNumberEinzug der ersten Zeile in Punkten

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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
indentStartNumberder Anfangseinzug in Punkten

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setLeftToRight(leftToRight)

Hier wird die Einstellung „Linksläufig“ festgelegt.

Parameter

NameTypBeschreibung
leftToRightBooleandie Einstellung „Rechtsläufig“

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setLineSpacing(multiplier)

Hiermit wird der Zeilenabstand festgelegt. Dabei wird die Anzahl der Zeilen angegeben, die für den Abstand verwendet werden sollen.

Parameter

NameTypBeschreibung
multiplierNumberdie Anzahl der Zeilen

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setListId(listItem)

Legt die Listen-ID fest.

Die Listen-ID ist auf denselben Wert für die angegebene ListItem festgelegt. Die beiden ListItems werden als Mitglieder derselben Liste behandelt.

Parameter

NameTypBeschreibung
listItemListItemdas Listenelement, dessen Listen-ID verwendet werden soll

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setNestingLevel(nestingLevel)

Hiermit wird die Verschachtelungsebene des Listenelements festgelegt.

Listenelemente haben standardmäßig die Verschachtelungsebene 0. Die Verschachtelungsebene bestimmt das Glyph, das vom Listenelement verwendet wird.

Parameter

NameTypBeschreibung
nestingLevelIntegerdie Verschachtelungsebene

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setText(text)

Hiermit wird der Inhalt des Listenelements als Text festgelegt.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringden neuen Textinhalt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setTextAlignment(textAlignment)

Hiermit wird die Textausrichtung festgelegt. Verfügbare Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

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

Parameter

NameTypBeschreibung
textAlignmentTextAlignmentdie Art der Textausrichtung

Rückflug

ListItem – das aktuelle Element

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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