Cette page a été traduite par l'API Cloud Translation.

Class Body

Contenu d'un onglet dans un document Google Docs. Body peut contenir des éléments ListItem, Paragraph, Table et TableOfContents. Pour en savoir plus sur la structure des documents, consultez le guide d'extension de Google Docs.

Body contient généralement le contenu complet de l'onglet, à l'exception des éléments HeaderSection, FooterSection et FootnoteSection.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

Méthodes

Méthode	Type renvoyé	Brève description
`appendHorizontalRule()`	`HorizontalRule`	Crée et ajoute un objet `HorizontalRule`.
`appendImage(image)`	`InlineImage`	Crée et ajoute un `InlineImage` à partir du blob d'image spécifié.
`appendImage(image)`	`InlineImage`	Ajoute le `InlineImage` donné.
`appendListItem(listItem)`	`ListItem`	Ajoute le `ListItem` donné.
`appendListItem(text)`	`ListItem`	Crée et ajoute un `ListItem` contenant le contenu textuel spécifié.
`appendPageBreak()`	`PageBreak`	Crée et ajoute un objet `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Ajoute le `PageBreak` donné.
`appendParagraph(paragraph)`	`Paragraph`	Ajoute le `Paragraph` donné.
`appendParagraph(text)`	`Paragraph`	Crée et ajoute un `Paragraph` contenant le contenu textuel spécifié.
`appendTable()`	`Table`	Crée et ajoute un objet `Table`.
`appendTable(cells)`	`Table`	Ajoute un nouvel élément `Table` contenant un élément `TableCell` pour chaque valeur de chaîne spécifiée.
`appendTable(table)`	`Table`	Ajoute le `Table` donné.
`clear()`	`Body`	Efface le contenu de l'élément.
`copy()`	`Body`	Renvoie une copie profonde dissociée de l'élément actuel.
`editAsText()`	`Text`	Récupère une version `Text` de l'élément actuel, à des fins de modification.
`findElement(elementType)`	`RangeElement`	Recherche dans le contenu de l'élément un descendant du type spécifié.
`findElement(elementType, from)`	`RangeElement`	Recherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'`RangeElement` spécifié.
`findText(searchPattern)`	`RangeElement`	Recherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
`findText(searchPattern, from)`	`RangeElement`	Recherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
`getAttributes()`	`Object`	Récupère les attributs de l'élément.
`getChild(childIndex)`	`Element`	Récupère l'élément enfant à l'index enfant spécifié.
`getChildIndex(child)`	`Integer`	Récupère l'index de l'élément enfant pour l'élément enfant spécifié.
`getHeadingAttributes(paragraphHeading)`	`Object`	Récupère l'ensemble d'attributs pour l'`ParagraphHeading` fournie.
`getImages()`	`InlineImage[]`	Récupère tous les `InlineImages` contenus dans la section.
`getListItems()`	`ListItem[]`	Récupère tous les `ListItems` contenus dans la section.
`getMarginBottom()`	`Number`	Récupère la marge inférieure, en points.
`getMarginLeft()`	`Number`	Récupère la marge de gauche, en points.
`getMarginRight()`	`Number`	Récupère la marge de droite.
`getMarginTop()`	`Number`	Récupère la marge supérieure.
`getNumChildren()`	`Integer`	Récupère le nombre d'enfants.
`getPageHeight()`	`Number`	Récupère la hauteur de la page, en points.
`getPageWidth()`	`Number`	Récupère la largeur de la page, en points.
`getParagraphs()`	`Paragraph[]`	Récupère tous les `Paragraphs` contenus dans la section (y compris `ListItems`).
`getParent()`	`ContainerElement`	Récupère l'élément parent de l'élément.
`getTables()`	`Table[]`	Récupère tous les `Tables` contenus dans la section.
`getText()`	`String`	Récupère le contenu de l'élément sous forme de chaîne de texte.
`getTextAlignment()`	`TextAlignment`	Récupère l'alignement du texte.
`getType()`	`ElementType`	Récupère le `ElementType` de l'élément.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crée et insère un `HorizontalRule` à l'index spécifié.
`insertImage(childIndex, image)`	`InlineImage`	Crée et insère un `InlineImage` à partir du blob d'image spécifié, à l'index spécifié.
`insertImage(childIndex, image)`	`InlineImage`	Insère l'`InlineImage` donné à l'index spécifié.
`insertListItem(childIndex, listItem)`	`ListItem`	Insère l'`ListItem` donné à l'index spécifié.
`insertListItem(childIndex, text)`	`ListItem`	Crée et insère un nouvel élément `ListItem` à l'index spécifié, contenant le contenu textuel spécifié.
`insertPageBreak(childIndex)`	`PageBreak`	Crée et insère un `PageBreak` à l'index spécifié.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Insère l'`PageBreak` donné à l'index spécifié.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insère l'`Paragraph` donné à l'index spécifié.
`insertParagraph(childIndex, text)`	`Paragraph`	Crée et insère un nouvel élément `Paragraph` à l'index spécifié, contenant le contenu textuel spécifié.
`insertTable(childIndex)`	`Table`	Crée et insère un `Table` à l'index spécifié.
`insertTable(childIndex, cells)`	`Table`	Crée et insère un `Table` contenant les cellules spécifiées à l'index spécifié.
`insertTable(childIndex, table)`	`Table`	Insère l'`Table` donné à l'index spécifié.
`removeChild(child)`	`Body`	Supprime l'élément enfant spécifié.
`replaceText(searchPattern, replacement)`	`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.
`setAttributes(attributes)`	`Body`	Définit les attributs de l'élément.
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	Définit les attributs de l'`ParagraphHeading` fournie.
`setMarginBottom(marginBottom)`	`Body`	Définit la marge inférieure, en points.
`setMarginLeft(marginLeft)`	`Body`	Définit la marge de gauche, en points.
`setMarginRight(marginRight)`	`Body`	Définit la marge droite, en points.
`setMarginTop(marginTop)`	`Body`	Définit la marge supérieure.
`setPageHeight(pageHeight)`	`Body`	Définit la hauteur de la page, en points.
`setPageWidth(pageWidth)`	`Body`	Définit la largeur de la page, en points.
`setText(text)`	`Body`	Définit le contenu en texte brut.
`setTextAlignment(textAlignment)`	`Body`	Définit l'alignement du texte.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getFootnotes()`	`Footnote[]`	Récupère tous les `Footnotes` contenus dans la section.
`getLinkUrl()`	`String`	Récupère l'URL du lien.
`getNextSibling()`	`Element`	Récupère l'élément frère suivant de l'élément.
`getPreviousSibling()`	`Element`	Récupère l'élément frère précédent de l'élément.
`isAtDocumentEnd()`	`Boolean`	Détermine si l'élément se trouve à la fin de `Document`.
`setLinkUrl(url)`	`Body`	Définit l'URL du lien.

Documentation détaillée

`appendHorizontalRule()`

Crée et ajoute un objet HorizontalRule.

HorizontalRule sera contenu dans un nouveau Paragraph.

Renvois

HorizontalRule : nouvelle règle horizontale.

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

`appendImage(image)`

Crée et ajoute un InlineImage à partir du blob d'image spécifié.

L'image sera contenue dans un nouvel élément Paragraph.

Paramètres

Nom	Type	Description
`image`	`BlobSource`	Données d'image.

Renvois

InlineImage : image ajoutée.

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

`appendImage(image)`

Ajoute le InlineImage donné.

InlineImage sera contenu dans un nouveau Paragraph.

Utilisez cette version de appendImage lorsque vous ajoutez une copie d'un InlineImage existant.

Paramètres

Nom	Type	Description
`image`	`InlineImage`	Données d'image.

Renvois

InlineImage : image ajoutée.

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

`appendListItem(listItem)`

Ajoute le ListItem donné.

Utilisez cette version de appendListItem lorsque vous ajoutez une copie d'un ListItem existant.

Paramètres

Nom	Type	Description
`listItem`	`ListItem`	Élément de liste à ajouter.

Renvois

ListItem : élément de liste ajouté.

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

`appendListItem(text)`

Crée et ajoute un ListItem contenant le contenu textuel spécifié.

Les éléments de liste consécutifs sont ajoutés dans la même liste.

Paramètres

Nom	Type	Description
`text`	`String`	Contenu textuel de l'élément de liste.

Renvois

ListItem : nouvel élément de liste.

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

`appendPageBreak()`

Crée et ajoute un objet PageBreak.

PageBreak sera contenu dans un nouveau Paragraph.

Renvois

PageBreak : nouveau saut de page.

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

`appendPageBreak(pageBreak)`

Ajoute le PageBreak donné.

PageBreak sera contenu dans un nouveau Paragraph.

Utilisez cette version de appendPageBreak lorsque vous ajoutez une copie d'un PageBreak existant.

Paramètres

Nom	Type	Description
`pageBreak`	`PageBreak`	Saut de page à ajouter.

Renvois

PageBreak : saut de page ajouté.

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

`appendParagraph(paragraph)`

Ajoute le Paragraph donné.

Utilisez cette version de appendParagraph lorsque vous ajoutez une copie d'un Paragraph existant.

Paramètres

Nom	Type	Description
`paragraph`	`Paragraph`	Paragraphe à ajouter.

Renvois

Paragraph : paragraphe ajouté.

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

`appendParagraph(text)`

Crée et ajoute un Paragraph contenant le contenu textuel spécifié.

Paramètres

Nom	Type	Description
`text`	`String`	Contenu textuel du paragraphe.

Renvois

Paragraph : nouveau paragraphe.

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

`appendTable()`

Crée et ajoute un objet Table.

Cette méthode ajoute également un paragraphe vide après le tableau, car les documents Google Docs ne peuvent pas se terminer par un tableau.

Renvois

Table : nouvelle table.

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

`appendTable(cells)`

Ajoute un nouvel élément Table contenant un élément TableCell pour chaque valeur de chaîne spécifiée.

Cette méthode ajoute également un paragraphe vide après le tableau, car les documents Google Docs ne peuvent pas se terminer par un tableau.

Paramètres

Nom	Type	Description
`cells`	`String[][]`	Contenu textuel des cellules de la table à ajouter à la nouvelle table.

Renvois

Table : table ajoutée.

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

`appendTable(table)`

Ajoute le Table donné.

Utilisez cette version de appendTable lorsque vous ajoutez une copie d'un Table existant. Cette méthode ajoute également un paragraphe vide après le tableau, car les documents Google Docs ne peuvent pas se terminer par un tableau.

Paramètres

Nom	Type	Description
`table`	`Table`	Table à ajouter.

Renvois

Table : table ajoutée.

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

`clear()`

Efface le contenu de l'élément.

Renvois

Body : élément actuel.

`copy()`

Renvoie une copie profonde 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

Body : 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

`editAsText()`

Récupère une version Text de l'élément actuel, à des fins de 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 textuelle 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
`elementType`	`ElementType`	Type d'élément à rechercher.

Renvois

RangeElement : 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 champs d'application 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é, à partir de l'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
`elementType`	`ElementType`	Type d'élément à rechercher.
`from`	`RangeElement`	Résultat de recherche à partir duquel effectuer une recherche.

Renvois

RangeElement : 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 champs d'application suivants:

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

`findText(searchPattern)`

Recherche dans le contenu de l'élément le format 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 compatible, comme les groupes de capture et les modificateurs de mode.

Le modèle d'expression régulière fourni est mis en correspondance indépendamment avec chaque bloc de texte contenu dans l'élément actuel.

Paramètres

Nom	Type	Description
`searchPattern`	`String`	le modèle à rechercher

Renvois

RangeElement : résultat de recherche indiquant la position 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 champs d'application suivants:

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

`findText(searchPattern, from)`

Recherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.

Un sous-ensemble des fonctionnalités d'expression régulière JavaScript n'est pas entièrement compatible, comme les groupes de capture et les modificateurs de mode.

Le modèle d'expression régulière fourni est mis en correspondance indépendamment avec chaque bloc de texte contenu dans l'élément actuel.

Paramètres

Nom	Type	Description
`searchPattern`	`String`	le modèle à rechercher
`from`	`RangeElement`	le résultat de recherche à partir duquel effectuer la recherche

Renvois

RangeElement : résultat de recherche indiquant la position suivante du texte de recherche, ou valeur nulle en l'absence de correspondance

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.

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 champs d'application 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
`childIndex`	`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 champs d'application suivants:

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

`getChildIndex(child)`

Récupère l'index de l'élément 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 enfant.

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

`getHeadingAttributes(paragraphHeading)`

Récupère l'ensemble d'attributs pour l'ParagraphHeading fournie.

Paramètres

Nom	Type	Description
`paragraphHeading`	`ParagraphHeading`	Titre dont les attributs doivent être récupérés.

Renvois

Object : mappage des attributs et de leurs valeurs actuelles.

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

`getImages()`

Récupère tous les InlineImages contenus dans la section.

Renvois

InlineImage[] : images de la section.

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

`getListItems()`

Récupère tous les ListItems contenus dans la section.

Renvois

ListItem[] : éléments de la liste de sections.

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

`getMarginBottom()`

Récupère la marge inférieure, en points.

Renvois

Number : marge inférieure, en points.

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

`getMarginLeft()`

Récupère la marge de gauche, en points.

Renvois

Number : marge de gauche, en points.

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

`getMarginRight()`

Récupère la marge de droite.

Renvois

Number : marge droite, en points.

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

`getMarginTop()`

Récupère la marge supérieure.

Renvois

Number : marge supérieure, en points.

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

`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 champs d'application suivants:

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

`getPageHeight()`

Récupère la hauteur de la page, en points.

Renvois

Number : hauteur de la page, en points.

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

`getPageWidth()`

Récupère la largeur de la page, en points.

Renvois

Number : largeur de la page, en points.

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

`getParagraphs()`

Récupère tous les Paragraphs contenus dans la section (y compris ListItems).

Renvois

Paragraph[] : paragraphes de la section.

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.

Renvois

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

`getTables()`

Récupère tous les Tables contenus dans la section.

Renvois

Table[] : tables de section.

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

`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 champs d'application 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 : type d'alignement du texte, ou null si le texte contient plusieurs types d'alignement du texte 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 champs d'application 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 champs d'application suivants:

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

`insertHorizontalRule(childIndex)`

Crée et insère un HorizontalRule à l'index spécifié.

HorizontalRule sera contenu dans un nouveau Paragraph.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Indice à partir duquel insérer l'élément.

Renvois

HorizontalRule : nouvelle règle horizontale.

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

`insertImage(childIndex, image)`

Crée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Indice à partir duquel insérer l'élément.
`image`	`BlobSource`	Données d'image.

Renvois

InlineImage : image intégrée insérée.

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

`insertImage(childIndex, image)`

Insère l'InlineImage donné à l'index spécifié.

L'image sera contenue dans un nouvel élément Paragraph.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Indice à partir duquel insérer l'élément.
`image`	`InlineImage`	Image à insérer.

Renvois

InlineImage : image intégrée insérée.

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

`insertListItem(childIndex, listItem)`

Insère l'ListItem donné à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.
`listItem`	`ListItem`	Élément de liste à insérer.

Renvois

ListItem : élément de liste inséré.

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

`insertListItem(childIndex, text)`

Crée et insère un nouvel élément ListItem à l'index spécifié, contenant le contenu textuel spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.
`text`	`String`	Contenu textuel de l'élément de liste.

Renvois

ListItem : nouvel élément de liste.

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

`insertPageBreak(childIndex)`

Crée et insère un PageBreak à l'index spécifié.

PageBreak sera contenu dans un nouveau Paragraph.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Indice à partir duquel insérer l'élément.

Renvois

PageBreak : nouveau saut de page.

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

`insertPageBreak(childIndex, pageBreak)`

Insère l'PageBreak donné à l'index spécifié.

PageBreak sera contenu dans un nouveau Paragraph.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Indice à partir duquel insérer l'élément.
`pageBreak`	`PageBreak`	Saut de page à insérer.

Renvois

PageBreak : saut de page inséré.

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

`insertParagraph(childIndex, paragraph)`

Insère l'Paragraph donné à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.
`paragraph`	`Paragraph`	Paragraphe à insérer.

Renvois

Paragraph : paragraphe inséré.

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

`insertParagraph(childIndex, text)`

Crée et insère un nouvel élément Paragraph à l'index spécifié, contenant le contenu textuel spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.
`text`	`String`	Contenu textuel du paragraphe.

Renvois

Paragraph : nouveau paragraphe.

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

`insertTable(childIndex)`

Crée et insère un Table à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.

Renvois

Table : nouvelle table.

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

`insertTable(childIndex, cells)`

Crée et insère un Table contenant les cellules spécifiées à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.
`cells`	`String[][]`	Contenu textuel des cellules de la table à ajouter à la nouvelle table.

Renvois

Table : nouvelle table.

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

`insertTable(childIndex, table)`

Insère l'Table donné à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index à insérer.
`table`	`Table`	Tableau à insérer.

Renvois

Table : tableau inséré.

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

`removeChild(child)`

Supprime l'élément enfant spécifié.

Paramètres

Nom	Type	Description
`child`	`Element`	Élément enfant à supprimer.

Renvois

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

`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 format de recherche est transmis sous la forme d'une chaîne, et non d'un objet d'expression régulière JavaScript. Vous devez donc échapper toutes les barres obliques inverses dans le format.

Ces méthodes utilisent la bibliothèque d'expressions régulières RE2 de Google, ce qui limite la syntaxe compatible.

Le modèle d'expression régulière fourni est mis en correspondance indépendamment 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
`searchPattern`	`String`	le motif 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 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é 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

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

`setHeadingAttributes(paragraphHeading, attributes)`

Définit les attributs de l'ParagraphHeading fournie.

Paramètres

Nom	Type	Description
`paragraphHeading`	`ParagraphHeading`	Titre dont les attributs doivent être définis.
`attributes`	`Object`	Mappage des attributs et des valeurs à leur attribuer.

Renvois

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

`setMarginBottom(marginBottom)`

Définit la marge inférieure, en points.

Paramètres

Nom	Type	Description
`marginBottom`	`Number`	Marge inférieure, en points.

Renvois

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

`setMarginLeft(marginLeft)`

Définit la marge de gauche, en points.

Paramètres

Nom	Type	Description
`marginLeft`	`Number`	Marge de gauche, en points.

Renvois

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

`setMarginRight(marginRight)`

Définit la marge droite, en points.

Paramètres

Nom	Type	Description
`marginRight`	`Number`	Marge de droite.

Renvois

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

`setMarginTop(marginTop)`

Définit la marge supérieure.

Paramètres

Nom	Type	Description
`marginTop`	`Number`	Marge supérieure, en points.

Renvois

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

`setPageHeight(pageHeight)`

Définit la hauteur de la page, en points.

Paramètres

Nom	Type	Description
`pageHeight`	`Number`	Hauteur de la page, en points.

Renvois

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

`setPageWidth(pageWidth)`

Définit la largeur de la page, en points.

Paramètres

Nom	Type	Description
`pageWidth`	`Number`	Largeur de la page, en points.

Renvois

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

`setText(text)`

Définit le contenu en texte brut.

Remarque: Les contenus existants sont effacés.

Paramètres

Nom	Type	Description
`text`	`String`	Nouveaux contenus textuels.

Renvois

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

`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
`textAlignment`	`TextAlignment`	le type d'alignement du texte à appliquer

Renvois

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

Méthodes obsolètes

`getFootnotes()`

Obsolète. Cet élément ne peut pas contenir de Footnote.

Récupère tous les Footnotes contenus dans la section.

Renvois

Footnote[] : notes de bas de page de la section.

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

`getLinkUrl()`

Obsolète. Au lieu d'appliquer un lien à une section entière, appliquez-le à un élément de la section.

Récupère l'URL du lien.

Renvois

String : 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 champs d'application suivants:

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

`getNextSibling()`

Obsolète. Cet élément n'a pas de frères et sœurs.

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

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

`getPreviousSibling()`

Obsolète. Cet élément n'a pas de frères et sœurs.

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 : é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

`isAtDocumentEnd()`

Obsolète. Cette méthode n'est pas fiable pour HeaderSection.

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 champs d'application suivants:

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

`setLinkUrl(url)`

Obsolète. Au lieu d'appliquer un lien à une section entière, appliquez-le à un élément de la section.

Définit l'URL du lien.

Paramètres

Nom	Type	Description
`url`	`String`	l'URL du lien ;

Renvois

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