Class ListItem

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
ListItem

Élément représentant un élément de liste. Un ListItem est un Paragraph associé à un ID de liste. Un 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 (") sont convertis en caractères de saut de ligne ("\r").

Les éléments ListItems associés à un même ID appartiennent à la même liste et sont numérotés en conséquence. Le ListItems d'une liste donnée ne doit pas nécessairement être adjacent dans le document ni avoir le même élément parent. Deux éléments appartenant à la même liste peuvent exister n'importe où dans le document tout en conservant une numérotation consécutive, comme illustré dans l'exemple suivant:

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

// Append a new list item to the body.
var 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.
var 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 indiqué.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak indiqué.
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 dissociée de l'élément actif.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.
getAlignment()HorizontalAlignmentRécupère les 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 de l'élément enfant spécifié.
getGlyphType()GlyphTypeRécupère l'élément GlyphType.
getHeading()ParagraphHeadingRécupère les ParagraphHeading.
getIndentEnd()NumberRécupère le retrait de la fin, en points.
getIndentFirstLine()NumberRécupère le retrait de la première ligne, en points.
getIndentStart()NumberRécupère le retrait du début.
getLineSpacing()NumberRécupère l'interligne, en points.
getLinkUrl()StringRécupère l'URL du lien.
getListId()StringRécupère l'ID de la liste.
getNestingLevel()IntegerRécupère le niveau d'imbrication de l'élément de liste.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPositionedImage(id)PositionedImageRécupère un PositionedImage selon l'ID de l'image.
getPositionedImages()PositionedImage[]Récupère tous les objets PositionedImage ancrés au paragraphe.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getSpacingAfter()NumberRécupère l'espacement après l'élément, en points.
getSpacingBefore()NumberRé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()TextAlignmentRécupère l'alignement du texte.
getType()ElementTypeRécupère l'élément ElementType.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageCré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)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un objet PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertText(childIndex, text)TextCrée et insère un élément de texte dans l'index spécifié.
insertText(childIndex, text)TextInsère l'élément Text spécifié dans l'index spécifié, avec le contenu textuel spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isLeftToRight()BooleanRécupère le paramètre de gauche à droite.
merge()ListItemFusionne l'élément avec la fratrie précédente du même type.
removeChild(child)ListItemSupprime l'élément enfant spécifié.
removeFromParent()ListItemSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un PositionedImage selon 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 l'élément de liste GlyphType.
setHeading(heading)ListItemDéfinit ParagraphHeading.
setIndentEnd(indentEnd)ListItemDéfinit la mise en retrait à la fin, en points.
setIndentFirstLine(indentFirstLine)ListItemDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ListItemDéfinit le retrait du 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 sous forme de 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

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

NomTypeDescription
imageBlobSourceles données d'image

Aller-retour

InlineImage : image ajoutée

Autorisation

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

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

appendInlineImage(image)

Ajoute le InlineImage indiqué.

Paramètres

NomTypeDescription
imageInlineImageles données d'image

Aller-retour

InlineImage : image ajoutée

Autorisation

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

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

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

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

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

NomTypeDescription
textTextÉ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

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

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

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Aller-retour

Text : version textuelle de l'élément actuel


findElement(elementType)

Recherche dans le contenu de l'élément un descendant du type spécifié.

Paramètres

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher

Aller-retour

RangeElement : résultat de recherche indiquant la position de l'élément de recherche

Autorisation

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

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

findElement(elementType, from)

Recherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.

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

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

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

Paramètres

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

Aller-retour

RangeElement : résultat de recherche indiquant la position suivante de l'élément de recherche

Autorisation

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

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

findText(searchPattern)

Recherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.

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

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

Paramètres

NomTypeDescription
searchPatternStringle modèle à rechercher

Aller-retour

RangeElement : résultat de recherche indiquant la position du texte de recherche ou valeur null en l'absence de correspondance.

Autorisation

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

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

findText(searchPattern, from)

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

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

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

Paramètres

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

Aller-retour

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

Autorisation

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

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

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

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

Aller-retour

Element : élément enfant à l'index spécifié

Autorisation

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

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

getChildIndex(child)

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

Paramètres

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

Aller-retour

Integer : index enfant

Autorisation

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

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

getGlyphType()

Récupère l'élément GlyphType.

Aller-retour

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

getListId()

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

Aller-retour

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 d'une liste ont un niveau d'imbrication égal à zéro. Le niveau d'imbrication détermine le glyphe utilisé par l'élément de la liste.

Aller-retour

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.

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

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

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

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
imageBlobSourceles 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

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
imageInlineImageles 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

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

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
pageBreakPageBreakle 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

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
textStringle 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

NomTypeDescription
childIndexIntegerindex dans lequel insérer l'élément
textTextÉ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

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

NomTypeDescription
childElementl'élément enfant à supprimer

Aller-retour

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.

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

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 selon l'ID de l'image.

Paramètres

NomTypeDescription
idString

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

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

Aller-retour

Element : élément actuel

Autorisation

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

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

setAlignment(alignment)

Définit HorizontalAlignment.

Paramètres

NomTypeDescription
alignmentHorizontalAlignmentl'alignement horizontal

Aller-retour

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é correspond à la nouvelle valeur à appliquer.

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

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Paramètres

NomTypeDescription
attributesObjectAttributs de l'élément.

Aller-retour

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'élément de liste GlyphType.

Paramètres

NomTypeDescription
glyphTypeGlyphTypele type de glyphe

Aller-retour

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

NomTypeDescription
headingParagraphHeadingle titre

Aller-retour

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 la mise en retrait à la fin, en points.

Paramètres

NomTypeDescription
indentEndNumberretrait en retrait, en points

Aller-retour

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

NomTypeDescription
indentFirstLineNumberretrait de la première ligne, en points

Aller-retour

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 du début, en points.

Paramètres

NomTypeDescription
indentStartNumberretrait du début, en points

Aller-retour

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

NomTypeDescription
leftToRightBooleanle paramètre de gauche à droite

Aller-retour

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'interligne, sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.

Paramètres

NomTypeDescription
multiplierNumberle nombre de lignes

Aller-retour

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

NomTypeDescription
urlStringURL du lien

Aller-retour

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 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 vous voulez utiliser l'ID

Aller-retour

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 d'une liste ont un niveau d'imbrication égal à zéro. Le niveau d'imbrication détermine le glyphe utilisé par l'élément de la liste.

Paramètres

NomTypeDescription
nestingLevelIntegerle niveau d'imbrication

Aller-retour

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

NomTypeDescription
spacingAfterNumberespacement après l'élément, en points

Aller-retour

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

NomTypeDescription
spacingBeforeNumberespacement avant l'élément (en points)

Aller-retour

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 sous forme de texte.

Remarque: Le contenu existant est effacé.

Paramètres

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

NomTypeDescription
textAlignmentTextAlignmentType d'alignement du texte à appliquer.

Aller-retour

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