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

Class ListItem

Élément représentant un élément de liste. Un ListItem est un Paragraph associé à un ID de liste. Un élément ListItem 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.

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

Les ListItems ayant le même ID de liste appartiennent à la même liste et sont numérotés en conséquence. Les ListItems d'une liste donnée ne doivent pas nécessairement être adjacents dans l'onglet ni même avoir le même élément parent. Deux éléments appartenant à la même liste peuvent se trouver n'importe où dans l'onglet tout en conservant une numérotation consécutive, comme illustré dans l'exemple suivant:

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

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

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 objet `HorizontalRule`.
`appendInlineImage(image)`	`InlineImage`	Crée et ajoute un `InlineImage` à partir du blob d'image spécifié.
`appendInlineImage(image)`	`InlineImage`	Ajoute le `InlineImage` donné.
`appendPageBreak()`	`PageBreak`	Crée et ajoute un objet `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Ajoute le `PageBreak` donné.
`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()`	`ListItem`	Efface le contenu de l'élément.
`copy()`	`ListItem`	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é.
`getAlignment()`	`HorizontalAlignment`	Récupère `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 pour l'élément enfant spécifié.
`getGlyphType()`	`GlyphType`	Récupère le `GlyphType` de l'élément de liste.
`getHeading()`	`ParagraphHeading`	Récupère `ParagraphHeading`.
`getIndentEnd()`	`Number`	Récupère l'indentation de fin, en points.
`getIndentFirstLine()`	`Number`	Récupère la mise en retrait de la première ligne, en points.
`getIndentStart()`	`Number`	Récupère l'indentation de début.
`getLineSpacing()`	`Number`	Récupère l'interligne, en points.
`getLinkUrl()`	`String`	Récupère l'URL du lien.
`getListId()`	`String`	Récupère l'ID de la liste.
`getNestingLevel()`	`Integer`	Récupère le niveau d'imbrication de l'élément de liste.
`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` par 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 le `ElementType` de l'élément.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crée et insère un `HorizontalRule` à l'index spécifié.
`insertInlineImage(childIndex, image)`	`InlineImage`	Crée et insère un `InlineImage` à partir du blob d'image spécifié, à l'index spécifié.
`insertInlineImage(childIndex, image)`	`InlineImage`	Insère l'`InlineImage` donné à l'index 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é.
`insertText(childIndex, text)`	`Text`	Crée et insère un élément de texte à l'indice spécifié.
`insertText(childIndex, text)`	`Text`	Insère l'élément `Text` donné à 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()`	`ListItem`	Fusionne l'élément avec le frère précédent de même type.
`removeChild(child)`	`ListItem`	Supprime l'élément enfant spécifié.
`removeFromParent()`	`ListItem`	Supprime l'élément de son parent.
`removePositionedImage(id)`	`Boolean`	Supprime un `PositionedImage` par 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)`	`ListItem`	Définit `HorizontalAlignment`.
`setAttributes(attributes)`	`ListItem`	Définit les attributs de l'élément.
`setGlyphType(glyphType)`	`ListItem`	Définit l'`GlyphType` de l'élément de liste.
`setHeading(heading)`	`ListItem`	Définit `ParagraphHeading`.
`setIndentEnd(indentEnd)`	`ListItem`	Définit le retrait de fin, en points.
`setIndentFirstLine(indentFirstLine)`	`ListItem`	Définit le retrait de la première ligne, en points.
`setIndentStart(indentStart)`	`ListItem`	Définit le retrait de début, en points.
`setLeftToRight(leftToRight)`	`ListItem`	Définit le paramètre de gauche à droite.
`setLineSpacing(multiplier)`	`ListItem`	Définit l'espacement des lignes, en tant que quantité indiquant le nombre de lignes à utiliser pour l'espacement.
`setLinkUrl(url)`	`ListItem`	Définit l'URL du lien.
`setListId(listItem)`	`ListItem`	Définit l'ID de la liste.
`setNestingLevel(nestingLevel)`	`ListItem`	Définit le niveau d'imbrication de l'élément de liste.
`setSpacingAfter(spacingAfter)`	`ListItem`	Définit l'espacement après l'élément, en points.
`setSpacingBefore(spacingBefore)`	`ListItem`	Définit l'espacement avant l'élément, en points.
`setText(text)`	`void`	Définit le contenu de l'élément de liste en tant que texte.
`setTextAlignment(textAlignment)`	`ListItem`	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 ;

Renvois

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

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

`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 ;

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

`appendInlineImage(image)`

Ajoute le InlineImage donné.

Paramètres

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

`appendPageBreak()`

Crée et ajoute un objet PageBreak.

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

Renvois

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

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

Paramètres

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

Renvois

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

Renvois

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'élément texte à ajouter

Renvois

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

Renvois

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

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

`getAlignment()`

Récupère HorizontalAlignment.

Renvois

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.

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

`getGlyphType()`

Récupère le GlyphType de l'élément de liste.

Renvois

GlyphType : type de glyphe

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

Renvois

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 l'indentation de fin, en points.

Renvois

Number : retrait à la fin, 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 la mise en retrait de la première ligne, en points.

Renvois

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 l'indentation de début.

Renvois

Number : retrait de 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.

Renvois

Number : interligne, 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.

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

`getListId()`

Récupère l'ID de la liste.

Renvois

String : ID de la 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

`getNestingLevel()`

Récupère le niveau d'imbrication de l'élément de liste.

Par défaut, les éléments de liste ont un niveau d'imbrication de zéro. Le niveau d'imbrication détermine le glyphe utilisé par l'élément de liste.

Renvois

Integer : niveau d'imbrication

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.

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

`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

`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

`getPositionedImage(id)`

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

Paramètres

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

Renvois

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.

Renvois

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

`getSpacingAfter()`

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

Renvois

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.

Renvois

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.

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;

Renvois

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 InlineImage à partir du blob d'image spécifié, à l'index spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`image`	`BlobSource`	les données d'image ;

Renvois

InlineImage : élément image intégré 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

`insertInlineImage(childIndex, image)`

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`image`	`InlineImage`	les données d'image ;

Renvois

InlineImage : élément image intégré 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

`insertPageBreak(childIndex)`

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

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;

Renvois

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

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`pageBreak`	`PageBreak`	le saut de page à insérer

Renvois

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 à l'indice spécifié.

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`text`	`String`	le contenu textuel

Renvois

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`text`	`Text`	l'élément de texte à insérer

Renvois

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

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

`isLeftToRight()`

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

Renvois

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 le frère précédent de 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.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Renvois

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

Renvois

ListItem : élément actuel

Autorisation

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

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

`removeFromParent()`

Supprime l'élément de son parent.

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Renvois

ListItem : é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 par ID de l'image.

Paramètres

Nom	Type	Description
`id`	`String`

Renvois

Boolean : indique si l'image spécifiée a été supprimée ou non.

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

`setAlignment(alignment)`

Définit HorizontalAlignment.

Paramètres

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

Renvois

ListItem : élément actuel

Autorisation

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

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

`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

ListItem : élément actuel.

Autorisation

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

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

`setGlyphType(glyphType)`

Définit l'GlyphType de l'élément de liste.

Paramètres

Nom	Type	Description
`glyphType`	`GlyphType`	le type de glyphe ;

Renvois

ListItem : élément actuel

Autorisation

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

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

`setHeading(heading)`

Définit ParagraphHeading.

Paramètres

Nom	Type	Description
`heading`	`ParagraphHeading`	l'en-tête

Renvois

ListItem : élément actuel

Autorisation

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

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

`setIndentEnd(indentEnd)`

Définit le retrait de fin, en points.

Paramètres

Nom	Type	Description
`indentEnd`	`Number`	Indentation de fin, en points

Renvois

ListItem : élément actuel

Autorisation

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

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

`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

Renvois

ListItem : élément actuel

Autorisation

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

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

`setIndentStart(indentStart)`

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

Paramètres

Nom	Type	Description
`indentStart`	`Number`	indentation de début, en points

Renvois

ListItem : élément actuel

Autorisation

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

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

`setLeftToRight(leftToRight)`

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

Paramètres

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

Renvois

ListItem : élément actuel

Autorisation

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

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

`setLineSpacing(multiplier)`

Définit l'espacement des lignes, en tant que quantité indiquant le nombre de lignes à utiliser pour l'espacement.

Paramètres

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

Renvois

ListItem : élément actuel

Autorisation

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

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

`setLinkUrl(url)`

Définit l'URL du lien.

Paramètres

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

Renvois

ListItem : élément actuel

Autorisation

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

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

`setListId(listItem)`

Définit l'ID de la liste.

L'ID de la liste est défini sur la même valeur pour l'ListItem spécifié. Les deux ListItems seront traités comme membres de la même liste.

Paramètres

Nom	Type	Description
`listItem`	`ListItem`	l'élément de liste dont vous souhaitez utiliser l'ID de liste

Renvois

ListItem : élément actuel

Autorisation

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

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

`setNestingLevel(nestingLevel)`

Définit le niveau d'imbrication de l'élément de liste.

Par défaut, les éléments de liste ont un niveau d'imbrication de zéro. Le niveau d'imbrication détermine le glyphe utilisé par l'élément de liste.

Paramètres

Nom	Type	Description
`nestingLevel`	`Integer`	le niveau d'imbrication

Renvois

ListItem : élément actuel

Autorisation

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

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

`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

Renvois

ListItem : élément actuel

Autorisation

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

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

`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

Renvois

ListItem : élément actuel

Autorisation

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

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

`setText(text)`

Définit le contenu de l'élément de liste en tant que texte.

Remarque: Les contenus existants sont effacés.

Paramètres

Nom	Type	Description
`text`	`String`	les nouveaux contenus textuels ;

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

ListItem : élément actuel

Autorisation

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

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