Class ListItem

ListItem

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

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

ListItems mit derselben Listen-ID gehören zur selben Liste und werden entsprechend nummeriert. Die ListItems für eine bestimmte Liste müssen im Dokument nicht angrenzend sein oder dasselbe übergeordnete Element haben. Zwei Elemente, die zur selben Liste gehören, können an einer beliebigen Stelle im Dokument vorhanden sein, wobei fortlaufende Nummerierungen beibehalten werden. Das folgende Beispiel veranschaulicht dies:

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

// Append a new list item to the body.
var 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.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt ein neues PositionedImage-Objekt 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-Objekt aus dem angegebenen Bild-Blob und hängt es an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt ein neues PageBreak-Objekt und hängt es 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()ListItemLöscht den Inhalt des Elements.
copy()ListItemGibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zum Bearbeiten ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElementSucht den Inhalt des Elements mithilfe regulärer Ausdrücke nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht den Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten Suchergebnis.
getAlignment()HorizontalAlignmentRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element aus dem angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getGlyphType()GlyphTypeRuft das GlyphType des Listenelements ab.
getHeading()ParagraphHeadingRuft die ParagraphHeading ab.
getIndentEnd()NumberRuft den Einzug am Ende in Punkten ab.
getIndentFirstLine()NumberRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()NumberRuft den Einzug am Anfang 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 ein PositionedImage anhand der Image-ID ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die mit dem 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 den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt einen HorizontalRule und fügt ihn im angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageErstellt einen neuen InlineImage aus dem angegebenen Bild-Blob und fügt ihn im angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageFügt den angegebenen InlineImage in den angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt einen neuen PageBreak und fügt ihn im angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt den angegebenen PageBreak in den angegebenen Index ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es im angegebenen Index 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 rechtsläufige Einstellung ab.
merge()ListItemFührt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen.
removeChild(child)ListItemEntfernt das angegebene untergeordnete Element.
removeFromParent()ListItemEntfernt das Element aus seinem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt PositionedImage anhand der Bild-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters mithilfe regulärer Ausdrücke durch einen bestimmten Ersatzstring.
setAlignment(alignment)ListItemLegt HorizontalAlignment fest.
setAttributes(attributes)ListItemLegt die Attribute des Elements fest.
setGlyphType(glyphType)ListItemLegt den GlyphType des Listeneintrags 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)ListItemLegt die rechtsläufige Einstellung fest.
setLineSpacing(multiplier)ListItemLegt den Zeilenabstand fest. Er gibt die Anzahl der Zeilen an, die für den Abstand verwendet werden sollen.
setLinkUrl(url)ListItemLegt die Link-URL fest.
setListId(listItem)ListItemLegt die Listen-ID fest.
setNestingLevel(nestingLevel)ListItemLegt die Verschachtelungsebene des Listenelements fest.
setSpacingAfter(spacingAfter)ListItemLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ListItemLegt den Abstand vor dem Element in Punkten fest.
setText(text)voidLegt den Inhalt des Listenelements als Text fest.
setTextAlignment(textAlignment)ListItemLegt die Textausrichtung fest.

Detaillierte Dokumentation

addPositionedImage(image)

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

Parameter

NameTypBeschreibung
imageBlobSourcedie Bilddaten

Return

PositionedImage: das neu positionierte Bild

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

appendHorizontalRule()

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

Return

HorizontalRule – die neue horizontale Regel

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

appendInlineImage(image)

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

Parameter

NameTypBeschreibung
imageBlobSourcedie Bilddaten

Return

InlineImage: das angehängte Bild

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

InlineImage: das angehängte Bild

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Return

PageBreak – das neue Seitenumbruchelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 das aktuelle Element in einer Tabellenzelle enthalten ist, wird eine Ausnahme ausgelöst.

Parameter

NameTypBeschreibung
pageBreakPageBreakden anzufügenden Seitenumbruch

Return

PageBreak – das angehängte Element für den Seitenumbruch

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

Text – das neue Textelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 hinzuzufügende Textelement

Return

Text – das angehängte Textelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clear()

Löscht den Inhalt des Elements.

Return

ListItem – das aktuelle Element


copy()

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

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

Return

ListItem: Die neue Kopie.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

editAsText()

Ruft eine Text-Version des aktuellen Elements zum Bearbeiten ab.

Verwenden Sie editAsText, um den Inhalt der Elemente im RTF-Format zu bearbeiten. Im Modus editAsText werden Nicht-Textelemente 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);

Return

Text: eine Textversion des aktuellen Elements


findElement(elementType)

Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.

Parameter

NameTypBeschreibung
elementTypeElementTypeElementtyp, nach dem gesucht werden soll

Return

RangeElement: ein Suchergebnis, das die Position des Suchelements angibt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

findElement(elementType, from)

Sucht im Inhalt des Elements nach einem Nachfolgerelement 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
elementTypeElementTypeElementtyp, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, in dem gesucht werden soll,

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

findText(searchPattern)

Sucht den Inhalt des Elements mithilfe regulärer Ausdrücke nach dem angegebenen Textmuster.

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

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

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

findText(searchPattern, from)

Sucht den Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten Suchergebnis.

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

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

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, in dem gesucht werden soll,

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getAlignment()

Ruft die HorizontalAlignment ab.

Return

HorizontalAlignment – die Ausrichtung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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, das ein Attribut für jedes gültige Elementattribut enthält, wobei jeder Attributname einem Element in der DocumentApp.Attribute-Aufzählung 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]);
}

Return

Object: Die Attribute des Elements.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getChild(childIndex)

Ruft das untergeordnete Element aus dem 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 abzurufenden untergeordneten Elements

Return

Element: das untergeordnete Element beim angegebenen Index

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

Integer – der untergeordnete Index

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getGlyphType()

Ruft das GlyphType des Listenelements ab.

Return

GlyphType – der Symboltyp

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getHeading()

Ruft die ParagraphHeading ab.

Return

ParagraphHeading: die Überschrift

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getIndentEnd()

Ruft den Einzug am Ende in Punkten ab.

Return

Number: der Einzug am Ende in Punkten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

Number: Der Einzug der ersten Zeile in Punkten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getIndentStart()

Ruft den Einzug am Anfang ab.

Return

Number: Der Einzug am Anfang

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getLineSpacing()

Ruft den Zeilenabstand in Punkten ab.

Return

Number: der Zeilenabstand in Punkten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getLinkUrl()

Ruft die Link-URL ab.

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getListId()

Ruft die Listen-ID ab.

Return

String: die Listen-ID

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getNestingLevel()

Ruft die Verschachtelungsebene des Listenelements ab.

Die Verschachtelungsebene von Listenelementen ist standardmäßig null. Die Verschachtelungsebene bestimmt das Symbol, das vom Listenelement verwendet wird.

Return

Integer: die Verschachtelungsebene

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 das gleiche übergeordnete Element und folgt dem aktuellen Element.

Return

Element: Das nächste gleichgeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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.");

Return

Integer: die Anzahl der untergeordneten Elemente

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

ContainerElement: Das übergeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getPositionedImage(id)

Ruft ein PositionedImage anhand der Image-ID ab.

Parameter

NameTypBeschreibung
idStringdie Bild-ID

Return

PositionedImage: das positionierte Bild

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getPositionedImages()

Ruft alle PositionedImage-Objekte ab, die mit dem Absatz verankert sind.

Return

PositionedImage[]: eine Liste der positionierten Bilder

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 das gleiche übergeordnete Element und steht dem aktuellen Element vor.

Return

Element: Das vorherige gleichgeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSpacingAfter()

Ruft den Abstand nach dem Element in Punkten ab.

Return

Number: der Abstand nach dem Element in Punkten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

Number: der Abstand vor dem Element in Punkten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

String: der Inhalt des Elements als Textstring

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getType()

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

Return

ElementType: Der Elementtyp.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertHorizontalRule(childIndex)

Erstellt einen HorizontalRule und fügt ihn im angegebenen Index ein.

Parameter

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

Return

HorizontalRule: das neue horizontale Regelelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertInlineImage(childIndex, image)

Erstellt einen neuen InlineImage aus dem angegebenen Bild-Blob und fügt ihn im angegebenen Index ein.

Parameter

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

Return

InlineImage: das eingefügte Inline-Bildelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertInlineImage(childIndex, image)

Fügt den angegebenen InlineImage in den angegebenen Index ein.

Parameter

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

Return

InlineImage: das eingefügte Inline-Bildelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertPageBreak(childIndex)

Erstellt einen neuen PageBreak und fügt ihn 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

Return

PageBreak – das neue Seitenumbruchelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertPageBreak(childIndex, pageBreak)

Fügt den angegebenen PageBreak in den 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
pageBreakPageBreakdie einzufügende Seite

Return

PageBreak: das eingefügte Seitenumbruchelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 im angegebenen Index ein.

Parameter

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

Return

Text – das neue Textelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 im angegebenen Index ein.

Parameter

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

Return

Text: das eingefügte Textelement

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isAtDocumentEnd()

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isLeftToRight()

Ruft die rechtsläufige Einstellung ab.

Return

Boolean: die rechtsläufige Einstellung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 derselben ElementType können zusammengeführt werden. Alle untergeordneten Elemente, die im aktuellen Element enthalten sind, 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();

Return

ListItem: Das zusammengeführte Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Return

ListItem: Das entfernte Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

removePositionedImage(id)

Entfernt PositionedImage anhand der Bild-ID.

Parameter

NameTypBeschreibung
idString

Return

Boolean: Gibt an, ob das angegebene Bild entfernt wurde

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 mithilfe regulärer Ausdrücke durch einen bestimmten Ersatzstring.

Das Suchmuster wird als String und nicht als JavaScript-Objekt für reguläre Ausdrücke übergeben. Aus diesem Grund müssen Sie umgekehrte Schrägstriche im Muster mit Escapezeichen versehen.

Bei dieser Methode wird die RE2 von Google für reguläre Ausdrücke verwendet, die die unterstützte Syntax begrenzt.

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

var body = DocumentApp.getActiveDocument().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 als Ersatz zu verwendenden Text

Return

Element – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setAlignment(alignment)

Legt HorizontalAlignment fest.

Parameter

NameTypBeschreibung
alignmentHorizontalAlignmenthorizontale Ausrichtung

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 DocumentApp.Attribute-Aufzählung und jeder Attributwert der neue Wert ist, der angewendet werden soll.

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.

Return

ListItem: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setGlyphType(glyphType)

Legt den GlyphType des Listeneintrags fest

Parameter

NameTypBeschreibung
glyphTypeGlyphTypeder Symboltyp

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
indentEndNumberder Einzug am Ende in Punkten

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
indentFirstLineNumberEinrückung der ersten Zeile in Punkten

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
indentStartNumberden Einzug am Anfang in Punkten

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setLeftToRight(leftToRight)

Legt die rechtsläufige Einstellung fest.

Parameter

NameTypBeschreibung
leftToRightBooleandie Einstellung „Links nach rechts“

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setLineSpacing(multiplier)

Legt den Zeilenabstand fest. Er gibt die Anzahl der Zeilen an, die für den Abstand verwendet werden sollen.

Parameter

NameTypBeschreibung
multiplierNumberdie Anzahl der Zeilen

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 wird für die angegebene ListItem auf denselben Wert festgelegt. Die beiden ListItems werden als Mitglieder derselben Liste behandelt.

Parameter

NameTypBeschreibung
listItemListItemListeneintrag, dessen Listen-ID verwendet werden soll

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setNestingLevel(nestingLevel)

Legt die Verschachtelungsebene des Listenelements fest.

Die Verschachtelungsebene von Listenelementen ist standardmäßig null. Die Verschachtelungsebene bestimmt das Symbol, das vom Listenelement verwendet wird.

Parameter

NameTypBeschreibung
nestingLevelIntegerVerschachtelungsebene

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
spacingAfterNumberder Abstand nach dem Element, in Punkten

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setText(text)

Legt den Inhalt des Listenelements als Text fest.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringden neuen Textinhalt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 anzuwendenden Textausrichtung

Return

ListItem – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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