Class DocumentTab  |  Apps Script  |  Google for Developers (original) (raw)

Skip to main content

Class DocumentTab

Stay organized with collections Save and categorize content based on your preferences.

DocumentTab

A document tab, containing rich text and elements such as tables and lists.

Retrieve a document tab using Document.getTabs()[tabIndex].asDocumentTab().

// 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();

Detailed documentation

addBookmark(position)

Adds a [Bookmark](/apps-script/reference/document/bookmark) at the given [Position](/apps-script/reference/document/position).

// 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());

Parameters

Name Type Description
position Position The position of the new bookmark.

Return

[Bookmark](/apps-script/reference/document/bookmark) — The new bookmark.

Scripts that use this method require authorization with one or more of the following scopes:

addNamedRange(name, range)

Adds a [NamedRange](/apps-script/reference/document/named-range), which is a [Range](/apps-script/reference/document/range) that has a name and ID to use for later retrieval. Names aren't necessarily unique, even across tabs; several different ranges in the same document can share the same name, much like a class in HTML. By contrast, IDs are unique within the document, like an ID in HTML. After you add a NamedRange you can't modify it, you can only remove it.

Any script that accesses the tab can access a NamedRange. To avoid unintended conflicts between scripts, consider prefixing range names with a unique string.

// 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());

Parameters

Name Type Description
name String The name for the range, which doesn't need to be unique; range names must be between 1-256 characters.
range Range The range of elements to associate with the name; the range can be a search result or manually constructed with newRange().

Return

[NamedRange](/apps-script/reference/document/named-range) — The NamedRange.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getBody()

Retrieves the tab's [Body](/apps-script/reference/document/body).

Tabs may contain different types of sections (for example, [HeaderSection](/apps-script/reference/document/header-section), [FooterSection](/apps-script/reference/document/footer-section)). The active section for a tab is the [Body](/apps-script/reference/document/body).

Element methods in DocumentTab delegate to the [Body](/apps-script/reference/document/body).

// 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());

Return

[Body](/apps-script/reference/document/body) — The tab's body section.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getBookmark(id)

Gets the [Bookmark](/apps-script/reference/document/bookmark) with the given ID. This method returns null if no such Bookmark exists within this tab.

// 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.'); }

Parameters

Name Type Description
id String The ID for the Bookmark.

Return

[Bookmark](/apps-script/reference/document/bookmark) — The Bookmark with the given ID, or null if no such Bookmark exists within the tab.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getBookmarks()

Gets all [Bookmark](/apps-script/reference/document/bookmark) objects in the tab.

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

Return

[Bookmark[]](/apps-script/reference/document/bookmark) — An array of the Bookmark objects in the tab.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getNamedRangeById(id)

Gets the [NamedRange](/apps-script/reference/document/named-range) with the given ID. This method returns null if no suchNamedRange exists in the tab. Names are not necessarily unique, even across tabs; several different ranges in the same document may share the same name, much like a class in HTML. By contrast, IDs are unique within the tab, like an ID in HTML.

Parameters

Name Type Description
id String The range's ID, which is unique within the tab.

Return

[NamedRange](/apps-script/reference/document/named-range) — The NamedRange with the given ID, or null if no such range exists in the tab.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getNamedRanges()

Gets all [NamedRange](/apps-script/reference/document/named-range) objects in the tab.

A NamedRange can be accessed by any script that accesses the tab. To avoid unintended conflicts between scripts, consider prefixing range names with a unique string.

Return

[NamedRange[]](/apps-script/reference/document/named-range) — An array of the NamedRange objects in the tab, possibly including multiple ranges with the same name.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getNamedRanges(name)

Gets all [NamedRange](/apps-script/reference/document/named-range) objects in the tab with the given name. Names are not necessarily unique, even across tabs; several different ranges in the same document may share the same name, much like a class in HTML. By contrast, IDs are unique within the tab, like an ID in HTML.

A NamedRange can be accessed by any script that accesses the tab. To avoid unintended conflicts between scripts, consider prefixing range names with a unique string.

Parameters

Name Type Description
name String The range's name, which is not necessarily unique.

Return

[NamedRange[]](/apps-script/reference/document/named-range) — An array of the NamedRange objects in the tab with the given name.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

newPosition(element, offset)

Creates a new [Position](/apps-script/reference/document/position), which is a reference to a location in the tab, relative to a specific element. The user's cursor is represented as a Position, among other uses.

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

Parameters

Name Type Description
element Element The element that contains the newly created Position to; this must be either a Text element or a container element like Paragraph.
offset Integer For Text elements, the number of characters before the Position; for other elements, the number of child elements before the Position within the same container element.

Return

[Position](/apps-script/reference/document/position) — The new Position.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

newRange()

Creates a builder used to construct [Range](/apps-script/reference/document/range) objects from tab elements.

// 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());

Return

[RangeBuilder](/apps-script/reference/document/range-builder) — The new builder.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-02 UTC.