Class TableCell

TableCell

Élément représentant une cellule de tableau. Un élément TableCell est toujours contenu dans un élément TableRow et peut contenir des éléments ListItem, Paragraph ou Table. Pour en savoir plus sur la structure des documents, consultez le guide sur l'extension de Google Docs.

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute le InlineImage donné.
appendListItem(listItem)ListItemAjoute le ListItem donné.
appendListItem(text)ListItemCrée et ajoute un ListItem.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouvel Table contenant les cellules spécifiées.
appendTable(table)TableAjoute le Table donné.
clear()TableCellEfface le contenu de l'élément.
copy()TableCellRenvoie 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 le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getBackgroundColor()String|nullRécupère la couleur d'arrière-plan.
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é.
getColSpan()IntegerRécupère l'étendue de la colonne, qui correspond au nombre de colonnes de cellules de tableau couvertes par cette cellule.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getPaddingBottom()Number|nullRécupère la marge intérieure inférieure, en points.
getPaddingLeft()Number|nullRécupère la marge intérieure de gauche, en points.
getPaddingRight()Number|nullRécupère la marge intérieure de droite, en points.
getPaddingTop()Number|nullRécupère la marge intérieure supérieure, en points.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getParentRow()TableRow|nullRécupère le TableRow contenant le TableCell actuel.
getParentTable()Table|nullRécupère le Table contenant le TableCell actuel.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getRowSpan()IntegerRécupère le nombre de lignes de cellules de tableau couvertes par cette cellule.
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.
getVerticalAlignment()VerticalAlignment|nullRécupère le VerticalAlignment.
getWidth()Number|nullRécupère la largeur de la colonne contenant la cellule, en points.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem à l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph à l'index spécifié.
insertTable(childIndex)TableCrée et insère un Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableCell|nullFusionne l'élément avec l'élément frère précédent du même type.
removeChild(child)TableCellSupprime l'élément enfant spécifié.
removeFromParent()TableCell|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableCellDéfinit les attributs de l'élément.
setBackgroundColor(color)TableCellDéfinit la couleur d'arrière-plan.
setLinkUrl(url)TableCellDéfinit l'URL du lien.
setPaddingBottom(paddingBottom)TableCellDéfinit la marge intérieure inférieure, en points.
setPaddingLeft(paddingLeft)TableCellDéfinit la marge intérieure de gauche, en points.
setPaddingRight(paddingRight)TableCellDéfinit la marge intérieure de droite, en points.
setPaddingTop(paddingTop)TableCellDéfinit la marge intérieure supérieure, en points.
setText(text)TableCellDéfinit le contenu en tant que texte brut.
setTextAlignment(textAlignment)TableCellDéfinit l'alignement du texte.
setVerticalAlignment(alignment)TableCellDéfinit l'alignement vertical.
setWidth(width)TableCellDéfinit la largeur de la colonne contenant la cellule actuelle, en points.

Documentation détaillée

appendHorizontalRule()

Crée et ajoute un HorizontalRule.

HorizontalRule sera contenu dans un nouveau Paragraph.

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

appendImage(image)

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

InlineImage sera contenu dans un nouveau Paragraph.

Paramètres

NomTypeDescription
imageBlobSourceles données d'image.

Renvois

InlineImage : la nouvelle image

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

appendImage(image)

Ajoute le InlineImage donné.

InlineImage sera contenu dans un nouveau Paragraph.

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

appendListItem(listItem)

Ajoute le ListItem donné.

Paramètres

NomTypeDescription
listItemListItemÉlément de liste à ajouter

Renvois

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

appendListItem(text)

Crée et ajoute un ListItem.

Paramètres

NomTypeDescription
textStringle contenu textuel ;

Renvois

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

appendParagraph(paragraph)

Ajoute le Paragraph donné.

Paramètres

NomTypeDescription
paragraphParagraphParagraphe à ajouter

Renvois

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

appendParagraph(text)

Crée et ajoute un Paragraph.

Paramètres

NomTypeDescription
textStringle contenu textuel ;

Renvois

Paragraph : nouveau paragraphe

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

appendTable()

Crée et ajoute un Table.

Renvois

Table : la nouvelle table

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

appendTable(cells)

Ajoute un nouvel Table contenant les cellules spécifiées.

Paramètres

NomTypeDescription
cellsString[][]le contenu textuel des cellules du tableau à ajouter au nouveau tableau.

Renvois

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

appendTable(table)

Ajoute le Table donné.

Paramètres

NomTypeDescription
tableTableTable à ajouter

Renvois

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

clear()

Efface le contenu de l'élément.

Renvois

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

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

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

getBackgroundColor()

Récupère la couleur d'arrière-plan.

Renvois

String|null : couleur d'arrière-plan, formatée en notation CSS (comme '#ffffff')

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

getColSpan()

Récupère l'étendue de la colonne, qui correspond au nombre de colonnes de cellules de tableau couvertes par cette cellule. Les cellules non fusionnées ont une portée de colonne de 1.

Renvois

Integer : étendue de la colonne ou 0 pour une cellule fusionnée avec une autre cellule

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

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

getPaddingBottom()

Récupère la marge intérieure inférieure, en points.

Renvois

Number|null : marge intérieure inférieure, 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

getPaddingLeft()

Récupère la marge intérieure de gauche, en points.

Renvois

Number|null : marge intérieure de gauche, 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

getPaddingRight()

Récupère la marge intérieure de droite, en points.

Renvois

Number|null : marge intérieure de droite, 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

getPaddingTop()

Récupère la marge intérieure supérieure, en points.

Renvois

Number|null : marge intérieure supérieure, 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

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

getParentRow()

Récupère le TableRow contenant le TableCell actuel.

Renvois

TableRow|null : ligne du tableau contenant la cellule actuelle

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

getParentTable()

Récupère le Table contenant le TableCell actuel.

Renvois

Table|null : table contenant la cellule actuelle

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

getRowSpan()

Récupère le nombre de lignes de cellules de tableau couvertes par cette cellule. Les cellules non fusionnées ont une étendue de ligne de 1.

Renvois

Integer : étendue de ligne ou 0 pour une cellule fusionnée par une autre cellule

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

getVerticalAlignment()

Récupère le VerticalAlignment.

Renvois

VerticalAlignment|null : alignement vertical

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

getWidth()

Récupère la largeur de la colonne contenant la cellule, en points.

Renvois

Number|null : largeur de la colonne, 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

insertHorizontalRule(childIndex)

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

La règle horizontale sera contenue dans un nouveau Paragraph.

Paramètres

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

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

insertImage(childIndex, image)

Crée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.

L'image sera contenue dans un nouveau Paragraph.

Paramètres

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

Renvois

InlineImage : l'image intégrée inséré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

insertImage(childIndex, image)

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

L'image sera contenue dans un nouveau Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
imageInlineImagel'image à insérer ;

Renvois

InlineImage : l'image intégrée inséré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

insertListItem(childIndex, listItem)

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

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
listItemListItemÉlément de liste à insérer

Renvois

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

insertListItem(childIndex, text)

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

Paramètres

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

Renvois

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

insertParagraph(childIndex, paragraph)

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

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément
paragraphParagraphle paragraphe à insérer ;

Renvois

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

insertParagraph(childIndex, text)

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

Paramètres

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

Renvois

Paragraph : nouveau paragraphe

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

insertTable(childIndex)

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

Paramètres

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

Renvois

Table : la nouvelle table

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

insertTable(childIndex, cells)

Crée et insère un Table contenant les cellules spécifiées, à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerl'index auquel insérer
cellsString[][]le contenu textuel des cellules du tableau à ajouter au nouveau tableau.

Renvois

Table : la nouvelle table

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

insertTable(childIndex, table)

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

Paramètres

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

Renvois

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

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

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

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

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

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

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

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

setBackgroundColor(color)

Définit la couleur d'arrière-plan.

Paramètres

NomTypeDescription
colorStringCouleur d'arrière-plan, au format CSS (par exemple, '#ffffff')

Renvois

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

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

setPaddingBottom(paddingBottom)

Définit la marge intérieure inférieure, en points.

Paramètres

NomTypeDescription
paddingBottomNumberMarge intérieure inférieure, en points

Renvois

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

setPaddingLeft(paddingLeft)

Définit la marge intérieure de gauche, en points.

Paramètres

NomTypeDescription
paddingLeftNumberla marge intérieure de gauche, en points ;

Renvois

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

setPaddingRight(paddingRight)

Définit la marge intérieure de droite, en points.

Paramètres

NomTypeDescription
paddingRightNumberMarge intérieure de droite, en points.

Renvois

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

setPaddingTop(paddingTop)

Définit la marge intérieure supérieure, en points.

Paramètres

NomTypeDescription
paddingTopNumberMarge intérieure supérieure, en points

Renvois

TableCell : é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 en tant que texte brut.

Remarque : Les contenus existants sont effacés.

Paramètres

NomTypeDescription
textStringle nouveau contenu textuel.

Renvois

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

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

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

setVerticalAlignment(alignment)

Définit l'alignement vertical.

Paramètres

NomTypeDescription
alignmentVerticalAlignmentl'alignement vertical ;

Renvois

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

setWidth(width)

Définit la largeur de la colonne contenant la cellule actuelle, en points.

Paramètres

NomTypeDescription
widthNumberla largeur de la colonne, en points ;

Renvois

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