Class DocumentTab

Fügt am 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

Rückflug

Bookmark: Das neue Lesezeichen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Fügt einen Tab-Footerbereich 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: Die Tab-Fußzeile.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Fügt einen Tab-Header-Abschnitt 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: Die Tab-Überschrift.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Fügt ein NamedRange hinzu, das ein Range mit einem Namen und einer ID ist, die für den späteren Abruf verwendet werden können. Namen sind nicht unbedingt eindeutig, auch nicht tabellenübergreifend. Mehrere Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, wie eine ID in HTML. Nachdem Sie eine NamedRange hinzugefügt haben, können Sie sie nicht mehr ändern, sondern nur entfernen.

Jedes Skript, das auf den Tab zugreift, kann auf eine NamedRange zugreifen. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie 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

Rückflug

NamedRange – Die NamedRange.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft die Body des Tabs ab.

Tabs können verschiedene Arten von Abschnitten enthalten, z. B. HeaderSection und 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 Textbereich des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft das Bookmark mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn kein Bookmark auf diesem Tab 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();

// 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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft den Fußzeilenbereich 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|null: Die Fußzeile des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft alle Footnote-Elemente im Tab-Body ab.

Bei Aufrufen von getFootnotes wird eine Iteration über die Elemente des Tabs ausgeführt. 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[]|null: Die Fußnoten des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft den Headerbereich des Tabs ab, falls er 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();

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

Rückflug

HeaderSection|null: Der Header des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft das NamedRange mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn es auf dem Tab keine solche NamedRange gibt. Namen sind nicht unbedingt eindeutig, auch nicht über Tabs hinweg. Mehrere 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, wie eine ID in HTML.

Parameter

Rückflug

NamedRange|null: Der NamedRange mit der angegebenen ID oder null, wenn es keinen solchen Bereich auf dem Tab gibt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft alle NamedRange-Objekte auf dem Tab ab.

Auf eine NamedRange kann von jedem Skript zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen ein eindeutiges Präfix voranstellen.

Rückflug

NamedRange[]: Ein Array der NamedRange-Objekte auf dem Tab, das möglicherweise mehrere Bereiche mit demselben Namen enthält.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Ruft alle NamedRange-Objekte auf dem Tab mit dem angegebenen Namen ab. Namen sind nicht unbedingt eindeutig, auch nicht über Tabs hinweg. Mehrere Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, wie eine ID in HTML.

Auf eine NamedRange kann von jedem Skript zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen ein eindeutiges Präfix voranstellen.

Parameter

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Erstellt ein neues Position, das eine Referenz auf eine Position auf dem Tab relativ zu einem bestimmten Element ist. 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

Rückflug

Position – Die neue Position.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Erstellt einen Builder, mit dem Range-Objekte aus Tab-Elementen 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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