Un élément générique. Document
contenus sont
représentés par des éléments. Par exemple, ListItem
, Paragraph
et Table
sont
et héritent de toutes les méthodes définies par Element
, comme getType()
.
Implémenter des classes
Nom | Brève description |
---|---|
Body | Contenu d'un onglet dans un document Google Docs. |
ContainerElement | Élément générique pouvant contenir d'autres éléments. |
Date | Élément représentant une date mise en forme |
Equation | Élément représentant une expression mathématique. |
EquationFunction | Élément représentant une fonction dans un Equation mathématique. |
EquationFunctionArgumentSeparator | Élément représentant un séparateur de fonction dans un Equation mathématique. |
EquationSymbol | Élément représentant un symbole dans un Equation mathématique. |
FooterSection | Élément représentant une section de pied de page. |
Footnote | Élément représentant une note de bas de page. |
FootnoteSection | Élément représentant une section de note de bas de page. |
HeaderSection | Élément représentant une section d'en-tête. |
HorizontalRule | Élément représentant une règle horizontale. |
InlineDrawing | Élément représentant un dessin intégré. |
InlineImage | Élément représentant une image intégrée. |
ListItem | Élément représentant un élément de liste. |
PageBreak | Élément représentant un saut de page. |
Paragraph | Élément représentant un paragraphe. |
Person | Élément représentant un lien vers une personne. |
RichLink | Élément représentant un lien vers une ressource Google, comme un fichier Drive ou une vidéo YouTube. |
Table | Élément représentant un tableau. |
TableCell | Élément représentant une cellule de tableau. |
TableOfContents | Élément contenant une table des matières. |
TableRow | Élément représentant une ligne du tableau. |
Text | Élément représentant une zone de texte enrichi. |
UnsupportedElement | Un élément représentant une région inconnue ou qui ne peut pas être affecté par un script, comme une numéro de page. |
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
asBody() | Body | Renvoie l'élément actuel en tant que Body . |
asDate() | Date | Renvoie l'élément actuel en tant que Date . |
asEquation() | Equation | Renvoie l'élément actuel en tant que Equation . |
asEquationFunction() | EquationFunction | Renvoie l'élément actuel en tant que EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Renvoie l'élément actuel en tant que EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Renvoie l'élément actuel en tant que EquationSymbol . |
asFooterSection() | FooterSection | Renvoie l'élément actuel en tant que FooterSection . |
asFootnote() | Footnote | Renvoie l'élément actuel en tant que Footnote . |
asFootnoteSection() | FootnoteSection | Renvoie l'élément actuel en tant que FootnoteSection . |
asHeaderSection() | HeaderSection | Renvoie l'élément actuel en tant que HeaderSection . |
asHorizontalRule() | HorizontalRule | Renvoie l'élément actuel en tant que HorizontalRule . |
asInlineDrawing() | InlineDrawing | Renvoie l'élément actuel en tant que InlineDrawing . |
asInlineImage() | InlineImage | Renvoie l'élément actuel en tant que InlineImage . |
asListItem() | ListItem | Renvoie l'élément actuel en tant que ListItem . |
asPageBreak() | PageBreak | Renvoie l'élément actuel en tant que PageBreak . |
asParagraph() | Paragraph | Renvoie l'élément actuel en tant que Paragraph . |
asPerson() | Person | Renvoie l'élément actuel en tant que Person . |
asRichLink() | RichLink | Renvoie l'élément actuel en tant que RichLink (par exemple, un lien vers un fichier Google Sheets). |
asTable() | Table | Renvoie l'élément actuel en tant que Table . |
asTableCell() | TableCell | Renvoie l'élément actuel en tant que TableCell . |
asTableOfContents() | TableOfContents | Renvoie l'élément actuel en tant que TableOfContents . |
asTableRow() | TableRow | Renvoie l'élément actuel en tant que TableRow . |
asText() | Text | Renvoie l'élément actuel en tant que Text . |
copy() | Element | Renvoie une copie complète et dissociée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | Element | Fusionne l'élément avec le frère précédent du même type. |
removeFromParent() | Element | Supprime l'élément de son parent. |
setAttributes(attributes) | Element | Définit les attributs de l'élément. |
Documentation détaillée
asBody()
Renvoie l'élément actuel en tant que Body
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
Body
: élément actuel.
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
asDate()
Renvoie l'élément actuel en tant que Date
.
Lorsque vous savez qu'un élément est de type Date
, utilisez cette méthode pour définir son type en tant que Date
. Ainsi, la saisie semi-automatique dans l'éditeur Apps Script vous montrera les méthodes que vous pouvez utiliser
avec un Date
.
Renvois
Date
: élément actuel dont le type est défini sur Date
.
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
asEquation()
Renvoie l'élément actuel en tant que Equation
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
Equation
: élément actuel.
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
asEquationFunction()
Renvoie l'élément actuel en tant que EquationFunction
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
EquationFunction
: élément actuel.
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
asEquationFunctionArgumentSeparator()
Renvoie l'élément actuel en tant que EquationFunctionArgumentSeparator
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
EquationFunctionArgumentSeparator
: élément actuel.
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
asEquationSymbol()
Renvoie l'élément actuel en tant que EquationSymbol
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
EquationSymbol
: élément actuel.
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
asFootnote()
Renvoie l'élément actuel en tant que Footnote
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
Footnote
: élément actuel.
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
asFootnoteSection()
Renvoie l'élément actuel en tant que FootnoteSection
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
FootnoteSection
: élément actuel.
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
asHeaderSection()
Renvoie l'élément actuel en tant que HeaderSection
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
HeaderSection
: élément actuel.
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
asHorizontalRule()
Renvoie l'élément actuel en tant que HorizontalRule
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
HorizontalRule
: élément actuel.
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
asInlineDrawing()
Renvoie l'élément actuel en tant que InlineDrawing
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
InlineDrawing
: élément actuel.
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
asInlineImage()
Renvoie l'élément actuel en tant que InlineImage
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
InlineImage
: élément actuel.
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
asListItem()
Renvoie l'élément actuel en tant que ListItem
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
ListItem
: élément actuel.
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
asPageBreak()
Renvoie l'élément actuel en tant que PageBreak
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
PageBreak
: élément actuel.
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
asParagraph()
Renvoie l'élément actuel en tant que Paragraph
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un caractère spécifique de mots clés.
Renvois
Paragraph
: élément actuel.
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
asPerson()
Renvoie l'élément actuel en tant que Person
.
Lorsque vous savez qu'un élément est de type Person
, utilisez cette méthode pour définir son type en tant que personne.
Ainsi, la saisie semi-automatique dans l'éditeur Apps Script vous montrera les méthodes que vous pouvez utiliser avec un
l'élément "person" (personne).
Renvois
Person
: élément actuel dont le type est défini sur Person
.
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
asRichLink()
Renvoie l'élément actuel en tant que RichLink
(par exemple, un lien vers un fichier Google Sheets).
Lorsque vous savez qu'un élément est de type RichLink
, utilisez cette méthode pour définir son type en tant que RichLink
. Ainsi, la saisie semi-automatique dans l'éditeur Apps Script vous montrera les méthodes que vous pouvez
à utiliser avec un RichLink
.
Renvois
RichLink
: élément actuel dont le type est défini sur RichLink
.
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
asTable()
Renvoie l'élément actuel en tant que Table
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
Table
: élément actuel.
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
asTableCell()
Renvoie l'élément actuel en tant que TableCell
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
TableCell
: élément actuel.
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
asTableOfContents()
Renvoie l'élément actuel en tant que TableOfContents
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
TableOfContents
: élément actuel.
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
asTableRow()
Renvoie l'élément actuel en tant que TableRow
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
TableRow
: élément actuel.
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
asText()
Renvoie l'élément actuel en tant que Text
.
Utilisez cette méthode pour faciliter la saisie semi-automatique chaque fois qu'un élément donné est d'un type de mots clés.
Renvois
Text
: élément actuel.
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
copy()
Renvoie une copie complète et dissociée 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
Element
: nouvelle copie.
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
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 la propriété correspond à un élément de l'énumération DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var 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 correspondant à un ou plusieurs des champs d'application 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.
Le frère suivant a le même parent et suit l'élément actuel.
Renvois
Element
: élément frère suivant.
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
getParent()
Récupère l'élément parent de l'élément.
L'élément parent contient l'élément actuel.
Renvois
ContainerElement
: élément parent.
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
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 est antérieur à l'élément actuel.
Renvois
Element
: élément frère précédent.
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
getType()
Récupère l'ElementType
de l'élément.
Utilisez getType()
pour déterminer le type exact d'un élément donné.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var 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 correspondant à un ou plusieurs des champs d'application 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 correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Fusionne l'élément avec le frère précédent du même type.
Seuls les éléments du même ElementType
peuvent être fusionnés. Tout élément enfant contenu 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.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. var par1 = body.appendParagraph('Paragraph 1.'); var 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. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Renvois
Element
: élément fusionné.
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
removeFromParent()
Supprime l'élément de son parent.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Renvois
Element
: élément supprimé.
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
setAttributes(attributes)
Définit les attributs de l'élément.
Le paramètre d'attributs spécifié doit être un objet où chaque nom d'établissement est un élément dans
l'énumération DocumentApp.Attribute
, et chaque valeur de propriété correspond à la nouvelle valeur à
appliquée.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var 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. var 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
Element
: élément actuel.
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