Diese Seite wurde von der Cloud Translation API übersetzt.

Class TableOfContents

Ein Element, das ein Inhaltsverzeichnis enthält. Ein TableOfContents kann ListItem-, Paragraph- und Table-Elemente enthalten, wobei der Inhalt eines TableOfContents-Elements normalerweise automatisch von Google Docs generiert wird. Weitere Informationen zu erhalten Sie im Leitfaden zur um Google Docs zu erweitern.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`clear()`	`TableOfContents`	Löscht den Inhalt des Elements.
`copy()`	`TableOfContents`	Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
`editAsText()`	`Text`	Ruft eine `Text`-Version des aktuellen Elements zur Bearbeitung ab.
`findElement(elementType)`	`RangeElement`	Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
`findElement(elementType, from)`	`RangeElement`	Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: `RangeElement`.
`findText(searchPattern)`	`RangeElement`	Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
`findText(searchPattern, from)`	`RangeElement`	Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
`getAttributes()`	`Object`	Ruft die Attribute des Elements ab.
`getChild(childIndex)`	`Element`	Ruft das untergeordnete Element im angegebenen untergeordneten Index ab.
`getChildIndex(child)`	`Integer`	Ruft den untergeordneten Index für das angegebene untergeordnete Element ab
`getLinkUrl()`	`String`	Ruft die Link-URL ab.
`getNextSibling()`	`Element`	Ruft das nächste gleichgeordnete Element des Elements ab
`getNumChildren()`	`Integer`	Ruft die Anzahl der untergeordneten Elemente ab.
`getParent()`	`ContainerElement`	Ruft das übergeordnete Element des Elements ab.
`getPreviousSibling()`	`Element`	Ruft das vorherige gleichgeordnete Element des Elements ab
`getText()`	`String`	Ruft den Inhalt des Elements als Textstring ab.
`getTextAlignment()`	`TextAlignment`	Ruft die Textausrichtung ab.
`getType()`	`ElementType`	Ruft den `ElementType` des Elements ab.
`isAtDocumentEnd()`	`Boolean`	Bestimmt, ob sich das Element am Ende von `Document` befindet.
`removeFromParent()`	`TableOfContents`	Entfernt das Element aus dem übergeordneten Element.
`replaceText(searchPattern, replacement)`	`Element`	Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
`setAttributes(attributes)`	`TableOfContents`	Legt die Attribute des Elements fest.
`setLinkUrl(url)`	`TableOfContents`	Legt die Link-URL fest.
`setTextAlignment(textAlignment)`	`TableOfContents`	Legt die Textausrichtung fest.

Detaillierte Dokumentation

`clear()`

Löscht den Inhalt des Elements.

Rückflug

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

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

Name	Typ	Beschreibung
`elementType`	`ElementType`	Der 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

Name	Typ	Beschreibung
`elementType`	`ElementType`	Der Elementtyp, nach dem gesucht werden soll.
`from`	`RangeElement`	Das 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

Name	Typ	Beschreibung
`searchPattern`	`String`	Muster, 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

Name	Typ	Beschreibung
`searchPattern`	`String`	Muster, nach dem gesucht werden soll
`from`	`RangeElement`	das 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

Name	Typ	Beschreibung
`childIndex`	`Integer`	Der 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

Name	Typ	Beschreibung
`child`	`Element`	Das 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

`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

`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

`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

`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

`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

`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

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

Name	Typ	Beschreibung
`searchPattern`	`String`	das Regex-Muster, nach dem gesucht werden soll
`replacement`	`String`	den 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

Name	Typ	Beschreibung
`attributes`	`Object`	Die Attribute des Elements.

Rückflug

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

Name	Typ	Beschreibung
`url`	`String`	die Link-URL

Rückflug

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

Name	Typ	Beschreibung
`textAlignment`	`TextAlignment`	Die Art der anzuwendenden Textausrichtung

Rückflug

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