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

Class Tab

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

Tab

A tab within a Google Docs document.

// Get all of the first-level tabs (tabs that are not nested within a parent // tab) in the document. // TODO(developer): Replace the ID with your own. const tabs = DocumentApp.openById('123abc').getTabs();

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

Methods

Detailed documentation

asDocumentTab()

getChildTabs()

Retrieves the child tabs nested within this tab.

Return

[Tab[]](#) — The child tabs nested within this tab.

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

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

getId()

Retrieves the ID of the tab.

Return

String — The ID of the tab.

Authorization

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

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

getIndex()

Retrieves the 0-based index of the tab within the parent.

Return

Integer — The index of the tab within the parent.

Authorization

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

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

getTitle()

Retrieves the title of the tab.

Return

String — The title of the tab.

Authorization

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

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

getType()

Retrieves the type of tab.

Use this method to determine the content type of this [Tab](#) before casting to the more specific type using [asDocumentTab()](#asDocumentTab%28%29).

const tab = DocumentApp.getActiveDocument().getActiveTab(); // Use getType() to determine the tab's type before casting. if (tab.getType() === DocumentApp.TabType.DOCUMENT_TAB) { // It's a document tab, write some text to it. tab.asDocumentTab().setText('Hello World!'); } else { // There are currently no types other than DOCUMENT_TAB. }

Return

[TabType](/apps-script/reference/document/tab-type) — The tab's type.

Authorization

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

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

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.