Class DocumentTab

Ajoute un Bookmark au Position donné.

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

Paramètres

Renvois

Bookmark : nouveau signet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Ajoute une section de pied de page à l'onglet, si elle n'existe pas.

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

Renvois

FooterSection : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Ajoute une section d'en-tête d'onglet, si aucune n'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 header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Renvois

HeaderSection : en-tête de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Ajoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure. Les noms ne sont pas nécessairement uniques, même dans les différents onglets. Plusieurs plages différentes d'un même document peuvent partager le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans le document, comme un ID en HTML. Une fois que vous avez ajouté un NamedRange, vous ne pouvez pas le modifier. Vous ne pouvez que le supprimer.

Tout script qui accède à l'onglet peut accéder à un NamedRange. Pour éviter les conflits involontaires entre les scripts, pensez à ajouter un préfixe unique aux noms de plages.

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

Paramètres

Renvois

NamedRange : le NamedRange.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère le Body de l'onglet.

Les onglets peuvent contenir différents types de sections (par exemple, HeaderSection, FooterSection). La section active d'un onglet est Body.

Les méthodes d'élément dans DocumentTab sont déléguées à 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());

Renvois

Body : section du corps de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère le Bookmark avec l'ID donné. Cette méthode renvoie null si aucun Bookmark de ce type n'existe dans cet onglet.

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

Paramètres

Renvois

Bookmark|null : Bookmark avec l'ID donné, ou null si aucun Bookmark de ce type n'existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère tous les objets Bookmark de l'onglet.

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

Renvois

Bookmark[] : tableau des objets Bookmark dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère la section de pied de page de l'onglet, le cas échéant.

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

Renvois

FooterSection|null : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère tous les éléments Footnote du corps de l'onglet.

Les appels à getFootnotes entraînent une itération sur les éléments de l'onglet. Pour les grands onglets, évitez les appels inutiles à cette méthode.

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

Renvois

Footnote[]|null : notes de bas de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère la section d'en-tête de l'onglet, le cas échéant.

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

Renvois

HeaderSection|null : en-tête de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère le NamedRange avec l'ID donné. Cette méthode renvoie null si aucun NamedRange de ce type n'existe dans l'onglet. Les noms ne sont pas nécessairement uniques, même dans les différents onglets. Plusieurs plages différentes d'un même document peuvent partager le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans l'onglet, comme un ID en HTML.

Paramètres

Renvois

NamedRange|null : NamedRange avec l'ID donné, ou null si aucune plage de ce type n'existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère tous les objets NamedRange de l'onglet.

Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter les conflits involontaires entre les scripts, pensez à faire précéder les noms de plages d'une chaîne unique.

Renvois

NamedRange[] : tableau des objets NamedRange dans l'onglet, pouvant inclure plusieurs plages portant le même nom.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Récupère tous les objets NamedRange de l'onglet portant le nom spécifié. Les noms ne sont pas nécessairement uniques, même dans les onglets. Plusieurs plages différentes dans le même document peuvent partager le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans l'onglet, comme un ID en HTML.

Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter les conflits involontaires entre les scripts, pensez à faire précéder les noms de plages d'une chaîne unique.

Paramètres

Renvois

NamedRange[] : tableau des objets NamedRange dans l'onglet portant le nom spécifié.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Crée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à un élément spécifique. Le curseur de l'utilisateur est représenté par un Position, entre autres utilisations.

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

Paramètres

Renvois

Position : le nouveau Position.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Crée un compilateur utilisé pour construire des objets Range à partir d'éléments d'onglet.

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

Renvois

RangeBuilder : le nouveau compilateur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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