Interface Element

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Élément

Élément générique. Le contenu Document est représenté sous la forme d'éléments. Par exemple, ListItem, Paragraph et Table sont des éléments qui héritent de toutes les méthodes définies par Element, telles que getType().

Implémenter des classes

NomBrève description
BodyÉlément représentant le corps d'un document.
ContainerElementÉlément générique qui peut 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Élément représentant une région inconnue ou ne pouvant pas être affectée par un script, tel qu'un numéro de page.

Méthodes

MéthodeType renvoyéBrève description
asBody()BodyRenvoie l'élément actuel en tant que Body.
asDate()DateRenvoie l'élément actuel en tant que Date.
asEquation()EquationRenvoie l'élément actuel en tant que Equation.
asEquationFunction()EquationFunctionRenvoie l'élément actuel en tant que EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorRenvoie l'élément actuel en tant que EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolRenvoie l'élément actuel en tant que EquationSymbol.
asFooterSection()FooterSectionRenvoie l'élément actuel en tant que FooterSection.
asFootnote()FootnoteRenvoie l'élément actuel en tant que Footnote.
asFootnoteSection()FootnoteSectionRenvoie l'élément actuel en tant que FootnoteSection.
asHeaderSection()HeaderSectionRenvoie l'élément actuel en tant que HeaderSection.
asHorizontalRule()HorizontalRuleRenvoie l'élément actuel en tant que HorizontalRule.
asInlineDrawing()InlineDrawingRenvoie l'élément actuel en tant que InlineDrawing.
asInlineImage()InlineImageRenvoie l'élément actuel en tant que InlineImage.
asListItem()ListItemRenvoie l'élément actuel en tant que ListItem.
asPageBreak()PageBreakRenvoie l'élément actuel en tant que PageBreak.
asParagraph()ParagraphRenvoie l'élément actuel en tant que Paragraph.
asPerson()PersonRenvoie l'élément actuel en tant que Person.
asRichLink()RichLinkAffiche l'élément actuel sous forme de RichLink (lien vers un fichier Google Sheets, par exemple).
asTable()TableRenvoie l'élément actuel en tant que Table.
asTableCell()TableCellRenvoie l'élément actuel en tant que TableCell.
asTableOfContents()TableOfContentsRenvoie l'élément actuel en tant que TableOfContents.
asTableRow()TableRowRenvoie l'élément actuel en tant que TableRow.
asText()TextRenvoie l'élément actuel en tant que Text.
copy()ElementRenvoie une copie dissociée de l'élément actif.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère l'élément ElementType.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()ElementFusionne l'élément avec la fratrie précédente du même type.
removeFromParent()ElementSupprime l'élément de son parent.
setAttributes(attributes)ElementDé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 lorsqu'un élément donné est connu pour son type.

Aller-retour

Body : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Si vous savez qu'un élément est un Date, utilisez cette méthode pour définir son type sur Date. Ainsi, la saisie semi-automatique dans l'éditeur Apps Script affiche les méthodes que vous pouvez utiliser avec un Date.

Aller-retour

Date : élément actuel dont le type est défini sur Date.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

Equation : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

EquationFunction : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

EquationFunctionArgumentSeparator : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

EquationSymbol : élément actuel

Autorisation

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

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

asFooterSection()

Renvoie l'élément actuel en tant que FooterSection.

Utilisez cette méthode pour faciliter la saisie semi-automatique lorsqu'un élément donné est connu pour son type.

Aller-retour

FooterSection : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

Footnote : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

FootnoteSection : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

HeaderSection : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

HorizontalRule : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

InlineDrawing : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

InlineImage : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

ListItem : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

PageBreak : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

Paragraph : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Si vous savez qu'un élément est un Person, utilisez cette méthode pour définir son type en tant que personne. Ainsi, la saisie semi-automatique dans l'éditeur Apps Script affiche les méthodes que vous pouvez utiliser avec un élément "person".

Aller-retour

Person : élément actuel dont le type est défini sur Person.

Autorisation

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

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

Affiche l'élément actuel sous forme de RichLink (lien vers un fichier Google Sheets, par exemple).

Si vous savez qu'un élément est un RichLink, utilisez cette méthode pour définir son type sur RichLink. Ainsi, la saisie semi-automatique dans l'éditeur Apps Script affiche les méthodes que vous pouvez utiliser avec un RichLink.

Aller-retour

RichLink : élément actuel dont le type est défini sur RichLink.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

Table : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

TableCell : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

TableOfContents : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

TableRow : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 lorsqu'un élément donné est connu pour son type.

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 dissociée de l'élément actif.

Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.

Aller-retour

Element : nouvelle copie

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Il en résulte 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.

var body = DocumentApp.getActiveDocument().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]);
}

Aller-retour

Object : attributs de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

La fratrie suivante a le même parent et suit l'élément actuel.

Aller-retour

Element : élément frère suivant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

ContainerElement : élément parent

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 et la sœur précédents ont le même parent et précède l'élément actuel.

Aller-retour

Element : élément frère précédent.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'élément ElementType.

Utilisez getType() pour déterminer le type exact d'un élément donné.

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document 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.');
}

Aller-retour

ElementType : type d'élément.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

Boolean : indique si l'élément se trouve à la fin du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 la fratrie précédente 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.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
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();

Aller-retour

Element : élément fusionné

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Aller-retour

Element : élément supprimé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 dans lequel chaque nom de propriété est un élément de l'énumération DocumentApp.Attribute, et chaque valeur de propriété correspond à la nouvelle valeur à appliquer.

var body = DocumentApp.getActiveDocument().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

NomTypeDescription
attributesObjectAttributs de l'élément.

Aller-retour

Element : élément actuel

Autorisation

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

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