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

Class TableCell

Élément représentant une cellule de tableau. Un élément TableCell est toujours inclus 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 d'extension de Google Docs.

Méthodes

Méthode	Type renvoyé	Brève description
`appendHorizontalRule()`	`HorizontalRule`	Crée et ajoute un objet `HorizontalRule`.
`appendImage(image)`	`InlineImage`	Crée et ajoute un `InlineImage` à partir du blob d'image spécifié.
`appendImage(image)`	`InlineImage`	Ajoute le `InlineImage` donné.
`appendListItem(listItem)`	`ListItem`	Ajoute le `ListItem` donné.
`appendListItem(text)`	`ListItem`	Crée et ajoute un objet `ListItem`.
`appendParagraph(paragraph)`	`Paragraph`	Ajoute le `Paragraph` donné.
`appendParagraph(text)`	`Paragraph`	Crée et ajoute un objet `Paragraph`.
`appendTable()`	`Table`	Crée et ajoute un objet `Table`.
`appendTable(cells)`	`Table`	Ajoute un nouvel élément `Table` contenant les cellules spécifiées.
`appendTable(table)`	`Table`	Ajoute le `Table` donné.
`clear()`	`TableCell`	Efface le contenu de l'élément.
`copy()`	`TableCell`	Renvoie une copie profonde dissociée de l'élément actuel.
`editAsText()`	`Text`	Récupère une version `Text` de l'élément actuel, à des fins de modification.
`findElement(elementType)`	`RangeElement`	Recherche dans le contenu de l'élément un descendant du type spécifié.
`findElement(elementType, from)`	`RangeElement`	Recherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'`RangeElement` spécifié.
`findText(searchPattern)`	`RangeElement`	Recherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
`findText(searchPattern, from)`	`RangeElement`	Recherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
`getAttributes()`	`Object`	Récupère les attributs de l'élément.
`getBackgroundColor()`	`String`	Récupère la couleur d'arrière-plan.
`getChild(childIndex)`	`Element`	Récupère l'élément enfant à l'index enfant spécifié.
`getChildIndex(child)`	`Integer`	Récupère l'index de l'élément enfant pour l'élément enfant spécifié.
`getColSpan()`	`Integer`	Récupère la plage de colonnes, c'est-à-dire le nombre de colonnes de cellules de table que cette cellule couvre.
`getLinkUrl()`	`String`	Récupère l'URL du lien.
`getNextSibling()`	`Element`	Récupère l'élément frère suivant de l'élément.
`getNumChildren()`	`Integer`	Récupère le nombre d'enfants.
`getPaddingBottom()`	`Number`	Récupère la marge inférieure, en points.
`getPaddingLeft()`	`Number`	Récupère la marge intérieure gauche, en points.
`getPaddingRight()`	`Number`	Récupère la marge intérieure droite, en points.
`getPaddingTop()`	`Number`	Récupère la marge intérieure supérieure, en points.
`getParent()`	`ContainerElement`	Récupère l'élément parent de l'élément.
`getParentRow()`	`TableRow`	Récupère le `TableRow` contenant le `TableCell` actuel.
`getParentTable()`	`Table`	Récupère le `Table` contenant le `TableCell` actuel.
`getPreviousSibling()`	`Element`	Récupère l'élément frère précédent de l'élément.
`getRowSpan()`	`Integer`	Récupère la plage de lignes, qui correspond au nombre de lignes de cellules de table couvertes par cette cellule.
`getText()`	`String`	Récupère le contenu de l'élément sous forme de chaîne de texte.
`getTextAlignment()`	`TextAlignment`	Récupère l'alignement du texte.
`getType()`	`ElementType`	Récupère le `ElementType` de l'élément.
`getVerticalAlignment()`	`VerticalAlignment`	Récupère `VerticalAlignment`.
`getWidth()`	`Number`	Récupère la largeur de la colonne contenant la cellule, en points.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crée et insère un `HorizontalRule` à l'index spécifié.
`insertImage(childIndex, image)`	`InlineImage`	Crée et insère un `InlineImage` à partir du blob d'image spécifié, à l'index spécifié.
`insertImage(childIndex, image)`	`InlineImage`	Insère l'`InlineImage` donné à l'index spécifié.
`insertListItem(childIndex, listItem)`	`ListItem`	Insère l'`ListItem` donné à l'index spécifié.
`insertListItem(childIndex, text)`	`ListItem`	Crée et insère un `ListItem` à l'index spécifié.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insère l'`Paragraph` donné à l'index spécifié.
`insertParagraph(childIndex, text)`	`Paragraph`	Crée et insère un `Paragraph` à l'index spécifié.
`insertTable(childIndex)`	`Table`	Crée et insère un `Table` à l'index spécifié.
`insertTable(childIndex, cells)`	`Table`	Crée et insère un `Table` contenant les cellules spécifiées à l'index spécifié.
`insertTable(childIndex, table)`	`Table`	Insère l'`Table` donné à l'index spécifié.
`isAtDocumentEnd()`	`Boolean`	Détermine si l'élément se trouve à la fin de `Document`.
`merge()`	`TableCell`	Fusionne l'élément avec le frère précédent de même type.
`removeChild(child)`	`TableCell`	Supprime l'élément enfant spécifié.
`removeFromParent()`	`TableCell`	Supprime l'élément de son parent.
`replaceText(searchPattern, replacement)`	`Element`	Remplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
`setAttributes(attributes)`	`TableCell`	Définit les attributs de l'élément.
`setBackgroundColor(color)`	`TableCell`	Définit la couleur d'arrière-plan.
`setLinkUrl(url)`	`TableCell`	Définit l'URL du lien.
`setPaddingBottom(paddingBottom)`	`TableCell`	Définit la marge intérieure inférieure, en points.
`setPaddingLeft(paddingLeft)`	`TableCell`	Définit la marge intérieure gauche, en points.
`setPaddingRight(paddingRight)`	`TableCell`	Définit la marge intérieure droite, en points.
`setPaddingTop(paddingTop)`	`TableCell`	Définit la marge intérieure supérieure, en points.
`setText(text)`	`TableCell`	Définit le contenu en texte brut.
`setTextAlignment(textAlignment)`	`TableCell`	Définit l'alignement du texte.
`setVerticalAlignment(alignment)`	`TableCell`	Définit l'alignement vertical.
`setWidth(width)`	`TableCell`	Définit la largeur de la colonne contenant la cellule active, en points.

Documentation détaillée

`appendHorizontalRule()`

Crée et ajoute un objet HorizontalRule.

HorizontalRule sera contenu dans un nouveau Paragraph.

Renvois

HorizontalRule : nouvelle règle horizontale

Autorisation

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

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

`appendImage(image)`

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

InlineImage sera contenu dans un nouveau Paragraph.

Paramètres

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

Renvois

InlineImage : nouvelle image

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

`appendImage(image)`

Ajoute le InlineImage donné.

InlineImage sera contenu dans un nouveau Paragraph.

Paramètres

Nom	Type	Description
`image`	`InlineImage`	les données d'image ;

Renvois

InlineImage : image ajoutée

Autorisation

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

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

`appendListItem(listItem)`

Ajoute le ListItem donné.

Paramètres

Nom	Type	Description
`listItem`	`ListItem`	l'é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 champs d'application suivants:

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

`appendListItem(text)`

Crée et ajoute un objet ListItem.

Paramètres

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

Renvois

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

`appendParagraph(paragraph)`

Ajoute le Paragraph donné.

Paramètres

Nom	Type	Description
`paragraph`	`Paragraph`	le paragraphe à ajouter

Renvois

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

`appendParagraph(text)`

Crée et ajoute un objet Paragraph.

Paramètres

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

Renvois

Paragraph : nouveau paragraphe

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

`appendTable()`

Crée et ajoute un objet Table.

Renvois

Table : nouvelle table

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

`appendTable(cells)`

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

Paramètres

Nom	Type	Description
`cells`	`String[][]`	le contenu textuel des cellules de la table à ajouter à la nouvelle table

Renvois

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

`appendTable(table)`

Ajoute le Table donné.

Paramètres

Nom	Type	Description
`table`	`Table`	la table à ajouter

Renvois

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

`clear()`

Efface le contenu de l'élément.

Renvois

TableCell : élément actuel.

`copy()`

Renvoie une copie profonde dissociée de l'élément actuel.

Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.

Renvois

TableCell : nouvelle copie.

Autorisation

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

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

`editAsText()`

Récupère une version Text de l'élément actuel, à des fins de modification.

Utilisez editAsText pour manipuler le contenu des éléments en tant que texte enrichi. Le mode editAsText ignore les éléments non textuels (tels que InlineImage et HorizontalRule).

Les éléments enfants entièrement contenus dans une plage de texte supprimée sont supprimés de l'élément.

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

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

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

Renvois

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

`findElement(elementType)`

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

Paramètres

Nom	Type	Description
`elementType`	`ElementType`	Type d'élément à rechercher.

Renvois

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

Autorisation

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

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

`findElement(elementType, from)`

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

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Paramètres

Nom	Type	Description
`elementType`	`ElementType`	Type d'élément à rechercher.
`from`	`RangeElement`	Résultat de recherche à partir duquel effectuer une recherche.

Renvois

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

Autorisation

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

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

`findText(searchPattern)`

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

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

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

Paramètres

Nom	Type	Description
`searchPattern`	`String`	le modèle à rechercher

Renvois

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

Autorisation

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

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

`findText(searchPattern, from)`

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

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

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

Paramètres

Nom	Type	Description
`searchPattern`	`String`	le modèle à rechercher
`from`	`RangeElement`	le résultat de recherche à partir duquel effectuer la recherche

Renvois

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

Autorisation

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

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

`getAttributes()`

Récupère les attributs de l'élément.

Le résultat est un objet contenant une propriété pour chaque attribut d'élément valide, où chaque nom de propriété correspond à un élément de l'énumération DocumentApp.Attribute.

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

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Renvois

Object : attributs de l'élément.

Autorisation

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

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

`getBackgroundColor()`

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

Renvois

String : 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 champs d'application suivants:

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

`getChild(childIndex)`

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

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

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	Index de l'élément enfant à récupérer.

Renvois

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

Autorisation

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

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

`getChildIndex(child)`

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

Paramètres

Nom	Type	Description
`child`	`Element`	Élément enfant pour lequel récupérer l'index.

Renvois

Integer : index enfant.

Autorisation

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

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

`getColSpan()`

Récupère la plage de colonnes, c'est-à-dire le nombre de colonnes de cellules de table que cette cellule couvre. Les cellules non fusionnées ont une largeur de colonne de 1.

Renvois

Integer : étendue de la colonne 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 champs d'application suivants:

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

`getLinkUrl()`

Récupère l'URL du lien.

Renvois

String : URL du lien, ou valeur nulle si l'élément contient plusieurs valeurs pour cet attribut

Autorisation

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

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

`getNextSibling()`

Récupère l'élément frère suivant de l'élément.

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

Renvois

Element : élément frère suivant.

Autorisation

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

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

`getNumChildren()`

Récupère le nombre d'enfants.

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

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Renvois

Integer : nombre d'enfants.

Autorisation

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

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

`getPaddingBottom()`

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

Renvois

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

`getPaddingLeft()`

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

Renvois

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

`getPaddingRight()`

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

Renvois

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

`getPaddingTop()`

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

Renvois

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

`getParent()`

Récupère l'élément parent de l'élément.

L'élément parent contient l'élément actuel.

Renvois

ContainerElement : élément parent.

Autorisation

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

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

`getParentRow()`

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

Renvois

TableRow : ligne du tableau contenant la cellule active

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

`getParentTable()`

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

Renvois

Table : table contenant la cellule actuelle

Autorisation

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

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

`getPreviousSibling()`

Récupère l'élément frère précédent de l'élément.

Le frère précédent a le même parent et précède l'élément actuel.

Renvois

Element : élément frère précédent.

Autorisation

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

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

`getRowSpan()`

Récupère la plage de lignes, qui correspond au nombre de lignes de cellules de table couvertes par cette cellule. Les cellules non fusionnées ont une plage de lignes de 1.

Renvois

Integer : étendue des lignes 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 champs d'application suivants:

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

`getText()`

Récupère le contenu de l'élément sous forme de chaîne de texte.

Renvois

String : contenu de l'élément sous forme de chaîne de texte

Autorisation

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

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

`getTextAlignment()`

Récupère l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT et DocumentApp.TextAlignment.SUPERSCRIPT.

Renvois

TextAlignment : type d'alignement du texte, ou null si le texte contient plusieurs types d'alignement du texte ou si l'alignement du texte n'a jamais été défini

Autorisation

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

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

`getType()`

Récupère le ElementType de l'élément.

Utilisez getType() pour déterminer le type exact d'un élément donné.

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

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Renvois

ElementType : type d'élément.

Autorisation

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

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

`getVerticalAlignment()`

Récupère VerticalAlignment.

Renvois

VerticalAlignment : alignement vertical

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

`getWidth()`

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

Renvois

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

`insertHorizontalRule(childIndex)`

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

La ligne horizontale sera contenue dans un nouvel élément Paragraph.

Paramètres

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

Renvois

HorizontalRule : nouvelle règle horizontale

Autorisation

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

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

`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 nouvel élément Paragraph.

Paramètres

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

Renvois

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

`insertImage(childIndex, image)`

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

L'image sera contenue dans un nouvel élément Paragraph.

Paramètres

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

Renvois

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

`insertListItem(childIndex, listItem)`

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`listItem`	`ListItem`	l'é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 champs d'application 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

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

Renvois

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

`insertParagraph(childIndex, paragraph)`

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`paragraph`	`Paragraph`	le 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 champs d'application 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

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

Renvois

Paragraph : nouveau paragraphe

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

`insertTable(childIndex)`

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

Paramètres

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

Renvois

Table : nouvelle table

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

`insertTable(childIndex, cells)`

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'index à insérer
`cells`	`String[][]`	le contenu textuel des cellules de la table à ajouter à la nouvelle table

Renvois

Table : nouvelle table

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

`insertTable(childIndex, table)`

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

Paramètres

Nom	Type	Description
`childIndex`	`Integer`	l'indice auquel insérer l'élément ;
`table`	`Table`	le tableau à insérer ;

Renvois

Table : tableau inséré

Autorisation

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

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

`isAtDocumentEnd()`

Détermine si l'élément se trouve à la fin de Document.

Renvois

Boolean : indique si l'élément se trouve à la fin de l'onglet.

Autorisation

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

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

`merge()`

Fusionne l'élément avec le frère précédent de même type.

Seuls les éléments du même ElementType peuvent être fusionnés. Tous les éléments enfants contenus dans l'élément actuel sont déplacés vers l'élément frère précédent.

L'élément actuel est supprimé du document.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Renvois

TableCell : élément fusionné.

Autorisation

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

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

`removeChild(child)`

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

Paramètres

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

Renvois

TableCell : élément actuel

Autorisation

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

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

`removeFromParent()`

Supprime l'élément de son parent.

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

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

Renvois

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

`replaceText(searchPattern, replacement)`

Remplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.

Le format de recherche est transmis sous la forme d'une chaîne, et non d'un objet d'expression régulière JavaScript. Vous devez donc échapper toutes les barres obliques inverses dans le format.

Ces méthodes utilisent la bibliothèque d'expressions régulières RE2 de Google, ce qui limite la syntaxe compatible.

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

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Paramètres

Nom	Type	Description
`searchPattern`	`String`	le motif d'expression régulière à rechercher
`replacement`	`String`	le texte à utiliser en remplacement ;

Renvois

Element : élément actuel

Autorisation

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

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

`setAttributes(attributes)`

Définit les attributs de l'élément.

Le paramètre d'attributs spécifié doit être un objet dans lequel chaque nom de propriété est un élément de l'énumération DocumentApp.Attribute et chaque valeur de propriété est la nouvelle valeur à appliquer.

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

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

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

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

Paramètres

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

Renvois

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

`setBackgroundColor(color)`

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

Paramètres

Nom	Type	Description
`color`	`String`	la couleur d'arrière-plan, formatée en notation 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 champs d'application suivants:

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

`setLinkUrl(url)`

Définit l'URL du lien.

Paramètres

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

Renvois

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

`setPaddingBottom(paddingBottom)`

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

Paramètres

Nom	Type	Description
`paddingBottom`	`Number`	Marge 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 champs d'application suivants:

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

`setPaddingLeft(paddingLeft)`

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

Paramètres

Nom	Type	Description
`paddingLeft`	`Number`	Marge intérieure 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 champs d'application suivants:

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

`setPaddingRight(paddingRight)`

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

Paramètres

Nom	Type	Description
`paddingRight`	`Number`	Marge intérieure 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 champs d'application 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

Nom	Type	Description
`paddingTop`	`Number`	le rembourrage supérieur, en points

Renvois

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

Remarque: Les contenus existants sont effacés.

Paramètres

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

Renvois

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

`setTextAlignment(textAlignment)`

Définit l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT et DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Paramètres

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

Renvois

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

`setVerticalAlignment(alignment)`

Définit l'alignement vertical.

Paramètres

Nom	Type	Description
`alignment`	`VerticalAlignment`	l'alignement vertical ;

Renvois

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

`setWidth(width)`

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

Paramètres

Nom	Type	Description
`width`	`Number`	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 champs d'application suivants:

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