Élément représentant une cellule de 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 d'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 du blob d'image spécifié. |
appendImage(image) | InlineImage | Ajoute le InlineImage indiqué. |
appendListItem(listItem) | ListItem | Ajoute le ListItem indiqué. |
appendListItem(text) | ListItem | Crée et ajoute un ListItem . |
appendParagraph(paragraph) | Paragraph | Ajoute le Paragraph indiqué. |
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 le Table indiqué. |
clear() | TableCell | Efface le contenu de l'élément. |
copy() | TableCell | Renvoie une copie dissociée de l'élément actif. |
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é, en commençant par le RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières. |
findText(searchPattern, from) | RangeElement | Recherche dans le contenu de l'élément le format de texte spécifié, à 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 de l'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 spécifié. |
getColSpan() | Integer | Récupère le délai de colonne, c'est-à-dire le nombre de colonnes de cellules de tableau 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 appropriée, en points. |
getPaddingTop() | Number | Récupère la marge supérieure, en points. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getParentRow() | TableRow | Récupère les TableRow contenant le TableCell actuel. |
getParentTable() | Table | Récupère les 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 l'intervalle de lignes, qui correspond au nombre de lignes de cellules de ce tableau. |
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'élément ElementType . |
getVerticalAlignment() | VerticalAlignment | Récupère les 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 objet HorizontalRule à l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob de l'image spécifié, au niveau de 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 objet ListItem à 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 objet Paragraph à l'index spécifié. |
insertTable(childIndex) | Table | Crée et insère un objet Table à l'index spécifié. |
insertTable(childIndex, cells) | Table | Crée et insère un nouveau 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 la fratrie précédente 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 inférieure, en points. |
setPaddingLeft(paddingLeft) | TableCell | Définit la marge intérieure gauche, en points. |
setPaddingRight(paddingTop) | TableCell | Définit la marge intérieure droite, en points. |
setPaddingTop(paddingTop) | TableCell | Définit la marge 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 actuelle, en points. |
Documentation détaillée
appendHorizontalRule()
Crée et ajoute un HorizontalRule
.
Le HorizontalRule
sera contenu dans un nouveau Paragraph
.
Aller-retour
HorizontalRule
: nouvelle règle horizontale
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Crée et ajoute un InlineImage
à partir du 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 |
Aller-retour
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
indiqué.
Le InlineImage
sera contenu dans un nouveau Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
image | InlineImage | les données d'image |
Aller-retour
InlineImage
: image ajoutée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
Ajoute le ListItem
indiqué.
Paramètres
Nom | Type | Description |
---|---|---|
listItem | ListItem | Élément de liste à ajouter |
Aller-retour
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 ListItem
.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | le contenu textuel |
Aller-retour
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
indiqué.
Paramètres
Nom | Type | Description |
---|---|---|
paragraph | Paragraph | le paragraphe à ajouter |
Aller-retour
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 Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | le contenu textuel |
Aller-retour
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 Table
.
Aller-retour
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 nouveau Table
contenant les cellules spécifiées.
Paramètres
Nom | Type | Description |
---|---|---|
cells | String[][] | Le texte des cellules du tableau à ajouter au nouveau tableau |
Aller-retour
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
indiqué.
Paramètres
Nom | Type | Description |
---|---|---|
table | Table | Table à ajouter |
Aller-retour
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()
copy()
Renvoie une copie dissociée de l'élément actif.
Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.
Aller-retour
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 contenus entièrement dans une plage de texte supprimée sont retirés de l'élément.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Aller-retour
Text
: version textuelle de l'élément actuel
findElement(elementType)
Recherche dans le contenu de l'élément un descendant du type spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
elementType | ElementType | Type d'élément à rechercher |
Aller-retour
RangeElement
: résultat de recherche indiquant la position de l'élément de recherche
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Recherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement
spécifié.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Paramètres
Nom | Type | Description |
---|---|---|
elementType | ElementType | Type d'élément à rechercher |
from | RangeElement | le résultat de recherche à partir duquel |
Aller-retour
RangeElement
: résultat de recherche indiquant la position suivante de l'élément de recherche
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Recherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
Un sous-ensemble de fonctionnalités d'expression régulière JavaScript n'est pas entièrement compatible, comme les groupes de capture et les modificateurs de mode.
Le modèle d'expression régulière fourni est mis en correspondance indépendamment avec chaque bloc de texte contenu dans l'élément actuel.
Paramètres
Nom | Type | Description |
---|---|---|
searchPattern | String | le modèle à rechercher |
Aller-retour
RangeElement
: résultat de recherche indiquant la position du texte de recherche ou valeur null en l'absence de correspondance.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Recherche dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.
Un sous-ensemble de fonctionnalités d'expression régulière JavaScript n'est pas entièrement compatible, comme les groupes de capture et les modificateurs de mode.
Le modèle d'expression régulière fourni est mis en correspondance indépendamment avec chaque bloc de texte contenu dans l'élément actuel.
Paramètres
Nom | Type | Description |
---|---|---|
searchPattern | String | le modèle à rechercher |
from | RangeElement | le résultat de recherche à partir duquel |
Aller-retour
RangeElement
: résultat de recherche indiquant la position suivante du texte de recherche ou valeur null en l'absence de correspondance.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Récupère les attributs de l'élément.
Il en résulte un objet contenant une propriété pour chaque attribut d'élément valide, où chaque nom de propriété correspond à un élément de l'énumération DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Aller-retour
Object
: attributs de l'élément
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBackgroundColor()
Récupère la couleur de l'arrière-plan.
Aller-retour
String
: couleur d'arrière-plan, au format CSS (par exemple, '#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é.
// 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 | index de l'élément enfant à récupérer |
Aller-retour
Element
: élément enfant à l'index spécifié
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Récupère l'index de l'élément enfant spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
child | Element | Élément enfant pour lequel récupérer l'index |
Aller-retour
Integer
: index enfant
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getColSpan()
Récupère le délai de colonne, c'est-à-dire le nombre de colonnes de cellules de tableau que cette cellule couvre. L'intervalle de cellules des cellules non fusionnées est de 1.
Aller-retour
Integer
: délai de colonne ou zéro pour une cellule fusionnée par une autre.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Récupère l'URL du lien.
Aller-retour
String
: URL du lien, ou valeur "null" si l'élément contient plusieurs valeurs pour cet attribut.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Récupère l'élément frère suivant de l'élément.
La fratrie suivante a le même parent et suit l'élément actuel.
Aller-retour
Element
: élément frère suivant.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Récupère le nombre d'enfants.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Aller-retour
Integer
: nombre d'enfants
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPaddingBottom()
Récupère la marge inférieure, en points.
Aller-retour
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.
Aller-retour
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 appropriée, en points.
Aller-retour
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 supérieure, en points.
Aller-retour
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.
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
getParentRow()
Récupère les TableRow
contenant le TableCell
actuel.
Aller-retour
TableRow
: ligne de tableau 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
getParentTable()
Récupère les Table
contenant le TableCell
actuel.
Aller-retour
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 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
getRowSpan()
Récupère l'intervalle de lignes, qui correspond au nombre de lignes de cellules de ce tableau. L'étendue de la ligne des cellules non fusionnées est de 1.
Aller-retour
Integer
: délai de ligne ou zéro pour une cellule fusionnée par une autre.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Récupère le contenu de l'élément sous forme de chaîne de texte.
Aller-retour
String
: contenu de l'élément sous forme de chaîne de texte
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Récupère l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
et DocumentApp.TextAlignment.SUPERSCRIPT
.
Aller-retour
TextAlignment
: type d'alignement du texte, ou null
si le texte contient plusieurs types d'alignement de texte ou si l'alignement n'a jamais été défini.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Récupère l'élément ElementType
.
Utilisez getType()
pour déterminer le type exact d'un élément donné.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Aller-retour
ElementType
: type d'élément.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getVerticalAlignment()
Récupère les VerticalAlignment
.
Aller-retour
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.
Aller-retour
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 objet HorizontalRule
à l'index spécifié.
La règle horizontale sera contenue dans une nouvelle Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
Aller-retour
HorizontalRule
: nouvelle règle horizontale
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Crée et insère un InlineImage
à partir de l'objet blob de l'image spécifié, au niveau de l'index spécifié.
L'image sera stockée dans un nouveau fichier Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
image | BlobSource | les données d'image |
Aller-retour
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 le InlineImage
donné à l'index spécifié.
L'image sera stockée dans un nouveau fichier Paragraph
.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
image | InlineImage | Image à insérer |
Aller-retour
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 le ListItem
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
listItem | ListItem | Élément de liste à insérer |
Aller-retour
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 objet ListItem
à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
text | String | le contenu textuel |
Aller-retour
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 le Paragraph
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
paragraph | Paragraph | le paragraphe à insérer |
Aller-retour
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 objet Paragraph
à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
text | String | le contenu textuel |
Aller-retour
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 objet Table
à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
Aller-retour
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 nouveau Table
contenant les cellules spécifiées, à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index dans lequel insérer |
cells | String[][] | Le texte des cellules du tableau à ajouter au nouveau tableau |
Aller-retour
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 le Table
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | index dans lequel insérer l'élément |
table | Table | Tableau à insérer |
Aller-retour
Table
: table 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
isAtDocumentEnd()
Détermine si l'élément se trouve à la fin de Document
.
Aller-retour
Boolean
: indique si l'élément se trouve à la fin du document.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Fusionne l'élément avec la fratrie précédente du même type.
Seuls les éléments du même ElementType
peuvent être fusionnés. Tous les éléments enfants contenus dans l'élément actuel sont déplacés vers l'élément frère précédent.
L'élément actuel est supprimé du document.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Aller-retour
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 |
Aller-retour
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.
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
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 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
Nom | Type | Description |
---|---|---|
searchPattern | String | le modèle d'expression régulière à rechercher |
replacement | String | Texte à utiliser comme texte de remplacement |
Aller-retour
Element
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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. |
Aller-retour
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 de l'arrière-plan.
Paramètres
Nom | Type | Description |
---|---|---|
color | String | La couleur d'arrière-plan, au format CSS (par exemple, '#ffffff' ) |
Aller-retour
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 | URL du lien |
Aller-retour
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 inférieure, en points.
Paramètres
Nom | Type | Description |
---|---|---|
paddingBottom | Number | la marge inférieure, en points |
Aller-retour
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 | la marge intérieure gauche, en points |
Aller-retour
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(paddingTop)
Définit la marge intérieure droite, en points.
Paramètres
Nom | Type | Description |
---|---|---|
paddingTop | Number | marge intérieure droite, en points |
Aller-retour
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 supérieure, en points.
Paramètres
Nom | Type | Description |
---|---|---|
paddingTop | Number | la marge supérieure, en points |
Aller-retour
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: Le contenu existant est effacé.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | le nouveau contenu textuel |
Aller-retour
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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Paramètres
Nom | Type | Description |
---|---|---|
textAlignment | TextAlignment | Type d'alignement du texte à appliquer. |
Aller-retour
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 |
Aller-retour
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 actuelle, en points.
Paramètres
Nom | Type | Description |
---|---|---|
width | Number | largeur de la colonne, en points |
Aller-retour
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