Class FooterSection

FooterSection

Ein Element, das einen Fußzeilenbereich darstellt. Eine Document enthält normalerweise höchstens eine FooterSection. FooterSection kann ListItem, Paragraph und Table-Elemente. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.
appendTable()TableErstellt eine neue Table und hängt sie an.
appendTable(cells)TableHängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält.
appendTable(table)TableHängt die angegebene Table an.
clear()FooterSectionLöscht den Inhalt des Elements.
copy()FooterSectionGibt 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.
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
getImages()InlineImage[]Ruft alle im Abschnitt enthaltenen InlineImages ab.
getListItems()ListItem[]Ruft alle im Abschnitt enthaltenen ListItems ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Ruft alle im Abschnitt enthaltenen Tables 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 eine neue HorizontalRule und fügt sie im angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt den angegebenen ListItem im angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph im angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertTable(childIndex)TableErstellt eine neue Table und fügt sie im angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.
insertTable(childIndex, table)TableFügt den angegebenen Table im angegebenen Index ein.
removeChild(child)FooterSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FooterSectionEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)FooterSectionLegt die Attribute des Elements fest.
setText(text)FooterSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FooterSectionLegt die Textausrichtung fest.

Detaillierte Dokumentation

appendHorizontalRule()

Erstellt eine neue HorizontalRule und hängt sie an.

HorizontalRule wird in einer neuen Paragraph enthalten.

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

appendImage(image)

Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.

Das Bild wird in einem neuen Paragraph enthalten.

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

appendImage(image)

Hängt die angegebene InlineImage an.

InlineImage wird in einer neuen Paragraph enthalten.

Verwenden Sie diese Version von appendImage, wenn Sie eine Kopie einer vorhandenen InlineImage anhängen.

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

appendListItem(listItem)

Hängt die angegebene ListItem an.

Verwenden Sie diese Version von appendListItem, wenn Sie eine Kopie einer vorhandenen ListItem anhängen.

Parameter

NameTypBeschreibung
listItemListItemDer Listeneintrag, der angehängt werden soll.

Rückflug

ListItem: Der angehängte Listeneintrag.

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

appendListItem(text)

Erstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält.

Aufeinanderfolgende Listenelemente werden als Teil derselben Liste hinzugefügt.

Parameter

NameTypBeschreibung
textStringDer Textinhalt des Listenelements.

Rückflug

ListItem: Der neue Listeneintrag.

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

appendParagraph(paragraph)

Hängt die angegebene Paragraph an.

Verwenden Sie diese Version von appendParagraph, wenn Sie eine Kopie einer vorhandenen Paragraph anhängen.

Parameter

NameTypBeschreibung
paragraphParagraphDer hinzuzufügende Absatz.

Rückflug

Paragraph: Der angehängte Absatz.

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

appendParagraph(text)

Erstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.

Parameter

NameTypBeschreibung
textStringDer Textinhalt des Absatzes.

Rückflug

Paragraph: Der neue Absatz.

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

appendTable()

Erstellt eine neue Table und hängt sie an.

Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente darf nicht mit einer Tabelle enden.

Rückflug

Table: Die neue Tabelle.

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

appendTable(cells)

Hängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält.

Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente darf nicht mit einer Tabelle enden.

Parameter

NameTypBeschreibung
cellsString[][]Der Textinhalt der Tabellenzellen, die der neuen Tabelle hinzugefügt werden sollen.

Rückflug

Table: Die angehängte Tabelle.

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

appendTable(table)

Hängt die angegebene Table an.

Verwenden Sie diese Version von appendTable, wenn Sie eine Kopie einer vorhandenen Table anhängen. Bei dieser Methode wird auch ein leerer Absatz nach der Tabelle angehängt, da Google Docs-Dokumente darf nicht mit einer Tabelle enden.

Parameter

NameTypBeschreibung
tableTableDie Tabelle, die angefügt werden soll.

Rückflug

Table: Die angehängte Tabelle.

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

FooterSection: 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

FooterSection: 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

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

getImages()

Ruft alle im Abschnitt enthaltenen InlineImages ab.

Rückflug

InlineImage[]: Die Abschnittsbilder.

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

getListItems()

Ruft alle im Abschnitt enthaltenen ListItems ab.

Rückflug

ListItem[]: Elemente der Abschnittsliste.

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

getParagraphs()

Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).

Rückflug

Paragraph[]: Abschnittsabsätze.

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

getTables()

Ruft alle im Abschnitt enthaltenen Tables ab.

Rückflug

Table[]: Die Abschnittstabellen.

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 eine neue HorizontalRule und fügt sie im angegebenen Index ein.

HorizontalRule wird in einer neuen Paragraph enthalten.

Parameter

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

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

insertImage(childIndex, image)

Erstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem das Element eingefügt werden soll.
imageBlobSourceDie Bilddaten.

Rückflug

InlineImage: Das eingefügte Inline-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

insertImage(childIndex, image)

Fügt den angegebenen InlineImage im angegebenen Index ein.

Das Bild wird in einem neuen Paragraph enthalten.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem das Element eingefügt werden soll.
imageInlineImageDas einzufügende Bild.

Rückflug

InlineImage: Das eingefügte Inline-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

insertListItem(childIndex, listItem)

Fügt den angegebenen ListItem im angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
listItemListItemDer einzufügende Listeneintrag.

Rückflug

ListItem: Der eingefügte Listeneintrag.

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

insertListItem(childIndex, text)

Erstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
textStringDer Textinhalt des Listenelements.

Rückflug

ListItem: Der neue Listeneintrag.

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

insertParagraph(childIndex, paragraph)

Fügt den angegebenen Paragraph im angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
paragraphParagraphDer einzufügende Absatz.

Rückflug

Paragraph: Der eingefügte Absatz.

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

insertParagraph(childIndex, text)

Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
textStringDer Textinhalt des Absatzes.

Rückflug

Paragraph: Der neue Absatz.

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

insertTable(childIndex)

Erstellt eine neue Table und fügt sie im angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.

Rückflug

Table: Die neue Tabelle.

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

insertTable(childIndex, cells)

Erstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
cellsString[][]Der Textinhalt der Tabellenzellen, die der neuen Tabelle hinzugefügt werden sollen.

Rückflug

Table: Die neue Tabelle.

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

insertTable(childIndex, table)

Fügt den angegebenen Table im angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerDer Index, an dem eingefügt werden soll.
tableTableDie einzufügende Tabelle.

Rückflug

Table: Die eingefügte Tabelle.

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

FooterSection: 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

FooterSection: 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

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

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

FooterSection: 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 als Nur-Text fest.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringDen neuen Textinhalt.

Rückflug

FooterSection: 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

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

FooterSection – 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

Verworfene Methoden