Élément représentant la cellule d'un tableau. Un TableCell
est toujours contenu dans un 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éthode | Type renvoyé | Brève description |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendListItem(listItem) | ListItem | Ajoute l'élément ListItem spécifié. |
appendListItem(text) | ListItem | Crée et ajoute un ListItem . |
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph . |
appendTable() | Table | Crée et ajoute un Table . |
appendTable(cells) | Table | Ajoute un nouveau Table contenant les cellules spécifiées. |
appendTable(table) | Table | Ajoute l'élément Table spécifié. |
clear() | TableCell | Efface le contenu de l'élément. |
copy() | TableCell | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle 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 au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getColSpan() | Integer | Récupère l'intervalle de colonne, qui correspond au nombre de colonnes de cellules du tableau que cette cellule s'étend. |
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 intérieure inférieure, en points. |
getPaddingLeft() | Number | Récupère la marge intérieure de gauche, en points. |
getPaddingRight() | Number | Récupère la marge intérieure appropriée, 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 l'TableRow contenant la TableCell actuelle. |
getParentTable() | Table | Récupère l'Table contenant la TableCell actuelle. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getRowSpan() | Integer | Récupère l'intervalle de lignes, qui correspond au nombre de lignes de cellules du tableau contenues dans 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 l'ElementType de l'élément. |
getVerticalAlignment() | VerticalAlignment | Récupère l'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 au niveau de l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertListItem(childIndex, listItem) | ListItem | Insère le ListItem donné à l'index spécifié. |
insertListItem(childIndex, text) | ListItem | Crée et insère un ListItem au niveau de l'index spécifié. |
insertParagraph(childIndex, paragraph) | Paragraph | Insère le Paragraph donné à l'index spécifié. |
insertParagraph(childIndex, text) | Paragraph | Crée et insère un Paragraph au niveau de l'index spécifié. |
insertTable(childIndex) | Table | Crée et insère un Table au niveau de 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 le 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 ou la sœur précédent du 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 de l'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 appropriée, 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 en points de la colonne contenant la cellule actuelle. |
Documentation détaillée
appendHorizontalRule()
Crée et ajoute un HorizontalRule
.
Le 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 associée à 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 de l'objet blob d'image spécifié.
Le 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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Ajoute l'élément InlineImage
spécifié.
Le 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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
Ajoute l'élément ListItem
spécifié.
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 associée à 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 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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Ajoute l'élément Paragraph
spécifié.
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 associée à 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 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 associée à 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 Table
.
Renvois
Table
: nouvelle table
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 nouveau Table
contenant les cellules spécifiées.
Paramètres
Nom | Type | Description |
---|---|---|
cells | String[][] | 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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Ajoute l'élément Table
spécifié.
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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Renvoie une copie profonde détaché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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Permet d'obtenir une version Text
de l'élément actuel, qui peut être modifié.
Utilisez editAsText
pour manipuler le contenu des éléments sous forme de 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.
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);
Renvois
Text
: version texte de l'élément actuel
findElement(elementType)
Recherche un descendant du type spécifié dans le contenu de l'élément.
Paramètres
Nom | Type | Description |
---|---|---|
elementType | ElementType | Le 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 associée à 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 du 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
Nom | Type | Description |
---|---|---|
elementType | ElementType | Le type d'élément à rechercher |
from | RangeElement | le résultat de la recherche à partir duquel |
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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément.
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 associée à 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 modèle 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 la recherche à partir duquel |
Renvois
RangeElement
: 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 associée à 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
.
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]); }
Renvois
Object
: attributs de l'élément.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 au format CSS (par exemple, '#ffffff'
)
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 au niveau de 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
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index de l'élément enfant à récupérer |
Renvois
Element
: élément enfant de l'index spécifié
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Récupère l'index de l'élément enfant spécifié.
Paramètres
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 associée à 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 l'intervalle de colonne, qui correspond au nombre de colonnes de cellules du tableau que cette cellule s'étend. Les cellules non fusionnées ont un intervalle de col de 1.
Renvois
Integer
: intervalle de colonne ou 0 pour une cellule fusionnée par une autre cellule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 "null" si l'élément contient plusieurs valeurs pour cet attribut.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Récupère le nombre d'enfants.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Renvois
Integer
: nombre d'enfants
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 intérieure 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 associée à 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 de gauche, en points.
Renvois
Number
: marge intérieure gauche, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 appropriée, en points.
Renvois
Number
: marge intérieure appropriée, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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 associée à 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 l'TableRow
contenant la TableCell
actuelle.
Renvois
TableRow
: ligne du tableau contenant la cellule actuellement sélectionnée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'Table
contenant la TableCell
actuelle.
Renvois
Table
: tableau contenant la cellule actuellement sélectionnée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 ou sœur 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 associée à 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 l'intervalle de lignes, qui correspond au nombre de lignes de cellules du tableau contenues dans cette cellule. Les cellules non fusionnées ont un intervalle de lignes 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 associée à 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 associée à 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'alignements 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'alignements ou si l'alignement du texte n'a jamais été défini
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Récupère l'ElementType
de l'élément.
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.'); }
Renvois
ElementType
: type d'élément.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'VerticalAlignment
.
Renvois
VerticalAlignment
: alignement vertical
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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
au niveau de l'index spécifié.
La règle horizontale sera contenue dans un nouveau Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel insérer l'élément |
Renvois
HorizontalRule
: nouvelle règle horizontale
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 de l'objet blob d'image spécifié, dans l'index spécifié.
L'image sera contenue dans un nouveau Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index 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 associée à 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 le InlineImage
donné à l'index spécifié.
L'image sera contenue dans un nouveau Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index 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 associée à 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 le ListItem
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index 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 associée à 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
au niveau de l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index 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 associée à 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 le Paragraph
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel insérer l'élément |
paragraph | Paragraph | paragraphe à insérer |
Renvois
Paragraph
: paragraphe inséré
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
au niveau de l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index 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 associée à 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
au niveau de l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel insérer l'élément |
Renvois
Table
: nouvelle table
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 auquel insérer |
cells | String[][] | le contenu textuel des cellules du tableau à ajouter au nouveau tableau |
Renvois
Table
: nouvelle table
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 le Table
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel insérer l'élément |
table | Table | le tableau à insérer |
Renvois
Table
: table insérée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 du document.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 ou la sœur précédent du même type.
Seuls les éléments d'un 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();
Renvois
TableCell
: élément fusionné
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Supprime l'élément de son parent.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Renvois
TableCell
: élément supprimé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 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 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.
var body = DocumentApp.getActiveDocument().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 modèle d'expression régulière pour rechercher |
replacement | String | le texte à utiliser comme remplacement |
Renvois
Element
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Définit les attributs de l'élément.
Le paramètre d'attributs spécifié doit être un objet dans lequel chaque nom de propriété est un élément de l'énumération DocumentApp.Attribute
, et chaque valeur de propriété correspond à la nouvelle valeur à appliquer.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Paramètres
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 associée à 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 de l'arrière-plan.
Paramètres
Nom | Type | Description |
---|---|---|
color | String | La couleur de l'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 associée à 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 | URL du lien |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 | la marge intérieure inférieure, en points |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 | la marge intérieure gauche, en points |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 appropriée, 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 associée à 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 | la marge intérieure supérieure, en points |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 | le nouveau contenu de texte |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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'alignements 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
Nom | Type | Description |
---|---|---|
textAlignment | TextAlignment | Le type d'alignement de texte à appliquer |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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 en points de la colonne contenant la cellule actuelle.
Paramètres
Nom | Type | Description |
---|---|---|
width | Number | la largeur de la colonne, en points |
Renvois
TableCell
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents