Élément représentant une section de notes de bas de page. Un élément FootnoteSection
contient le texte correspondant à un élément Footnote
. FootnoteSection
peut contenir des éléments ListItem
ou Paragraph
. 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 |
---|---|---|
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph contenant le contenu textuel spécifié. |
clear() | FootnoteSection | Efface le contenu de l'élément. |
copy() | FootnoteSection | 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. |
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é. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParagraphs() | Paragraph[] | Récupère tous les Paragraphs contenus dans la section (y compris ListItems ). |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
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. |
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é, contenant le contenu textuel spécifié. |
removeChild(child) | FootnoteSection | Supprime l'élément enfant spécifié. |
removeFromParent() | FootnoteSection | 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) | FootnoteSection | Définit les attributs de l'élément. |
setText(text) | FootnoteSection | Définit le contenu en texte brut. |
setTextAlignment(textAlignment) | FootnoteSection | Définit l'alignement du texte. |
Documentation détaillée
appendParagraph(paragraph)
Ajoute l'élément Paragraph
spécifié.
Utilisez cette version de appendParagraph
lorsque vous ajoutez une copie d'un Paragraph
existant.
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
contenant le contenu textuel spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | au contenu du texte du paragraphe |
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
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
FootnoteSection
: 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
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
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
getParagraphs()
Récupère tous les Paragraphs
contenus dans la section (y compris ListItems
).
Renvois
Paragraph[]
: paragraphes de section
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
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
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
insertParagraph(childIndex, paragraph)
Insère le Paragraph
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel insérer |
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é, contenant le contenu textuel spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel insérer |
text | String | au contenu du texte du paragraphe |
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
removeChild(child)
Supprime l'élément enfant spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
child | Element | l'élément enfant à supprimer |
Renvois
FootnoteSection
: é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
FootnoteSection
: é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
FootnoteSection
: é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
FootnoteSection
: é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
FootnoteSection
: é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