Class ListItem

ListItem

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

ListItems darf keine Zeilenumbruchzeichen enthalten. Zeilenumbruchzeichen ("\n") sind in Zeilenumbruchzeichen ("\r") konvertiert.

ListItems mit derselben Listen-ID gehören zur selben Liste und sind entsprechend nummeriert. Die ListItems für eine vorgegebene Liste müssen nicht nebeneinander stehen über dasselbe übergeordnete Element. Zwei Elemente, die zur selben Liste gehören, können an einer beliebigen Stelle auf dem Tab vorhanden sein, während fortlaufende Nummerierung beibehalten, wie das folgende Beispiel zeigt:

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 einen neuen PositionedImage und fügt ihn aus dem angegebenen Bild-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendInlineImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt eine neue PageBreak und hängt sie 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 losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung 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 angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAlignment()HorizontalAlignmentRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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 den Endeinzug 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-Objekt anhand der Image-ID ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die im 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 und fügt einen neuen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertInlineImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt eine neue PageBreak und fügt sie im angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt den angegebenen PageBreak im 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 Text am angegebenen Index ein Inhalte.
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 vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeChild(child)ListItemEntfernt das angegebene untergeordnete Element.
removeFromParent()ListItemEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt einen PositionedImage anhand der Image-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAlignment(alignment)ListItemLegt HorizontalAlignment fest.
setAttributes(attributes)ListItemLegt die Attribute des Elements fest.
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)ListItemLegt die Leserichtung von links nach rechts fest.
setLineSpacing(multiplier)ListItemLegt den Zeilenabstand als Wert fest, der die Anzahl der Zeilen angibt, die für den Zeilenabstand 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 einen neuen PositionedImage und fügt ihn aus dem angegebenen Bild-Blob ein.

Parameter

NameTypBeschreibung
imageBlobSourcedie Bilddaten

Rückflug

PositionedImage – das neue 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 eine neue HorizontalRule und hängt sie an.

Rückflug

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 eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.

Parameter

NameTypBeschreibung
imageBlobSourcedie Bilddaten

Rückflug

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

Rückflug

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 eine neue PageBreak und hängt sie an.

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

Rückflug

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
pageBreakPageBreakder anzufügende Seitenumbruch

Rückflug

PageBreak – das angehängte 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

appendText(text)

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

Parameter

NameTypBeschreibung
textStringTextinhalt

Rückflug

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 anzufügende Textelement

Rückflug

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.

Rückflug

ListItem: Das aktuelle Element.


copy()

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

Alle im Element vorhandenen untergeordneten Elemente werden ebenfalls kopiert. Das neue Element hat kein Parent.

Rückflug

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 zur Bearbeitung ab.

Verwenden Sie editAsText, um den Inhalt der Elemente als RTF 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().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)

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

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, 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 angegeben: RangeElement.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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.
fromRangeElementDas Suchergebnis, von dem aus gesucht werden soll.

Rückflug

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 mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.

Einige der JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt. Dazu gehören: Erfassungsgruppen und Modusmodifikatoren.

Das angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock abgeglichen die im aktuellen Element enthalten sind.

Parameter

NameTypBeschreibung
searchPatternStringMuster, nach dem gesucht werden soll

Rückflug

RangeElement: ein Suchergebnis, das die Position des Suchtexts angibt, oder null, wenn kein Übereinstimmung

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 im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.

Einige der JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt. Dazu gehören: Erfassungsgruppen und Modusmodifikatoren.

Das angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock abgeglichen die im aktuellen Element enthalten sind.

Parameter

NameTypBeschreibung
searchPatternStringMuster, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, in dem gesucht werden soll

Rückflug

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

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.

Rückflug

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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, 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 im angegebenen untergeordneten Index ab.

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

// Obtain the first element in the tab.
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
childIndexIntegerDer Index des abzurufenden untergeordneten Elements.

Rückflug

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.

Rückflug

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 die GlyphType des Listenelements ab.

Rückflug

GlyphType – der Glyphentyp

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.

Rückflug

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 Endeinzug in Punkten ab.

Rückflug

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.

Rückflug

Number – 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.

Rückflug

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.

Rückflug

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.

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

Rückflug

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 die Glyphe der vom Listenelement verwendet wird.

Rückflug

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 dasselbe übergeordnete Element und folgt dem aktuellen Element.

Rückflug

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.

var 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

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.

Rückflug

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-Objekt anhand der Image-ID ab.

Parameter

NameTypBeschreibung
idStringBild-ID

Rückflug

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 im Absatz verankert sind.

Rückflug

PositionedImage[] – eine Liste positionierter 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 dasselbe übergeordnete Element und ist dem aktuellen Element vorangestellt.

Rückflug

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.

Rückflug

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.

Rückflug

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.

Rückflug

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.

Rückflug

TextAlignment – die Art der Textausrichtung oder null, wenn der Text mehrere Arten von Text enthält oder wenn die Textausrichtung noch nie

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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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, 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

Rückflug

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 und fügt einen neuen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.

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, 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 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, 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 eine neue PageBreak und fügt sie 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

Rückflug

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 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
pageBreakPageBreakdie Seitenumbruch-Funktion zum Einfügen

Rückflug

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
textStringTextinhalt

Rückflug

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

Parameter

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

Rückflug

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.

Rückflug

Boolean: gibt an, ob sich das Element am Ende des Tabs 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.

Rückflug

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 vorangehenden gleichgeordneten Element desselben Typs zusammen.

Nur Elemente derselben ElementType können zusammengeführt werden. Alle untergeordneten Elemente, die in werden zum vorherigen gleichgeordneten Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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

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,

Rückflug

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 dem übergeordneten Element.

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

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

Rückflug

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 einen PositionedImage anhand der Image-ID.

Parameter

NameTypBeschreibung
idString

Rückflug

Boolean – 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 durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.

Das Suchmuster wird als String übergeben, nicht als JavaScript-Objekt für reguläre Ausdrücke. Daher müssen Sie alle umgekehrten Schrägstriche im Muster mit Escapezeichen versehen.

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

Das angegebene Muster des regulären Ausdrucks wird unabhängig mit jedem Textblock abgeglichen die im aktuellen Element enthalten sind.

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

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

Parameter

NameTypBeschreibung
searchPatternStringdas Regex-Muster, nach dem gesucht werden soll
replacementStringden Text, der als Ersatz verwendet werden soll

Rückflug

Element – das aktuelle Element

Autorisierung

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

Rückflug

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, in dem jeder Eigenschaftsname ein Element in DocumentApp.Attribute und jeder Attributwert ist der neue Wert, angewendet.

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

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 Listenelements fest.

Parameter

NameTypBeschreibung
glyphTypeGlyphTypeder Glyphentyp

Rückflug

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

Rückflug

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
indentEndNumberden Endeinzug in Punkten

Rückflug

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
indentFirstLineNumberEinzug der ersten Zeile in Punkten

Rückflug

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

Rückflug

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 Leserichtung von links nach rechts fest.

Parameter

NameTypBeschreibung
leftToRightBooleandie von links nach rechts

Rückflug

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 als Wert fest, der die Anzahl der Zeilen angibt, die für den Zeilenabstand verwendet werden sollen.

Parameter

NameTypBeschreibung
multiplierNumberdie Anzahl der Zeilen

Rückflug

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

Rückflug

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
listItemListItemdas Listenelement, dessen Listen-ID verwendet werden soll

Rückflug

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 die Glyphe der vom Listenelement verwendet wird.

Parameter

NameTypBeschreibung
nestingLevelIntegerVerschachtelungsebene

Rückflug

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
spacingAfterNumberAbstand nach dem Element in Punkten

Rückflug

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

Rückflug

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 in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NameTypBeschreibung
textAlignmentTextAlignmentDie Art der anzuwendenden Textausrichtung

Rückflug

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