Class DocumentTab

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

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 alcances:

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

Agrega una sección de pie de página de la 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 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 alcances:

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

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 alcances:

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

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, ni siquiera entre pestañas. Varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, de forma similar a una clase en HTML. En cambio, los IDs son únicos dentro del documento, como un ID en HTML. Después de agregar un NamedRange, no podrás modificarlo, solo quitarlo.

Cualquier secuencia de comandos que acceda a la pestaña puede acceder a un objeto NamedRange. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con 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

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 alcances:

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

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 la Body.

Los métodos de elementos en DocumentTab delegan en 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 alcances:

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

Obtiene el Bookmark con el ID determinado. Este método devuelve null si no existe tal Bookmark dentro de 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

Volver

Bookmark|null: El Bookmark con el ID determinado o null si no existe tal Bookmark dentro 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 alcances:

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

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 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 alcances:

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

Recupera la sección de 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|null: 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 alcances:

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

Recupera todos los elementos Footnote del 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[]|null: 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 alcances:

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

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|null: 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 alcances:

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

Obtiene el NamedRange con el ID determinado. Este método devuelve null si no existe tal NamedRange en la pestaña. Los nombres no son necesariamente únicos, ni siquiera entre las pestañas. Varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, de manera similar a una clase en HTML. En cambio, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Parámetros

Volver

NamedRange|null: El NamedRange con el ID determinado o null si no existe tal 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 alcances:

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

Obtiene todos los objetos NamedRange de la pestaña.

Se puede acceder a un objeto NamedRange desde cualquier secuencia de comandos que acceda a la pestaña. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.

Volver

NamedRange[]: Es un array de los objetos NamedRange en la pestaña, que posiblemente incluye 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 alcances:

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

Obtiene todos los objetos NamedRange de la pestaña con el nombre determinado. Los nombres no son necesariamente únicos, ni siquiera entre las pestañas; varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, de forma similar a una clase en HTML. En cambio, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Se puede acceder a un objeto NamedRange desde cualquier secuencia de comandos que acceda a la pestaña. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.

Parámetros

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 alcances:

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

Crea un Position nuevo, 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

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 alcances:

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

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

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

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