Élément générique pouvant contenir d'autres éléments. Tous les éléments pouvant contenir des éléments enfants, tels que Paragraph, héritent de ContainerElement.
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
as | Body | Renvoie l'élément actuel en tant que Body. |
as | Equation | Renvoie l'élément actuel sous la forme d'un Equation. |
as | Footer | Renvoie l'élément actuel en tant que Footer. |
as | Footnote | Renvoie l'élément actuel en tant que Footnote. |
as | Header | Renvoie l'élément actuel en tant que Header. |
as | List | Renvoie l'élément actuel en tant que List. |
as | Paragraph | Renvoie l'élément actuel en tant que Paragraph. |
as | Table | Renvoie l'élément actuel en tant que Table. |
as | Table | Renvoie l'élément actuel en tant que Table. |
as | Table | Renvoie l'élément actuel en tant que Table. |
as | Table | Renvoie l'élément actuel en tant que Table. |
clear() | Container | Efface le contenu de l'élément. |
copy() | Container | Renvoie une copie détachée et complète de l'élément actuel. |
edit | Text | Obtient une version Text de l'élément actuel, pour la modification. |
find | Range | Recherche dans le contenu de l'élément un descendant du type spécifié. |
find | Range | Recherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le Range spécifié. |
find | Range | Recherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières. |
find | Range | Recherche le contenu de l'élément pour le modèle de texte spécifié, en commençant par un résultat de recherche donné. |
get | Object | Récupère les attributs de l'élément. |
get | Element | Récupère l'élément enfant à l'index enfant spécifié. |
get | Integer | Récupère l'index enfant pour l'élément enfant spécifié. |
get | String|null | Récupère l'URL du lien. |
get | Element|null | Récupère l'élément frère suivant de l'élément. |
get | Integer | Récupère le nombre d'enfants. |
get | Container | Récupère l'élément parent de l'élément. |
get | Element|null | Récupère l'élément frère précédent de l'élément. |
get | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
get | Text | Récupère l'alignement du texte. |
get | Element | Récupère le Element de l'élément. |
is | Boolean | Détermine si l'élément se trouve à la fin de Document. |
merge() | Container | Fusionne l'élément avec l'élément frère précédent du même type. |
remove | Container | Supprime l'élément de son parent. |
replace | Element | Remplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières. |
set | Container | Définit les attributs de l'élément. |
set | Container | Définit l'URL du lien. |
set | Container | Définit l'alignement du texte. |
Documentation détaillée
asBody()
Renvoie l'élément actuel en tant que Body.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
Body : élément actuel.
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
asEquation()
Renvoie l'élément actuel sous la forme d'un Equation.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
Equation : élément actuel.
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
asFootnoteSection()
Renvoie l'élément actuel en tant que FootnoteSection.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
FootnoteSection : élément actuel.
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
asHeaderSection()
Renvoie l'élément actuel en tant que HeaderSection.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
HeaderSection : élément actuel.
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
asListItem()
Renvoie l'élément actuel en tant que ListItem.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
ListItem : élément actuel.
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
asParagraph()
Renvoie l'élément actuel en tant que Paragraph.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
Paragraph : élément actuel.
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
asTable()
Renvoie l'élément actuel en tant que Table.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
Table : élément actuel.
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
asTableCell()
Renvoie l'élément actuel en tant que TableCell.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
TableCell : élément actuel.
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
asTableOfContents()
Renvoie l'élément actuel en tant que TableOfContents.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
TableOfContents : élément actuel.
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
asTableRow()
Renvoie l'élément actuel en tant que TableRow.
Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour être d'un type spécifique.
Renvois
TableRow : élément actuel.
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
clear()
copy()
Renvoie une copie détachée et complète de l'élément actuel.
Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.
Renvois
ContainerElement : la nouvelle copie.
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
editAsText()
Obtient une version Text de l'élément actuel, pour la modification.
Utilisez editAsText pour manipuler le contenu des éléments en tant que texte enrichi. Le mode editAsText ignore les éléments non textuels (tels que InlineImage et HorizontalRule).
Les éléments enfants entièrement contenus dans une plage de texte supprimée sont supprimés de l'élément.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Renvois
Text : version texte de l'élément actuel
findElement(elementType)
Recherche dans le contenu de l'élément un descendant du type spécifié.
Paramètres
| Nom | Type | Description |
|---|---|---|
element | Element | Type d'élément à rechercher. |
Renvois
RangeElement|null : résultat de recherche indiquant la position de l'élément de recherche.
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
findElement(elementType, from)
Recherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Paramètres
| Nom | Type | Description |
|---|---|---|
element | Element | Type d'élément à rechercher. |
from | Range | Résultat de recherche à partir duquel effectuer la recherche. |
Renvois
RangeElement|null : résultat de recherche indiquant la position suivante de l'élément de recherche.
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
findText(searchPattern)
Recherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
Un sous-ensemble des fonctionnalités d'expression régulière JavaScript n'est pas entièrement pris en charge, comme les groupes de capture et les modificateurs de mode.
Le modèle d'expression régulière fourni est mis en correspondance de manière indépendante avec chaque bloc de texte contenu dans l'élément actuel.
Paramètres
| Nom | Type | Description |
|---|---|---|
search | String | le modèle à rechercher |
Renvois
RangeElement|null : résultat de recherche indiquant la position du texte recherché, ou "null" en l'absence de correspondance.
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
findText(searchPattern, from)
Recherche le contenu de l'élément pour le modèle de texte spécifié, en commençant par un résultat de recherche donné.
Un sous-ensemble des fonctionnalités d'expression régulière JavaScript n'est pas entièrement pris en charge, comme les groupes de capture et les modificateurs de mode.
Le modèle d'expression régulière fourni est mis en correspondance de manière indépendante avec chaque bloc de texte contenu dans l'élément actuel.
Paramètres
| Nom | Type | Description |
|---|---|---|
search | String | le modèle à rechercher |
from | Range | le résultat de recherche à partir duquel effectuer la recherche ; |
Renvois
RangeElement|null : résultat de recherche indiquant la position suivante du texte de recherche, ou null en l'absence de correspondance.
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
getAttributes()
Récupère les attributs de l'élément.
Le résultat est un objet contenant une propriété pour chaque attribut d'élément valide, où chaque nom de propriété correspond à un élément de l'énumération DocumentApp.Attribute.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Renvois
Object : attributs de l'élément.
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
getChild(childIndex)
Récupère l'élément enfant à l'index enfant spécifié.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
Paramètres
| Nom | Type | Description |
|---|---|---|
child | Integer | Index de l'élément enfant à récupérer. |
Renvois
Element : élément enfant à l'index 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
getChildIndex(child)
Récupère l'index enfant pour l'élément enfant spécifié.
Paramètres
| Nom | Type | Description |
|---|---|---|
child | Element | Élément enfant pour lequel récupérer l'index. |
Renvois
Integer : index de l'enfant.
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
getLinkUrl()
Récupère l'URL du lien.
Renvois
String|null : URL du lien ou valeur nulle si l'élément contient plusieurs valeurs pour cet attribut
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
getNextSibling()
Récupère l'élément frère suivant de l'élément.
L'élément frère suivant a le même parent et suit l'élément actuel.
Renvois
Element|null : élément frère suivant.
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
getNumChildren()
Récupère le nombre d'enfants.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Renvois
Integer : nombre d'enfants.
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
getParent()
Récupère l'élément parent de l'élément.
L'élément parent contient l'élément actuel.
Renvois
ContainerElement|null : élément parent.
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
getPreviousSibling()
Récupère l'élément frère précédent de l'élément.
Le frère précédent a le même parent et précède l'élément actuel.
Renvois
Element|null : élément frère précédent.
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
getText()
Récupère le contenu de l'élément sous forme de chaîne de texte.
Renvois
String : contenu de l'élément sous forme de chaîne de texte
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
getTextAlignment()
Récupère l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT et DocumentApp.TextAlignment.SUPERSCRIPT.
Renvois
TextAlignment|null : type d'alignement du texte ou null si le texte contient plusieurs types d'alignement ou si l'alignement du texte n'a jamais été défini
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
getType()
Récupère le ElementType de l'élément.
Utilisez getType() pour déterminer le type exact d'un élément donné.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Renvois
ElementType : type d'élément.
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
isAtDocumentEnd()
Détermine si l'élément se trouve à la fin de Document.
Renvois
Boolean : indique si l'élément se trouve à la fin 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
merge()
Fusionne l'élément avec l'élément frère précédent du même type.
Seuls les éléments du même ElementType peuvent être fusionnés. Tous les éléments enfants contenus dans l'élément actuel sont déplacés vers l'élément frère précédent.
L'élément actuel est supprimé du document.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Renvois
ContainerElement|null : élément fusionné.
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
removeFromParent()
Supprime l'élément de son parent.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Renvois
ContainerElement|null : élément supprimé.
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
replaceText(searchPattern, replacement)
Remplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
Le modèle de recherche est transmis sous forme de chaîne, et non d'objet d'expression régulière JavaScript. Pour cette raison, vous devrez échapper toutes les barres obliques inverses du modèle.
Cette méthode utilise la bibliothèque d'expressions régulières RE2 de Google, qui limite la syntaxe acceptée.
Le modèle d'expression régulière fourni est mis en correspondance de manière indépendante avec chaque bloc de texte contenu dans l'élément actuel.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Paramètres
| Nom | Type | Description |
|---|---|---|
search | String | le modèle d'expression régulière à rechercher |
replacement | String | le texte à utiliser en remplacement. |
Renvois
Element : élément actuel
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
setAttributes(attributes)
Définit les attributs de l'élément.
Le paramètre d'attributs spécifié doit être un objet dans lequel chaque nom de propriété est un élément de l'énumération DocumentApp.Attribute et chaque valeur de propriété est la nouvelle valeur à appliquer.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Paramètres
| Nom | Type | Description |
|---|---|---|
attributes | Object | Attributs de l'élément. |
Renvois
ContainerElement : élément actuel.
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
setLinkUrl(url)
Définit l'URL du lien.
Paramètres
| Nom | Type | Description |
|---|---|---|
url | String | l'URL du lien ; |
Renvois
ContainerElement : élément actuel
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
setTextAlignment(textAlignment)
Définit l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT et DocumentApp.TextAlignment.SUPERSCRIPT.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Paramètres
| Nom | Type | Description |
|---|---|---|
text | Text | le type d'alignement du texte à appliquer. |
Renvois
ContainerElement : élément actuel
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