Class ListItem

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 sur l'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 l'illustre 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éthodeType renvoyéBrève description
addPositionedImage(image)PositionedImageCrée et insère un PositionedImage à partir du blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute le InlineImage donné.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak donné.
appendText(text)TextCrée et ajoute un élément Text avec le contenu spécifié.
appendText(text)TextAjoute l'élément Text donné.
clear()ListItemEfface le contenu de l'élément.
copy()ListItemRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAlignment()HorizontalAlignment|nullRécupère le HorizontalAlignment.
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 enfant pour l'élément enfant spécifié.
getGlyphType()GlyphType|nullRécupère le GlyphType de l'élément de liste.
getHeading()ParagraphHeading|nullRécupère le ParagraphHeading.
getIndentEnd()Number|nullRécupère l'indentation de fin, en points.
getIndentFirstLine()Number|nullRécupère la mise en retrait de la première ligne, en points.
getIndentStart()Number|nullRécupère l'indentation de début.
getLineSpacing()Number|nullRécupère l'interligne, en points.
getLinkUrl()String|nullRécupère l'URL du lien.
getListId()String|nullRécupère l'ID de la liste.
getNestingLevel()IntegerRécupère le niveau d'imbrication de l'élément de liste.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPositionedImage(id)PositionedImageObtient un PositionedImage par l'ID de l'image.
getPositionedImages()PositionedImage[]Récupère tous les objets PositionedImage ancrés au paragraphe.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getSpacingAfter()Number|nullRécupère l'espacement après l'élément, en points.
getSpacingBefore()Number|nullRécupère l'espacement avant l'élément, en points.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertText(childIndex, text)TextCrée et insère un élément de texte à l'index spécifié.
insertText(childIndex, text)TextInsère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isLeftToRight()Boolean|nullRécupère le paramètre de gauche à droite.
merge()ListItem|nullFusionne l'élément avec l'élément frère précédent du même type.
removeChild(child)ListItemSupprime l'élément enfant spécifié.
removeFromParent()ListItem|nullSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un PositionedImage par l'ID de l'image.
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.
setAlignment(alignment)ListItemDéfinit HorizontalAlignment.
setAttributes(attributes)ListItemDéfinit les attributs de l'élément.
setGlyphType(glyphType)ListItemDéfinit le GlyphType de l'élément de liste.
setHeading(heading)ListItemDéfinit ParagraphHeading.
setIndentEnd(indentEnd)ListItemDéfinit le retrait de fin, en points.
setIndentFirstLine(indentFirstLine)ListItemDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ListItemDéfinit le retrait de début, en points.
setLeftToRight(leftToRight)ListItemDéfinit le paramètre de gauche à droite.
setLineSpacing(multiplier)ListItemDéfinit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.
setLinkUrl(url)ListItemDéfinit l'URL du lien.
setListId(listItem)ListItemDéfinit l'ID de la liste.
setNestingLevel(nestingLevel)ListItemDéfinit le niveau d'imbrication de l'élément de liste.
setSpacingAfter(spacingAfter)ListItemDéfinit l'espacement après l'élément, en points.
setSpacingBefore(spacingBefore)ListItemDéfinit l'espacement avant l'élément, en points.
setText(text)voidDéfinit le contenu de l'élément de liste en tant que texte.
setTextAlignment(textAlignment)ListItemDé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

NomTypeDescription
imageBlobSourceles données d'image.

Renvois

PositionedImage : la nouvelle image positionnée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

appendHorizontalRule()

Crée et ajoute un HorizontalRule.

Renvois

HorizontalRule : la nouvelle règle horizontale

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
imageBlobSourceles 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 scopes suivants :

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

appendInlineImage(image)

Ajoute le InlineImage donné.

Paramètres

NomTypeDescription
imageInlineImageles 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 scopes suivants :

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

appendPageBreak()

Crée et ajoute un PageBreak.

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

Renvois

PageBreak : le nouvel élément de saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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. Une exception sera générée si l'élément actuel est contenu dans une cellule de tableau.

Paramètres

NomTypeDescription
pageBreakPageBreakSaut 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 scopes 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

NomTypeDescription
textStringle contenu textuel ;

Renvois

Text : le nouvel élément de texte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

appendText(text)

Ajoute l'élément Text donné.

Paramètres

NomTypeDescription
textTextl'élément de texte à ajouter.

Renvois

Text : élément de texte ajouté

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 détachée et complète 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 : la nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

editAsText()

Obtient une version Text de l'élément actuel, pour la 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 texte 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.

Renvois

RangeElement|null : 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 scopes 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é. 

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

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher.
fromRangeElementRésultat de recherche à partir duquel effectuer la recherche.

Renvois

RangeElement|null : 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 scopes suivants :

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

findText(searchPattern)

Recherche le contenu de l'élément correspondant au modèle 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 pris en charge, comme les groupes de capture et les modificateurs de mode.

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

Paramètres

NomTypeDescription
searchPatternStringle modèle à rechercher

Renvois

RangeElement|null : résultat de recherche indiquant la position du texte recherché ou "null" en l'absence de correspondance

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

findText(searchPattern, from)

Recherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.

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

Le modèle d'expression régulière fourni est mis en correspondance de manière indépendante 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 effectuer la recherche ;

Renvois

RangeElement|null : résultat de recherche indiquant la position suivante 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 scopes suivants :

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

getAlignment()

Récupère le HorizontalAlignment.

Renvois

HorizontalAlignment|null : l'alignement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 scopes 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

NomTypeDescription
childIndexIntegerIndex 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 scopes suivants :

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

getChildIndex(child)

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

Paramètres

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

Renvois

Integer : index de l'enfant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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|null : type de glyphe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getHeading()

Récupère le ParagraphHeading.

Renvois

ParagraphHeading|null : titre

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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|null : retrait de fin, en points

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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|null : 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 scopes 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|null : retrait de début

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getLineSpacing()

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

Renvois

Number|null : interligne, en points

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getLinkUrl()

Récupère l'URL du lien.

Renvois

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

Autorisation

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

L'élément frère suivant a le même parent et suit l'élément actuel.

Renvois

Element|null : élément frère suivant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 scopes 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|null : élément parent.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getPositionedImage(id)

Obtient un PositionedImage par l'ID de l'image.

Paramètres

NomTypeDescription
idStringID 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 scopes 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 scopes 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|null : élément frère précédent.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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|null : 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 scopes 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|null : espacement avant l'élément, en points

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 scopes 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|null : type d'alignement du texte ou null si le texte contient plusieurs types d'alignement 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 scopes 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 scopes 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

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément

Renvois

HorizontalRule : le nouvel élément de règle horizontale

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
imageBlobSourceles données d'image.

Renvois

InlineImage : élément d'image intégrée inséré

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
imageInlineImageles données d'image.

Renvois

InlineImage : élément d'image intégrée inséré

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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. Une exception sera générée si l'élément actuel est contenu dans une cellule de tableau.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément

Renvois

PageBreak : le nouvel élément de saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 peut pas être contenu dans TableCells. Une exception sera générée si l'élément actuel est contenu dans une cellule de tableau.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
pageBreakPageBreakle 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 scopes 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'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
textStringle contenu textuel ;

Renvois

Text : le nouvel élément de texte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
textTextl'é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 scopes 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 scopes 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|null : paramètre de gauche à droite

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

merge()

Fusionne l'élément avec l'élément frère précédent 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. 

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|null : élément fusionné.

Autorisation

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

Renvois

ListItem : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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|null : élément supprimé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

removePositionedImage(id)

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

Paramètres

NomTypeDescription
idString

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 scopes 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 sous forme de chaîne, et non d'objet d'expression régulière JavaScript. Pour cette raison, vous devrez échapper toutes les barres obliques inverses du 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 de manière indépendante 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

NomTypeDescription
searchPatternStringle modèle d'expression régulière à rechercher
replacementStringle 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 scopes suivants :

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

setAlignment(alignment)

Définit HorizontalAlignment.

Paramètres

NomTypeDescription
alignmentHorizontalAlignmentl'alignement horizontal ;

Renvois

ListItem : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
attributesObjectAttributs 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 scopes suivants :

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

setGlyphType(glyphType)

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

Paramètres

NomTypeDescription
glyphTypeGlyphTypele 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 scopes suivants :

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

setHeading(heading)

Définit ParagraphHeading.

Paramètres

NomTypeDescription
headingParagraphHeadingl'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 scopes 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

NomTypeDescription
indentEndNumberl'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 scopes 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

NomTypeDescription
indentFirstLineNumberRetrait 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 scopes 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

NomTypeDescription
indentStartNumberl'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 scopes 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

NomTypeDescription
leftToRightBooleanle paramètre 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 scopes 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

NomTypeDescription
multiplierNumberle 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 scopes suivants :

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

setLinkUrl(url)

Définit l'URL du lien.

Paramètres

NomTypeDescription
urlStringl'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 scopes 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 le ListItem spécifié. Les deux ListItems seront traités comme des membres de la même liste.

Paramètres

NomTypeDescription
listItemListItemÉlément de liste dont l'ID de liste doit être utilisé

Renvois

ListItem : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
nestingLevelIntegerle 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 scopes 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

NomTypeDescription
spacingAfterNumberl'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 scopes 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

NomTypeDescription
spacingBeforeNumberEspacement 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 scopes 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

NomTypeDescription
textStringle nouveau contenu textuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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

NomTypeDescription
textAlignmentTextAlignmentle 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 scopes suivants :

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