Class DocumentTab

DocumentTab

Un onglet de document contenant du texte enrichi et des éléments tels que des tableaux et des listes.

Récupérez l'onglet d'un document à l'aide de 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éthodes

Méthode	Type renvoyé	Brève description
addBookmark(position)	Bookmark	Ajoute un Bookmark au niveau de l'Position donné.
addFooter()	FooterSection	Ajoute une section de pied d'onglet, le cas échéant.
addHeader()	HeaderSection	Ajoute une section d'en-tête d'onglet, le cas échéant.
addNamedRange(name, range)	NamedRange	Ajoute un NamedRange, qui est un Range dont le nom et l'ID sont à utiliser pour une récupération ultérieure.
getBody()	Body	Récupère l'Body de l'onglet.
getBookmark(id)	Bookmark	Récupère l'élément Bookmark avec l'ID donné.
getBookmarks()	Bookmark[]	Récupère tous les objets Bookmark de l'onglet.
getFooter()	FooterSection	Récupère la section de pied de page de l'onglet, le cas échéant.
getFootnotes()	Footnote[]	Récupère tous les éléments Footnote dans le corps de l'onglet.
getHeader()	HeaderSection	Récupère la section d'en-tête de l'onglet, le cas échéant.
getNamedRangeById(id)	NamedRange	Récupère l'élément NamedRange avec l'ID donné.
getNamedRanges()	NamedRange[]	Récupère tous les objets NamedRange de l'onglet.
getNamedRanges(name)	NamedRange[]	Récupère tous les objets NamedRange de l'onglet portant le nom donné.
newPosition(element, offset)	Position	Crée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à un élément spécifique.
newRange()	RangeBuilder	Crée un compilateur utilisé pour construire des objets Range à partir d'éléments d'onglet.

Documentation détaillée

addBookmark(position)

Ajoute un Bookmark au niveau de l'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(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());

Paramètres

Nom	Type	Description
position	Position	Position du nouveau favori.

Renvois

Bookmark : nouveau favori

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

addFooter()

Ajoute une section de pied d'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(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');

Renvois

FooterSection : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

addHeader()

Ajoute une section d'en-tête d'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(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');

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

addNamedRange(name, range)

Ajoute un NamedRange, qui est un Range dont le nom et l'ID sont à utiliser pour une récupération ultérieure. Les noms ne sont pas nécessairement uniques, même dans les onglets. plusieurs plages différentes dans un même document peut porter le même nom, tout comme une classe en HTML. En revanche, les ID sont unique dans le document, comme un ID en HTML. Après avoir ajouté un NamedRange, vous ne pouvez pas la modifier, vous ne pouvez que la supprimer.

Tout script qui accède à l'onglet peut accéder à un NamedRange. Pour éviter les actions involontaires des conflits entre les scripts, envisagez de faire précéder les noms de plage par une chaîne unique.

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

Paramètres

Nom	Type	Description
name	String	Le nom de la plage, qui n'a pas besoin d'être unique. les noms de plage doivent être comportant entre 1 et 256 caractères.
range	Range	Plage d'éléments à associer au nom. la plage peut être un résultat de recherche ou être créée manuellement avec newRange().

Renvois

NamedRange : NamedRange.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getBody()

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

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

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

Renvois

Body : section du corps de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getBookmark(id)

Récupère l'élément 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(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.');
}

Paramètres

Nom	Type	Description
id	String	ID de l'élément Bookmark.

Renvois

Bookmark : Bookmark avec l'ID donné, ou null en l'absence de Bookmark existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getBookmarks()

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getFooter()

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

Renvois

FooterSection : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getFootnotes()

Récupère tous les éléments Footnote dans le 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(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());

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getHeader()

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getNamedRangeById(id)

Récupère l'élément NamedRange avec l'ID donné. Cette méthode renvoie null si aucune NamedRange existe dans l'onglet. Les noms ne sont pas nécessairement uniques, même d'un onglet à l'autre. plusieurs plages différentes d'un même document peuvent avoir le même nom, à l'instar d'une classe dans HTML. En revanche, les ID sont uniques dans l'onglet, comme c'est le cas en HTML.

Paramètres

Nom	Type	Description
id	String	Identifiant de la plage, qui est unique dans l'onglet.

Renvois

NamedRange : 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 correspondant à un ou plusieurs des champs d'application suivants:

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

---

getNamedRanges()

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 des conflits inattendus entre les scripts, envisagez de préfixer les noms de plage avec une chaîne unique.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

getNamedRanges(name)

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

Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter des conflits inattendus entre les scripts, envisagez de préfixer les noms de plage avec une chaîne unique.

Paramètres

Nom	Type	Description
name	String	Nom de la plage, qui n'est pas nécessairement unique.

Renvois

NamedRange[] : tableau des objets NamedRange de l'onglet portant le nom donné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

newPosition(element, offset)

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, entre autres, représenté sous forme de Position.

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

Paramètres

Nom	Type	Description
element	Element	L'élément contenant la nouvelle Position à : il doit s'agir soit un élément Text, soit un élément conteneur tel que Paragraph.
offset	Integer	Pour les éléments Text, le nombre de caractères avant Position. Pour les autres éléments, le nombre d'éléments enfants avant Position dans la le même élément conteneur.

Renvois

Position : nouveau Position.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

---

newRange()

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

Renvois

RangeBuilder : nouveau compilateur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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