Class TableRow

Crée et ajoute un TableCell.

Aller-retour

TableCell : nouvelle cellule de la 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

Ajoute le TableCell indiqué contenant le texte spécifié.

Paramètres

Aller-retour

TableCell : élément de cellule du tableau 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

Ajoute le TableCell indiqué.

Paramètres

Aller-retour

TableCell : cellule ajoutée dans le tableau

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

Efface le contenu de l'élément.

Aller-retour

TableRow : élément actuel

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

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

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

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

Paramètres

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

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

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

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

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

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

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

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

Récupère TableCell au niveau de l'index de cellule spécifié.

Paramètres

Aller-retour

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

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

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

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

Paramètres

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

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

Récupère la hauteur minimale, en points.

Aller-retour

Number : hauteur minimale, 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

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

Récupère le nombre de cellules de la ligne.

Aller-retour

Integer : nombre de cellules

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

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

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

Récupère les Table contenant la ligne actuelle.

Aller-retour

Table : table contenant la ligne 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

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

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

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

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

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

Paramètres

Aller-retour

TableCell : nouvelle cellule de la 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

Insère le TableCell donné à l'index spécifié, contenant le texte donné.

Paramètres

Aller-retour

TableCell : cellule du tableau 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

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

Paramètres

Aller-retour

TableCell : cellule du tableau 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

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

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

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

Supprime le TableCell au niveau de l'index de cellule spécifié.

Paramètres

Aller-retour

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

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

Paramètres

Aller-retour

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

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

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

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

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

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

Aller-retour

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

Définit l'URL du lien.

Paramètres

Aller-retour

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

Définit la hauteur minimale, en points.

Paramètres

Aller-retour

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

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

Aller-retour

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