Esta página foi traduzida pela API Cloud Translation.

Class DocumentTab

Uma guia de documento com rich text e elementos como tabelas e listas.

Recupere a guia de um documento usando Document.getTabs()[tabIndex].asDocumentTab().

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

Métodos

Método	Tipo de retorno	Breve descrição
`addBookmark(position)`	`Bookmark`	Adiciona um `Bookmark` ao `Position` especificado.
`addFooter()`	`FooterSection`	Adiciona uma seção de rodapé da guia, se não existir uma.
`addHeader()`	`HeaderSection`	Adiciona uma seção de cabeçalho de guia, se não existir uma.
`addNamedRange(name, range)`	`NamedRange`	Adiciona um `NamedRange`, que é uma `Range` com um nome e um ID para usar para recuperação posterior.
`getBody()`	`Body`	Recupera o `Body` da guia.
`getBookmark(id)`	`Bookmark`	Recebe o `Bookmark` com o ID fornecido.
`getBookmarks()`	`Bookmark[]`	Recebe todos os `Bookmark` objetos na guia.
`getFooter()`	`FooterSection`	Recupera a seção de rodapé da guia, se houver.
`getFootnotes()`	`Footnote[]`	Recupera todos os elementos `Footnote` no corpo da guia.
`getHeader()`	`HeaderSection`	Recupera a seção de cabeçalho da guia, se houver uma.
`getNamedRangeById(id)`	`NamedRange`	Recebe o `NamedRange` com o ID fornecido.
`getNamedRanges()`	`NamedRange[]`	Recebe todos os `NamedRange` objetos na guia.
`getNamedRanges(name)`	`NamedRange[]`	Recebe todos os objetos `NamedRange` na guia com o nome fornecido.
`newPosition(element, offset)`	`Position`	Cria um novo `Position`, que é uma referência a um local na guia, em relação a um um elemento específico.
`newRange()`	`RangeBuilder`	Cria um builder usado para construir objetos `Range` a partir de elementos de guia.

Documentação detalhada

`addBookmark(position)`

Adiciona um Bookmark ao Position especificado.

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

Parâmetros

Nome	Tipo	Descrição
`position`	`Position`	A posição do novo favorito.

Retornar

Bookmark: o novo favorito.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`addFooter()`

Adiciona uma seção de rodapé da guia, se não existir uma.

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

Retornar

FooterSection: rodapé da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`addHeader()`

Adiciona uma seção de cabeçalho de guia, se não existir uma.

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

Retornar

HeaderSection: o cabeçalho da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`addNamedRange(name, range)`

Adiciona um NamedRange, que é uma Range com um nome e um ID para usar para recuperação posterior. Os nomes não são necessariamente exclusivos, mesmo entre guias. vários intervalos diferentes do mesmo documento podem ter o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos dentro do documento, como um ID em HTML. Depois de adicionar uma NamedRange, não é possível modificá-la, só poderá removê-la.

Qualquer script que acesse a guia pode acessar um NamedRange. Para evitar problemas conflitos entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.

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

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome do intervalo, que não precisa ser exclusivo. os nomes de intervalos devem ser entre 1 e 256 caracteres.
`range`	`Range`	O intervalo de elementos a serem associados ao nome. o intervalo pode ser um resultado da pesquisa ou construído manualmente com `newRange()`.

Retornar

NamedRange — O NamedRange.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getBody()`

Recupera o Body da guia.

As guias podem conter diferentes tipos de seções (por exemplo, HeaderSection, FooterSection). A seção ativa de uma guia é o Body.

Os métodos de elemento na DocumentTab delegam para o 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(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());

Retornar

Body: a seção do corpo da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getBookmark(id)`

Recebe o Bookmark com o ID fornecido. Esse método retornará null se essa Bookmark não existir na guia.

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

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O ID da `Bookmark`.

Retornar

Bookmark: o Bookmark com o ID fornecido. Caso contrário, o Bookmark não inclui null. existe na guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getBookmarks()`

Recebe todos os Bookmark objetos na guia.

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

Retornar

Bookmark[]: uma matriz dos objetos Bookmark na guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getFooter()`

Recupera a seção de rodapé da guia, se houver.

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

Retornar

FooterSection: o rodapé da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getFootnotes()`

Recupera todos os elementos Footnote no corpo da guia.

As chamadas para getFootnotes causam uma iteração nos elementos da guia. Para guias grandes, evitar chamadas desnecessárias a esse método.

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

Retornar

Footnote[]: as notas de rodapé da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getHeader()`

Recupera a seção de cabeçalho da guia, se houver uma.

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

Retornar

HeaderSection: o cabeçalho da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getNamedRangeById(id)`

Recebe o NamedRange com o ID fornecido. Esse método retorna null se nenhum NamedRange existe na guia. Os nomes não são necessariamente exclusivos, mesmo entre guias. vários intervalos diferentes no mesmo documento podem ter o mesmo nome, como uma classe em HTML. Em contrapartida, os IDs são exclusivos na guia, como um ID em HTML.

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O ID do intervalo, que é exclusivo na guia.

Retornar

NamedRange: o NamedRange com o ID fornecido, ou null se esse intervalo não existir em guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getNamedRanges()`

Recebe todos os NamedRange objetos na guia.

Uma NamedRange pode ser acessada por qualquer script que acesse a guia. Para evitar conflitos não intencionais entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.

Retornar

NamedRange[]: uma matriz dos objetos NamedRange na guia, possivelmente incluindo vários intervalos com o mesmo nome.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getNamedRanges(name)`

Recebe todos os objetos NamedRange na guia com o nome fornecido. Os nomes não são necessariamente exclusivos, mesmo entre guias; vários intervalos diferentes no mesmo documento podem compartilhar o mesmo bem como uma classe em HTML. Por outro lado, os IDs são exclusivos na guia, como um ID em HTML.

Uma NamedRange pode ser acessada por qualquer script que acesse a guia. Para evitar conflitos não intencionais entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome do intervalo, que não é necessariamente exclusivo.

Retornar

NamedRange[]: uma matriz dos objetos NamedRange na guia com o nome determinado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`newPosition(element, offset)`

Cria um novo Position, que é uma referência a um local na guia, em relação a um um elemento específico. O cursor do usuário é representado como Position, entre outros usos.

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

Parâmetros

Nome	Tipo	Descrição
`element`	`Element`	O elemento que contém o `Position` recém-criado para: isso deve ser um elemento `Text` ou um elemento de contêiner, como `Paragraph`.
`offset`	`Integer`	Para elementos `Text`, o número de caracteres antes de `Position`. para outros elementos, o número de elementos filhos antes de `Position` dentro do mesmo elemento de contêiner.

Retornar

Position: o novo Position.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`newRange()`

Cria um builder usado para construir objetos Range a partir de elementos de guia.

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

Retornar

RangeBuilder: o novo builder.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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