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

Class Paragraph

Élément représentant un paragraphe. Un Paragraph peut contenir des éléments Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak et Text. Pour en savoir plus sur la structure des documents, consultez le guide d'extension de Google Docs.

Paragraphs ne doit pas contenir de caractères de nouvelle ligne. Les caractères de nouvelle ligne (") sont convertis en caractères de saut de ligne ("\r").

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

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
var section = body.appendParagraph("Section 1");
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph("This is a typical paragraph.");

Méthodes

Méthode	Type renvoyé	Brève description
`addPositionedImage(image)`	`PositionedImage`	Crée et insère un `PositionedImage` à partir du blob d'image spécifié.
`appendHorizontalRule()`	`HorizontalRule`	Crée et ajoute un `HorizontalRule`.
`appendInlineImage(image)`	`InlineImage`	Crée et ajoute un `InlineImage` à partir du blob d'image spécifié.
`appendInlineImage(image)`	`InlineImage`	Ajoute le `InlineImage` indiqué.
`appendPageBreak()`	`PageBreak`	Crée et ajoute un `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Ajoute le `PageBreak` indiqué.
`appendText(text)`	`Text`	Crée et ajoute un élément `Text` avec le contenu spécifié.
`appendText(text)`	`Text`	Ajoute l'élément `Text` donné.
`clear()`	`Paragraph`	Efface le contenu de l'élément.
`copy()`	`Paragraph`	Renvoie une copie dissociée de l'élément actif.
`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é, en commençant par le `RangeElement` spécifié.
`findText(searchPattern)`	`RangeElement`	Recherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
`findText(searchPattern, from)`	`RangeElement`	Recherche dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.
`getAlignment()`	`HorizontalAlignment`	Récupère les `HorizontalAlignment`.
`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 spécifié.
`getHeading()`	`ParagraphHeading`	Récupère les `ParagraphHeading`.
`getIndentEnd()`	`Number`	Récupère le retrait de la fin, en points.
`getIndentFirstLine()`	`Number`	Récupère le retrait de la première ligne, en points.
`getIndentStart()`	`Number`	Récupère le retrait du début.
`getLineSpacing()`	`Number`	Récupère l'interligne, en points.
`getLinkUrl()`	`String`	Récupère l'URL du lien.
`getNextSibling()`	`Element`	Récupère l'élément frère suivant de l'élément.
`getNumChildren()`	`Integer`	Récupère le nombre d'enfants.
`getParent()`	`ContainerElement`	Récupère l'élément parent de l'élément.
`getPositionedImage(id)`	`PositionedImage`	Récupère un `PositionedImage` selon l'ID de l'image.
`getPositionedImages()`	`PositionedImage[]`	Récupère tous les objets `PositionedImage` ancrés au paragraphe.
`getPreviousSibling()`	`Element`	Récupère l'élément frère précédent de l'élément.
`getSpacingAfter()`	`Number`	Récupère l'espacement après l'élément, en points.
`getSpacingBefore()`	`Number`	Récupère l'espacement avant l'élément, en points.
`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 l'élément `ElementType`.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crée et insère un `HorizontalRule` à l'index spécifié.
`insertInlineImage(childIndex, image)`	`InlineImage`	Crée et insère un objet `InlineImage` à partir de l'objet blob de l'image spécifié, au niveau de l'index spécifié.
`insertInlineImage(childIndex, image)`	`InlineImage`	Insère le `InlineImage` donné à l'index spécifié.
`insertPageBreak(childIndex)`	`PageBreak`	Crée et insère un objet `PageBreak` à l'index spécifié.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Insère le `PageBreak` donné à l'index spécifié.
`insertText(childIndex, text)`	`Text`	Crée et insère un élément de texte dans l'index spécifié.
`insertText(childIndex, text)`	`Text`	Insère l'élément `Text` spécifié dans l'index spécifié, avec le contenu textuel spécifié.
`isAtDocumentEnd()`	`Boolean`	Détermine si l'élément se trouve à la fin de `Document`.
`isLeftToRight()`	`Boolean`	Récupère le paramètre de gauche à droite.
`merge()`	`Paragraph`	Fusionne l'élément avec la fratrie précédente du même type.
`removeChild(child)`	`Paragraph`	Supprime l'élément enfant spécifié.
`removeFromParent()`	`Paragraph`	Supprime l'élément de son parent.
`removePositionedImage(id)`	`Boolean`	Supprime un `PositionedImage` selon l'ID de l'image.
`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.
`setAlignment(alignment)`	`Paragraph`	Définit `HorizontalAlignment`.
`setAttributes(attributes)`	`Paragraph`	Définit les attributs de l'élément.
`setHeading(heading)`	`Paragraph`	Définit `ParagraphHeading`.
`setIndentEnd(indentEnd)`	`Paragraph`	Définit la mise en retrait à la fin, en points.
`setIndentFirstLine(indentFirstLine)`	`Paragraph`	Définit le retrait de la première ligne, en points.
`setIndentStart(indentStart)`	`Paragraph`	Définit le retrait du début, en points.
`setLeftToRight(leftToRight)`	`Paragraph`	Définit le paramètre de gauche à droite.
`setLineSpacing(multiplier)`	`Paragraph`	Définit l'interligne, sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.
`setLinkUrl(url)`	`Paragraph`	Définit l'URL du lien.
`setSpacingAfter(spacingAfter)`	`Paragraph`	Définit l'espacement après l'élément, en points.
`setSpacingBefore(spacingBefore)`	`Paragraph`	Définit l'espacement avant l'élément, en points.
`setText(text)`	`void`	Définit le contenu du paragraphe sous forme de texte.
`setTextAlignment(textAlignment)`	`Paragraph`	Définit l'alignement du texte.

Documentation détaillée

`addPositionedImage(image)`

Crée et insère un PositionedImage à partir du blob d'image spécifié.

Paramètres

Nom	Type	Description
`image`	`BlobSource`	les données d'image

Aller-retour

PositionedImage : nouvelle image positionné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

`appendHorizontalRule()`

Crée et ajoute un HorizontalRule.

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

`appendInlineImage(image)`

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

Paramètres

Nom	Type	Description
`image`	`BlobSource`	les 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

`appendInlineImage(image)`

Ajoute le InlineImage indiqué.

Paramètres

Nom	Type	Description
`image`	`InlineImage`	les 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

`appendPageBreak()`

Crée et ajoute un PageBreak.

Remarque: PageBreaks ne doit pas être contenu dans TableCells. Si l'élément actuel est contenu dans une cellule du tableau, une exception sera générée.

Aller-retour

PageBreak : nouvel élément de 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é.

Remarque: PageBreaks ne doit pas être contenu dans TableCells. Si l'élément actuel est contenu dans une cellule du tableau, une exception sera générée.

Paramètres

Nom	Type	Description
`pageBreak`	`PageBreak`	le saut de page à ajouter

Aller-retour

PageBreak : élément de 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

`appendText(text)`

Crée et ajoute un élément Text avec le contenu spécifié.

Paramètres

Nom	Type	Description
`text`	`String`	le contenu textuel

Aller-retour

Text : nouvel élément 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

`appendText(text)`

Ajoute l'élément Text donné.

Paramètres

Nom	Type	Description
`text`	`Text`	Élément de texte à ajouter

Aller-retour

Text : élément de texte 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

`clear()`

Efface le contenu de l'élément.

Aller-retour

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

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

Nom	Type	Description
`elementType`	`ElementType`	Type 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

Nom	Type	Description
`elementType`	`ElementType`	Type d'élément à rechercher
`from`	`RangeElement`	le 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

Nom	Type	Description
`searchPattern`	`String`	le 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

Nom	Type	Description
`searchPattern`	`String`	le modèle à rechercher
`from`	`RangeElement`	le 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

`getAlignment()`

Récupère les HorizontalAlignment.

Aller-retour

HorizontalAlignment : alignement.

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

Nom	Type	Description
`childIndex`	`Integer`	index 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

Nom	Type	Description
`child`	`Element`	É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

`getHeading()`

Récupère les ParagraphHeading.

Aller-retour

ParagraphHeading : titre

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

`getIndentEnd()`

Récupère le retrait de la fin, en points.

Aller-retour

Number : retrait en retrait, 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

`getIndentFirstLine()`

Récupère le retrait de la première ligne, en points.

Aller-retour

Number : retrait de la première ligne, 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

`getIndentStart()`

Récupère le retrait du début.

Aller-retour

Number : retrait au début

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

`getLineSpacing()`

Récupère l'interligne, en points.

Aller-retour

Number : espacement entre les lignes, 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

`getLinkUrl()`

Récupère l'URL du lien.

Aller-retour

String : URL du lien, ou valeur "null" 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()`

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

`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

`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

`getPositionedImage(id)`

Récupère un PositionedImage selon l'ID de l'image.

Paramètres

Nom	Type	Description
`id`	`String`	ID de l'image

Aller-retour

PositionedImage : image positionné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

`getPositionedImages()`

Récupère tous les objets PositionedImage ancrés au paragraphe.

Aller-retour

PositionedImage[] : liste d'images positionnées

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

`getSpacingAfter()`

Récupère l'espacement après l'élément, en points.

Aller-retour

Number : espacement après l'élément (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

`getSpacingBefore()`

Récupère l'espacement avant l'élément, en points.

Aller-retour

Number : espacement avant l'élément (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

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément

Aller-retour

HorizontalRule : nouvel élément de 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

`insertInlineImage(childIndex, image)`

Crée et insère un objet InlineImage à partir de l'objet blob de l'image spécifié, au niveau de l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément
`image`	`BlobSource`	les données d'image

Aller-retour

InlineImage : élément d'image intégré

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

`insertInlineImage(childIndex, image)`

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément
`image`	`InlineImage`	les données d'image

Aller-retour

InlineImage : élément d'image intégré

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

Remarque : PageBreaks ne doit pas être contenu dans TableCells. Si l'élément actuel est contenu dans une cellule du tableau, une exception sera générée.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément

Aller-retour

PageBreak : nouvel élément de 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é.

Remarque : PageBreaks ne doit pas être contenu dans TableCells. Si l'élément actuel est contenu dans une cellule du tableau, une exception sera générée.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément
`pageBreak`	`PageBreak`	le p[age break to insert

Aller-retour

PageBreak : élément de 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

`insertText(childIndex, text)`

Crée et insère un élément de texte dans l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément
`text`	`String`	le contenu textuel

Aller-retour

Text : nouvel élément 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

`insertText(childIndex, text)`

Insère l'élément Text spécifié dans l'index spécifié, avec le contenu textuel spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	index dans lequel insérer l'élément
`text`	`Text`	Élément de texte à insérer

Aller-retour

Text : élément textuel 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

`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

`isLeftToRight()`

Récupère le paramètre de gauche à droite.

Aller-retour

Boolean : paramètre de gauche à droite

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

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

`removeChild(child)`

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

Paramètres

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

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

`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

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

`removePositionedImage(id)`

Supprime un PositionedImage selon l'ID de l'image.

Paramètres

Nom	Type	Description
`id`	`String`	ID de l'image

Aller-retour

Boolean : indique si l'image spécifiée a été supprimé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

`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

Nom	Type	Description
`searchPattern`	`String`	le modèle d'expression régulière à rechercher
`replacement`	`String`	Texte à 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

`setAlignment(alignment)`

Définit HorizontalAlignment.

Paramètres

Nom	Type	Description
`alignment`	`HorizontalAlignment`	l'alignement horizontal

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

`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

Nom	Type	Description
`attributes`	`Object`	Attributs de l'élément.

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

`setHeading(heading)`

Définit ParagraphHeading.

Paramètres

Nom	Type	Description
`heading`	`ParagraphHeading`	le titre

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

`setIndentEnd(indentEnd)`

Définit la mise en retrait à la fin, en points.

Paramètres

Nom	Type	Description
`indentEnd`	`Number`	retrait en retrait, en points

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

`setIndentFirstLine(indentFirstLine)`

Définit le retrait de la première ligne, en points.

Paramètres

Nom	Type	Description
`indentFirstLine`	`Number`	retrait de la première ligne, en points

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

`setIndentStart(indentStart)`

Définit le retrait du début, en points.

Paramètres

Nom	Type	Description
`indentStart`	`Number`	retrait du début, en points

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

`setLeftToRight(leftToRight)`

Définit le paramètre de gauche à droite.

Paramètres

Nom	Type	Description
`leftToRight`	`Boolean`	le paramètre de gauche à droite

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

`setLineSpacing(multiplier)`

Définit l'interligne, sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.

Paramètres

Nom	Type	Description
`multiplier`	`Number`	le nombre de lignes

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

`setLinkUrl(url)`

Définit l'URL du lien.

Paramètres

Nom	Type	Description
`url`	`String`	URL du lien

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

`setSpacingAfter(spacingAfter)`

Définit l'espacement après l'élément, en points.

Paramètres

Nom	Type	Description
`spacingAfter`	`Number`	espacement après l'élément, en points

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

`setSpacingBefore(spacingBefore)`

Définit l'espacement avant l'élément, en points.

Paramètres

Nom	Type	Description
`spacingBefore`	`Number`	espacement avant l'élément (en points)

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

`setText(text)`

Définit le contenu du paragraphe sous forme de texte.

Remarque: Le contenu existant est effacé.

Paramètres

Nom	Type	Description
`text`	`String`	le nouveau contenu textuel

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

Nom	Type	Description
`textAlignment`	`TextAlignment`	Type d'alignement du texte à appliquer.

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