Class Body

Corps

Élément représentant le corps d'un document. Le 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 du document, à l'exception des éléments HeaderSection et FooterSection, ainsi que de tout élément FootnoteSection.

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

// Append a paragraph and a page break to the document body section directly.
body.appendParagraph("A paragraph.");
body.appendPageBreak();

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute le InlineImage indiqué.
appendListItem(listItem)ListItemAjoute le ListItem indiqué.
appendListItem(text)ListItemCrée et ajoute un ListItem avec le contenu textuel spécifié.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak indiqué.
appendParagraph(paragraph)ParagraphAjoute le Paragraph indiqué.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph avec le contenu textuel spécifié.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute le Table indiqué.
clear()BodyEfface le contenu de l'élément.
copy()BodyRenvoie une copie dissociée de l'élément actif.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index de l'élément enfant spécifié.
getHeadingAttributes(paragraphHeading)ObjectRécupère l'ensemble des attributs pour le ParagraphHeading fourni.
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()NumberRécupère la marge inférieure, en points.
getMarginLeft()NumberRécupère la marge gauche, en points.
getMarginRight()NumberRécupère la marge droite.
getMarginTop()NumberRécupère la marge supérieure.
getNumChildren()IntegerRécupère le nombre d'enfants.
getPageHeight()NumberRécupère la hauteur de la page, en points.
getPageWidth()NumberRé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()ContainerElementRécupère l'élément parent de l'élément.
getTables()Table[]Récupère tous les Tables contenus dans la section.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignmentRécupère l'alignement du texte.
getType()ElementTypeRécupère l'élément ElementType.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un objet HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob de l'image spécifié, au niveau de l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un élément ListItem dans l'index spécifié, avec le contenu textuel spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un objet PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un élément Paragraph dans l'index spécifié, avec le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un objet Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un nouveau Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)BodySupprime l'élément enfant spécifié.
replaceText(searchPattern, replacement)ElementRemplace 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)BodyDéfinit les attributs de l'élément.
setHeadingAttributes(paragraphHeading, attributes)BodyDéfinit les attributs de l'élément ParagraphHeading fourni.
setMarginBottom(marginBottom)BodyMarge inférieure, en points.
setMarginLeft(marginLeft)BodyMarge gauche, en points.
setMarginRight(marginRight)BodyDéfinit la marge de droite, en points.
setMarginTop(marginTop)BodyDéfinit la marge supérieure.
setPageHeight(pageHeight)BodyDéfinit la hauteur de la page, en points.
setPageWidth(pageWidth)BodyDéfinit la largeur de la page, en points.
setText(text)BodyDéfinit le contenu en texte brut.
setTextAlignment(textAlignment)BodyDéfinit l'alignement du texte.

Documentation détaillée

appendHorizontalRule()

Crée et ajoute un HorizontalRule.

Le HorizontalRule sera contenu dans un nouveau Paragraph.

Aller-retour

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 stockée dans un nouveau fichier Paragraph.

Paramètres

NomTypeDescription
imageBlobSourceles données d'image

Aller-retour

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 indiqué.

Le InlineImage sera contenu dans un nouveau Paragraph.

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

Paramètres

NomTypeDescription
imageInlineImageles données d'image

Aller-retour

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 indiqué.

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

Paramètres

NomTypeDescription
listItemListItemÉlément de liste à ajouter

Aller-retour

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 avec le contenu textuel spécifié.

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

Paramètres

NomTypeDescription
textStringContenu du texte de l'élément de liste

Aller-retour

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 PageBreak.

Le PageBreak sera contenu dans un nouveau Paragraph.

Aller-retour

PageBreak : le 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 indiqué.

Le PageBreak sera contenu dans un nouveau Paragraph.

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

Paramètres

NomTypeDescription
pageBreakPageBreakle saut de page à ajouter

Aller-retour

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 indiqué.

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

Paramètres

NomTypeDescription
paragraphParagraphle paragraphe à ajouter

Aller-retour

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 avec le contenu textuel spécifié.

Paramètres

NomTypeDescription
textStringContenu du texte du paragraphe

Aller-retour

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 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.

Aller-retour

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 nouveau Table contenant un 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

NomTypeDescription
cellsString[][]Le texte des cellules du tableau à ajouter au nouveau tableau

Aller-retour

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 indiqué.

Utilisez cette version de appendTable lorsque vous ajoutez la 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

NomTypeDescription
tableTableTable à ajouter

Aller-retour

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.

Aller-retour

Body : élément actuel


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

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 contenus entièrement dans une plage de texte supprimée sont retirés de l'élément.

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

Aller-retour

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

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher

Aller-retour

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é, en commençant par le RangeElement spécifié.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Paramètres

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher
fromRangeElementle résultat de recherche à partir duquel

Aller-retour

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 le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.

Un sous-ensemble de 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

NomTypeDescription
searchPatternStringle modèle à rechercher

Aller-retour

RangeElement : résultat de recherche indiquant la position du texte de recherche ou valeur 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 dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.

Un sous-ensemble de 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

NomTypeDescription
searchPatternStringle modèle à rechercher
fromRangeElementle résultat de recherche à partir duquel

Aller-retour

RangeElement : résultat de recherche indiquant la position suivante du texte de recherche ou valeur 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

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

getChild(childIndex)

Récupère l'élément enfant à l'index enfant spécifié.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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

NomTypeDescription
childIndexIntegerindex de l'élément enfant à récupérer

Aller-retour

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 spécifié.

Paramètres

NomTypeDescription
childElementÉlément enfant pour lequel récupérer l'index

Aller-retour

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 des attributs pour le ParagraphHeading fourni.

Paramètres

NomTypeDescription
paragraphHeadingParagraphHeadingTitre dont les attributs seront récupérés

Aller-retour

Object : carte 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.

Aller-retour

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.

Aller-retour

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.

Aller-retour

Number : marge inférieure du nombre de 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 gauche, en points.

Aller-retour

Number : marge 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 droite.

Aller-retour

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.

Aller-retour

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.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Aller-retour

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.

Aller-retour

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.

Aller-retour

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

Aller-retour

Paragraph[] : paragraphes 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

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

getTables()

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

Aller-retour

Table[] : les 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.

Aller-retour

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.

Aller-retour

TextAlignment : type d'alignement du texte, ou null si le texte contient plusieurs types d'alignement de texte ou si l'alignement 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 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

insertHorizontalRule(childIndex)

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

Le HorizontalRule sera contenu dans un nouveau Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément

Aller-retour

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 de l'objet blob de l'image spécifié, au niveau de l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
imageBlobSourceles données d'image

Aller-retour

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 le InlineImage donné à l'index spécifié.

L'image sera stockée dans un nouveau fichier Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
imageInlineImageImage à insérer

Aller-retour

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 le ListItem donné à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer
listItemListItemÉlément de liste à insérer

Aller-retour

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 élément ListItem dans l'index spécifié, avec le contenu textuel spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer
textStringContenu du texte de l'élément de liste

Aller-retour

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 objet PageBreak à l'index spécifié.

Le PageBreak sera contenu dans un nouveau Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément

Aller-retour

PageBreak : le 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 le PageBreak donné à l'index spécifié.

Le PageBreak sera contenu dans un nouveau Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
pageBreakPageBreakle p[age break to insert

Aller-retour

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 le Paragraph donné à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer
paragraphParagraphle paragraphe à insérer

Aller-retour

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 élément Paragraph dans l'index spécifié, avec le contenu textuel spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer
textStringContenu du texte du paragraphe

Aller-retour

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 objet Table à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer

Aller-retour

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 nouveau Table contenant les cellules spécifiées, à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer
cellsString[][]Le texte des cellules du tableau à ajouter au nouveau tableau

Aller-retour

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 le Table donné à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index dans lequel insérer
tableTableTableau à insérer

Aller-retour

Table : table 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

removeChild(child)

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

Paramètres

NomTypeDescription
childElementl'élément enfant à supprimer

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

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 en tant que chaîne, et non en tant qu'objet d'expression régulière JavaScript. Pour cette raison, vous devez échapper les barres obliques inverses dans le 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 indépendamment avec chaque bloc de texte contenu dans l'élément actuel.

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Paramètres

NomTypeDescription
searchPatternStringle modèle d'expression régulière à rechercher
replacementStringTexte à utiliser comme texte de remplacement

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

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

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'élément ParagraphHeading fourni.

Paramètres

NomTypeDescription
paragraphHeadingParagraphHeadingTitre dont les attributs seront définis
attributesObjectUne carte des attributs et les valeurs correspondantes

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

setMarginBottom(marginBottom)

Marge inférieure, en points.

Paramètres

NomTypeDescription
marginBottomNumbermarge inférieure, en points

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

setMarginLeft(marginLeft)

Marge gauche, en points.

Paramètres

NomTypeDescription
marginLeftNumbermarge gauche de points

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

setMarginRight(marginRight)

Définit la marge de droite, en points.

Paramètres

NomTypeDescription
marginRightNumbermarge de droite

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

setMarginTop(marginTop)

Définit la marge supérieure.

Paramètres

NomTypeDescription
marginTopNumbermarge supérieure, en points

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

setPageHeight(pageHeight)

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

Paramètres

NomTypeDescription
pageHeightNumberhauteur de la page, en points

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

setPageWidth(pageWidth)

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

Paramètres

NomTypeDescription
pageWidthNumberLargeur de la page, en points

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

setText(text)

Définit le contenu en texte brut.

Remarque: Le contenu existant est effacé.

Paramètres

NomTypeDescription
textStringle nouveau contenu textuel

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

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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Paramètres

NomTypeDescription
textAlignmentTextAlignmentType d'alignement du texte à appliquer.

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

Méthodes obsolètes