Diese Seite wurde von der Cloud Translation API übersetzt.

Class DocumentTab

Tab

Ein Dokumenttab mit umfangreichem Text und Elementen wie Tabellen und Listen.

Rufen Sie einen Dokumenttab mit Document.getTabs()[tabIndex].asDocumentTab() ab.

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`addBookmark(position)`	`Bookmark`	Fügt an der angegebenen `Position` ein `Bookmark` hinzu.
`addFooter()`	`FooterSection`	Fügen Sie einen Tab-Fußbereich hinzu, falls noch keiner vorhanden ist.
`addHeader()`	`HeaderSection`	Fügen Sie einen Tab-Header hinzu, falls noch keiner vorhanden ist.
`addNamedRange(name, range)`	`NamedRange`	Hier wird eine `NamedRange` hinzugefügt. Das ist eine `Range` mit einem Namen und einer ID, die für den späteren Abruf verwendet werden.
`getBody()`	`Body`	Ruft die `Body` des Tabs ab.
`getBookmark(id)`	`Bookmark`	Ruft den `Bookmark` mit der angegebenen ID ab.
`getBookmarks()`	`Bookmark[]`	Ruft alle `Bookmark`-Objekte auf dem Tab ab.
`getFooter()`	`FooterSection`	Ruft den Fußbereich des Tabs ab, falls vorhanden.
`getFootnotes()`	`Footnote[]`	Ruft alle `Footnote`-Elemente im Tab-Text ab.
`getHeader()`	`HeaderSection`	Ruft den Kopfbereich des Tabs ab, falls vorhanden.
`getNamedRangeById(id)`	`NamedRange`	Ruft den `NamedRange` mit der angegebenen ID ab.
`getNamedRanges()`	`NamedRange[]`	Ruft alle `NamedRange`-Objekte auf dem Tab ab.
`getNamedRanges(name)`	`NamedRange[]`	Ruft alle `NamedRange`-Objekte auf dem Tab mit dem angegebenen Namen ab.
`newPosition(element, offset)`	`Position`	Erstellt eine neue `Position`, die einen Verweis auf eine Position auf dem Tab relativ zu einem bestimmten Element darstellt.
`newRange()`	`RangeBuilder`	Erstellt einen Builder, mit dem `Range`-Objekte aus Tabelementen erstellt werden.

Detaillierte Dokumentation

`addBookmark(position)`

Fügt an der angegebenen Position ein Bookmark hinzu.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Parameter

Name	Typ	Beschreibung
`position`	`Position`	Die Position des neuen Lesezeichens.

Rückflug

Bookmark – das neue Lesezeichen.

Autorisierung

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

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

`addFooter()`

Fügen Sie einen Tab-Fußbereich hinzu, falls noch keiner vorhanden ist.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Rückflug

FooterSection: Tab-Fußzeile

Autorisierung

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

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

`addHeader()`

Fügen Sie einen Tab-Header hinzu, falls noch keiner vorhanden ist.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Rückflug

HeaderSection: Tab-Überschrift.

Autorisierung

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

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

`addNamedRange(name, range)`

Hier wird eine NamedRange hinzugefügt. Das ist eine Range mit einem Namen und einer ID, die für den späteren Abruf verwendet werden. Namen müssen nicht unbedingt eindeutig sein, auch nicht auf verschiedenen Tabs. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML. Nachdem Sie eine NamedRange hinzugefügt haben, können Sie sie nicht mehr ändern, sondern nur noch entfernen.

Jedes Script, das auf den Tab zugreift, kann auf eine NamedRange zugreifen. Um unbeabsichtigte Konflikte zwischen Scripts zu vermeiden, sollten Sie den Bereichsnamen ein eindeutiges Präfix voranstellen.

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

Parameter

Name	Typ	Beschreibung
`name`	`String`	Der Name des Bereichs, der nicht eindeutig sein muss. Bereichsnamen müssen zwischen 1 und 256 Zeichen lang sein.
`range`	`Range`	Der Bereich der Elemente, die mit dem Namen verknüpft werden sollen. Der Bereich kann ein Suchergebnis sein oder manuell mit `newRange()` erstellt werden.

Rückflug

NamedRange – Der NamedRange.

Autorisierung

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

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

`getBody()`

Ruft die Body des Tabs ab.

Tabs können verschiedene Arten von Abschnitten enthalten (z. B. HeaderSection, FooterSection). Der aktive Abschnitt für einen Tab ist der Body.

Elementmethoden in DocumentTab werden an Body delegiert.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Rückflug

Body: Der Inhaltsbereich des Tabs.

Autorisierung

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

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

`getBookmark(id)`

Ruft den Bookmark mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn es auf diesem Tab keine solche Bookmark gibt.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its
// position to the console. Otherwise, logs 'No bookmark exists with the given
// ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parameter

Name	Typ	Beschreibung
`id`	`String`	Die ID der `Bookmark`.

Rückflug

Bookmark: Der Bookmark mit der angegebenen ID oder null, wenn auf dem Tab kein solcher Bookmark vorhanden ist.

Autorisierung

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

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

`getBookmarks()`

Ruft alle Bookmark-Objekte auf dem Tab ab.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Rückflug

Bookmark[]: Ein Array der Bookmark-Objekte auf dem Tab.

Autorisierung

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

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

`getFooter()`

Ruft den Fußbereich des Tabs ab, falls vorhanden.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

Rückflug

FooterSection: Fußzeile des Tabs.

Autorisierung

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

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

`getFootnotes()`

Ruft alle Footnote-Elemente im Tab-Text ab.

Aufrufe von getFootnotes führen zu einer Iteration über die Elemente des Tabs. Bei großen Tabs sollten Sie unnötige Aufrufe dieser Methode vermeiden.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Rückflug

Footnote[]: Die Fußnoten des Tabs.

Autorisierung

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

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

`getHeader()`

Ruft den Kopfbereich des Tabs ab, falls vorhanden.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

Rückflug

HeaderSection: Der Tab-Header.

Autorisierung

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

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

`getNamedRangeById(id)`

Ruft den NamedRange mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn auf dem Tab keine solche NamedRange vorhanden ist. Namen müssen nicht unbedingt eindeutig sein, auch nicht auf verschiedenen Tabs. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML.

Parameter

Name	Typ	Beschreibung
`id`	`String`	Die ID des Bereichs, die innerhalb des Tabs eindeutig ist.

Rückflug

NamedRange: Der NamedRange mit der angegebenen ID oder null, wenn auf dem Tab kein solcher Bereich vorhanden ist.

Autorisierung

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

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

`getNamedRanges()`

Ruft alle NamedRange-Objekte auf dem Tab ab.

Auf eine NamedRange kann über jedes Script zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Scripts zu vermeiden, sollten Sie Bereichsnamen mit einem eindeutigen String vorangestellt.

Rückflug

NamedRange[]: Ein Array der NamedRange-Objekte auf dem Tab, möglicherweise mit mehreren Bereichen mit demselben Namen.

Autorisierung

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

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

`getNamedRanges(name)`

Ruft alle NamedRange-Objekte auf dem Tab mit dem angegebenen Namen ab. Namen müssen nicht unbedingt eindeutig sein, auch nicht auf verschiedenen Tabs. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML.

Parameter

Name	Typ	Beschreibung
`name`	`String`	Der Name des Bereichs, der nicht unbedingt eindeutig sein muss.

Rückflug

NamedRange[]: Ein Array der NamedRange-Objekte auf dem Tab mit dem angegebenen Namen.

Autorisierung

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

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

`newPosition(element, offset)`

Erstellt eine neue Position, die einen Verweis auf eine Position auf dem Tab relativ zu einem bestimmten Element darstellt. Der Cursor des Nutzers wird unter anderem als Position dargestellt.

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

Name	Typ	Beschreibung
`element`	`Element`	Das Element, das das neu erstellte `Position` enthält. Dies muss entweder ein `Text`-Element oder ein Containerelement wie `Paragraph` sein.
`offset`	`Integer`	Bei `Text`-Elementen ist es die Anzahl der Zeichen vor dem `Position`. Bei anderen Elementen ist es die Anzahl der untergeordneten Elemente vor dem `Position` innerhalb desselben Containerelements.

Rückflug

Position – die neue Position.

Autorisierung

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

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

`newRange()`

Erstellt einen Builder, mit dem Range-Objekte aus Tabelementen erstellt werden.

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Rückflug

RangeBuilder – der neue Builder.

Autorisierung

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

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