Class DocumentTab

DocumentTab

Ein Dokument-Tab, der RTF und Elemente wie Tabellen und Listen enthält.

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.
var documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

Methoden

MethodeRückgabetypKurzbeschreibung
addBookmark(position)BookmarkFügt einen Bookmark am angegebenen Position hinzu.
addFooter()FooterSectionFügt einen Tab-Fußzeilenabschnitt hinzu, falls keiner vorhanden ist.
addHeader()HeaderSectionFügt einen Tab-Header-Abschnitt hinzu, falls keiner vorhanden ist.
addNamedRange(name, range)NamedRangeFügt ein NamedRange hinzu. Dabei handelt es sich um eine Range mit einem Namen und einer ID zur Verwendung für Daten später abgerufen werden.
getBody()BodyRuft den Body des Tabs ab.
getBookmark(id)BookmarkRuft das Bookmark mit der angegebenen ID ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte im Tab ab.
getFooter()FooterSectionRuft den Fußzeilenbereich des Tabs ab, sofern vorhanden.
getFootnotes()Footnote[]Ruft alle Footnote-Elemente im Textkörper des Tabs ab.
getHeader()HeaderSectionRuft den Headerabschnitt des Tabs ab, sofern vorhanden.
getNamedRangeById(id)NamedRangeRuft das NamedRange mit der angegebenen ID ab.
getNamedRanges()NamedRange[]Ruft alle NamedRange-Objekte im Tab ab.
getNamedRanges(name)NamedRange[]Ruft alle NamedRange-Objekte im Tab mit dem angegebenen Namen ab.
newPosition(element, offset)PositionErstellt eine neue Position, die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem spezifisches Element.
newRange()RangeBuilderErstellt einen Builder, der zum Erstellen von Range-Objekten aus Tab-Elementen verwendet wird.

Detaillierte Dokumentation

addBookmark(position)

Fügt einen Bookmark am angegebenen Position 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(DOCUMENT_ID).getTab(TAB_ID).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

NameTypBeschreibung
positionPositionDie Position des neuen Lesezeichens.

Rückflug

Bookmark: Das neue Lesezeichen.

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

addFooter()

Fügt einen Tab-Fußzeilenabschnitt hinzu, falls 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(DOCUMENT_ID).getTab(TAB_ID).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: Der Fußzeile des Tabs.

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

addHeader()

Fügt einen Tab-Header-Abschnitt hinzu, falls 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(DOCUMENT_ID).getTab(TAB_ID).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: Der Header des Tabs.

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

addNamedRange(name, range)

Fügt ein NamedRange hinzu. Dabei handelt es sich um eine Range mit einem Namen und einer ID zur Verwendung für Daten später abgerufen werden. Namen sind nicht unbedingt eindeutig, auch nicht auf anderen Tabs. in verschiedenen Bereichen kann ein Dokument denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig sind, z. B. eine ID in HTML. Nachdem Sie eine NamedRange hinzugefügt haben, ist Folgendes nicht mehr möglich: können Sie sie nur entfernen.

Jedes Skript, das auf den Tab zugreift, kann auf ein NamedRange zugreifen. So vermeiden Sie unbeabsichtigte Konflikten zwischen Skripts besteht, sollten Sie Bereichsnamen eine eindeutige Zeichenfolge voranstellen. 

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

Parameter

NameTypBeschreibung
nameStringDer Name für den Bereich, der nicht eindeutig sein muss. Bereichsnamen müssen zwischen 1 und 256 Zeichen.
rangeRangeDer 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

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

getBody()

Ruft den Body des Tabs ab.

Tabs können verschiedene Arten von Bereichen enthalten, z. B. HeaderSection und FooterSection. Der aktive Bereich für einen Tab ist 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(DOCUMENT_ID).getTab(TAB_ID).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 Textbereich des Tabs.

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

getBookmark(id)

Ruft das Bookmark mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn ein solches Bookmark in diesem Tab nicht 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(DOCUMENT_ID).getTab(TAB_ID).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

NameTypBeschreibung
idStringDie ID für die Bookmark.

Rückflug

Bookmark – Die Bookmark mit der angegebenen ID oder null, wenn keine solche Bookmark vorhanden ist auf dem Tab vorhanden ist.

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

getBookmarks()

Ruft alle Bookmark-Objekte im 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(DOCUMENT_ID).getTab(TAB_ID).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

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

getFooter()

Ruft den Fußzeilenbereich des Tabs ab, sofern 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(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

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

Rückflug

FooterSection: die Fußzeile des Tabs.

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

getFootnotes()

Ruft alle Footnote-Elemente im Textkörper des Tabs ab.

Aufrufe von getFootnotes führen zu einer Iteration der Elemente auf dem Tab. Bei großen Tabs um unnötige Aufrufe dieser Methode zu 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(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

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

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

Rückflug

Footnote[]: Fußnoten des Tabs

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

getHeader()

Ruft den Headerabschnitt des Tabs ab, sofern 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(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

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

Rückflug

HeaderSection: Der Header des Tabs.

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

getNamedRangeById(id)

Ruft das NamedRange mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn keine solche „NamedRange“ ist auf dem Tab vorhanden. Namen sind nicht unbedingt eindeutig, auch nicht über mehrere Tabs hinweg. Verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML: Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML.

Parameter

NameTypBeschreibung
idStringDie Bereichs-ID, die innerhalb des Tabs eindeutig ist.

Rückflug

NamedRange – Die NamedRange mit der angegebenen ID oder null, wenn in der Datei kein solcher Bereich vorhanden ist. auf dem Tab.

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

getNamedRanges()

Ruft alle NamedRange-Objekte im Tab ab.

Ein NamedRange kann von jedem Skript aufgerufen werden, das auf den Tab zugreift. Um dies zu vermeiden unbeabsichtigte Konflikte zwischen Skripts haben, können Sie Bereichsnamen einen eindeutigen String voranstellen.

Rückflug

NamedRange[]: ein Array der NamedRange-Objekte auf dem Tab, möglicherweise einschließlich mehrerer Bereiche mit demselben Namen.

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

getNamedRanges(name)

Ruft alle NamedRange-Objekte im Tab mit dem angegebenen Namen ab. Namen müssen nicht unbedingt unverwechselbar, sogar über mehrere Tabs hinweg. Verschiedene Bereiche im selben Dokument können denselben ähnlich wie bei einer Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, wie eine ID in HTML:

Ein NamedRange kann von jedem Skript aufgerufen werden, das auf den Tab zugreift. Um dies zu vermeiden unbeabsichtigte Konflikte zwischen Skripts haben, können Sie Bereichsnamen einen eindeutigen String voranstellen.

Parameter

NameTypBeschreibung
nameStringDer Name des Bereichs, der nicht unbedingt eindeutig ist.

Rückflug

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

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

newPosition(element, offset)

Erstellt eine neue Position, die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem spezifisches Element. 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.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

NameTypBeschreibung
elementElementDas Element, das die neu erstellte Position enthält. Dies muss entweder ein Text-Element oder ein Containerelement wie Paragraph.
offsetIntegerBei Text-Elementen die Anzahl der Zeichen vor Position. bei anderen Elementen die Anzahl der untergeordneten Elemente vor dem Position im Containerelement.

Rückflug

Position – Das neue Position.

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

newRange()

Erstellt einen Builder, der zum Erstellen von Range-Objekten aus Tab-Elementen verwendet wird. 

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

Rückflug

RangeBuilder: Der neue Builder.

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