Se usó la API de Cloud Translation para traducir esta página.

Class DocumentTab

Una pestaña de documento que contiene texto enriquecido y elementos como tablas y listas.

Recupera una pestaña de documento con 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();

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addBookmark(position)`	`Bookmark`	Agrega un `Bookmark` en el `Position` determinado.
`addFooter()`	`FooterSection`	Agrega una sección de pie de página de la pestaña, si no existe.
`addHeader()`	`HeaderSection`	Agrega una sección de encabezado de pestaña, si no existe ninguna.
`addNamedRange(name, range)`	`NamedRange`	Agrega un `NamedRange`, que es un `Range` que tiene un nombre y un ID para usar en la recuperación posterior.
`getBody()`	`Body`	Recupera el `Body` de la pestaña.
`getBookmark(id)`	`Bookmark`	Obtiene el `Bookmark` con el ID determinado.
`getBookmarks()`	`Bookmark[]`	Obtiene todos los objetos `Bookmark` de la pestaña.
`getFooter()`	`FooterSection`	Recupera la sección del pie de página de la pestaña, si existe.
`getFootnotes()`	`Footnote[]`	Recupera todos los elementos `Footnote` en el cuerpo de la pestaña.
`getHeader()`	`HeaderSection`	Recupera la sección de encabezado de la pestaña, si existe.
`getNamedRangeById(id)`	`NamedRange`	Obtiene el `NamedRange` con el ID determinado.
`getNamedRanges()`	`NamedRange[]`	Obtiene todos los objetos `NamedRange` de la pestaña.
`getNamedRanges(name)`	`NamedRange[]`	Obtiene todos los objetos `NamedRange` de la pestaña con el nombre determinado.
`newPosition(element, offset)`	`Position`	Crea una `Position` nueva, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico.
`newRange()`	`RangeBuilder`	Crea un compilador que se usa para construir objetos `Range` a partir de elementos de pestaña.

Documentación detallada

`addBookmark(position)`

Agrega un Bookmark en el Position determinado.

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

Parámetros

Nombre	Tipo	Descripción
`position`	`Position`	Es la posición del favorito nuevo.

Volver

Bookmark: Es el nuevo favorito.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`addFooter()`

Agrega una sección de pie de página de la pestaña, si no existe.

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

Volver

FooterSection: Es el pie de página de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`addHeader()`

Agrega una sección de encabezado de pestaña, si no existe ninguna.

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

Volver

HeaderSection: Es el encabezado de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`addNamedRange(name, range)`

Agrega un NamedRange, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior. Los nombres no son necesariamente únicos, incluso entre pestañas. Varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. Por el contrario, los IDs son únicos dentro del documento, como un ID en HTML. Después de agregar un NamedRange, no puedes modificarlo, solo puedes quitarlo.

Cualquier secuencia de comandos que acceda a la pestaña puede acceder a un NamedRange. Para evitar conflictos imprevistos entre las secuencias de comandos, considera anteponer a los nombres de los rangos una cadena única.

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

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	Es el nombre del rango, que no tiene que ser único. Los nombres de los rangos deben tener entre 1 y 256 caracteres.
`range`	`Range`	Es el rango de elementos que se asociarán con el nombre. El rango puede ser un resultado de la búsqueda o puede crearse manualmente con `newRange()`.

Volver

NamedRange: Es el NamedRange.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getBody()`

Recupera el Body de la pestaña.

Las pestañas pueden contener diferentes tipos de secciones (por ejemplo, HeaderSection, FooterSection). La sección activa de una pestaña es Body.

Los métodos de elementos en DocumentTab delegan a 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());

Volver

Body: Es la sección del cuerpo de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getBookmark(id)`

Obtiene el Bookmark con el ID determinado. Este método muestra null si no existe tal Bookmark en esta pestaña.

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

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	El ID de `Bookmark`.

Volver

Bookmark: Es el Bookmark con el ID determinado o null si no existe tal Bookmark en la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getBookmarks()`

Obtiene todos los objetos Bookmark de la pestaña.

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

Volver

Bookmark[]: Es un array de los objetos Bookmark de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getFooter()`

Recupera la sección del pie de página de la pestaña, si existe.

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

Volver

FooterSection: Es el pie de página de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getFootnotes()`

Recupera todos los elementos Footnote en el cuerpo de la pestaña.

Las llamadas a getFootnotes provocan una iteración sobre los elementos de la pestaña. En el caso de las pestañas grandes, evita las llamadas innecesarias a este 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('123abc').getTab('123abc').asDocumentTab();

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

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

Volver

Footnote[]: Son las notas al pie de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getHeader()`

Recupera la sección de encabezado de la pestaña, si existe.

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

Volver

HeaderSection: Es el encabezado de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getNamedRangeById(id)`

Obtiene el NamedRange con el ID determinado. Este método muestra null si no existe un NamedRange de este tipo en la pestaña. Los nombres no son necesariamente únicos, incluso entre las pestañas. Varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. Por el contrario, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	El ID del rango, que es único dentro de la pestaña

Volver

NamedRange: Es el NamedRange con el ID determinado o null si no existe ese rango en la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getNamedRanges()`

Obtiene todos los objetos NamedRange de la pestaña.

Cualquier secuencia de comandos que acceda a la pestaña puede acceder a un NamedRange. Para evitar conflictos imprevistos entre secuencias de comandos, considera anteponer un prefijo a los nombres de los rangos con una cadena única.

Volver

NamedRange[]: Es un array de los objetos NamedRange de la pestaña, que puede incluir varios rangos con el mismo nombre.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`getNamedRanges(name)`

Obtiene todos los objetos NamedRange de la pestaña con el nombre determinado. Los nombres no son necesariamente únicos, incluso entre pestañas. Varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. Por el contrario, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	Es el nombre del rango, que no es necesariamente único.

Volver

NamedRange[]: Es un array de los objetos NamedRange en la pestaña con el nombre determinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`newPosition(element, offset)`

Crea una Position nueva, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico. El cursor del usuario se representa como un Position, entre otros 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.
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);

Parámetros

Nombre	Tipo	Descripción
`element`	`Element`	El elemento que contiene el `Position` creado recientemente; debe ser un elemento `Text` o un elemento contenedor, como `Paragraph`.
`offset`	`Integer`	Para los elementos `Text`, la cantidad de caracteres antes de `Position`; para otros elementos, la cantidad de elementos secundarios antes de `Position` dentro del mismo elemento contenedor.

Volver

Position: Es el nuevo Position.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

`newRange()`

Crea un compilador que se usa para construir objetos Range a partir de elementos de pestaña.

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

Volver

RangeBuilder: Es el nuevo compilador.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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