Class FootnoteSection

Note de bas de pageSection

Élément représentant une section de notes de bas de page. Un FootnoteSection contient le texte correspondant à un Footnote. FootnoteSection peut contenir des éléments ListItem ou Paragraph. 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
appendParagraph(paragraph)	Paragraph	Ajoute le Paragraph donné.
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 dissociée de l'élément actuel.
editAsText()	Text	Récupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)	RangeElement	Recherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)	RangeElement	Recherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)	RangeElement	Recherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)	RangeElement	Recherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAttributes()	Object	Récupère les attributs de l'élément.
getChild(childIndex)	Element	Récupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)	Integer	Récupère l'index de l'élément enfant pour l'élément enfant spécifié.
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 le ElementType de l'élément.
insertParagraph(childIndex, paragraph)	Paragraph	Insère l'Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)	Paragraph	Crée et insère un nouvel élément Paragraph à 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.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
getFootnotes()	Footnote[]	Récupère tous les Footnotes contenus dans la section.
getLinkUrl()	String	Récupère l'URL du lien.
isAtDocumentEnd()	Boolean	Détermine si l'élément se trouve à la fin de Document.
setLinkUrl(url)	FootnoteSection	Définit l'URL du lien.

Documentation détaillée

appendParagraph(paragraph)

Ajoute le Paragraph donné.

Utilisez cette version de appendParagraph lorsque vous ajoutez une copie d'un Paragraph existant.

Paramètres

Nom	Type	Description
paragraph	Paragraph	Paragraphe à ajouter.

Renvois

Paragraph : paragraphe ajouté.

Autorisation

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

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

---

appendParagraph(text)

Crée et ajoute un Paragraph contenant le contenu textuel spécifié.

Paramètres

Nom	Type	Description
text	String	Contenu textuel du paragraphe.

Renvois

Paragraph : nouveau paragraphe.

Autorisation

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

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

---

clear()

Efface le contenu de l'élément.

Renvois

FootnoteSection : élément actuel.

---

copy()

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

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

Renvois

FootnoteSection : nouvelle copie.

Autorisation

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

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

---

editAsText()

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

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

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

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

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

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

Renvois

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

---

findElement(elementType)

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

Paramètres

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

Renvois

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

Autorisation

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

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

---

findElement(elementType, from)

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

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

// Define the search parameters.

let searchResult = null;

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

Paramètres

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

Renvois

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

Autorisation

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

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

---

findText(searchPattern)

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

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

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

Paramètres

Nom	Type	Description
searchPattern	String	le modèle à rechercher

Renvois

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

Autorisation

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

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

---

findText(searchPattern, from)

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

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

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

Paramètres

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

Renvois

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

Autorisation

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

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

---

getAttributes()

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

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

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

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

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

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

Renvois

Object : attributs de l'élément.

Autorisation

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

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

---

getChild(childIndex)

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

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

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

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

Paramètres

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

Renvois

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

Autorisation

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

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

---

getChildIndex(child)

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

Paramètres

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

Renvois

Integer : index enfant.

Autorisation

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

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

---

getNextSibling()

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

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

Renvois

Element : élément frère suivant.

Autorisation

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

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

---

getNumChildren()

Récupère le nombre d'enfants.

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

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

Renvois

Integer : nombre d'enfants.

Autorisation

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

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

---

getParagraphs()

Récupère tous les Paragraphs contenus dans la section (y compris ListItems).

Renvois

Paragraph[] : paragraphes de la section.

Autorisation

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

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

---

getParent()

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

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

Renvois

ContainerElement : élément parent.

Autorisation

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

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

---

getPreviousSibling()

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

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

Renvois

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

Autorisation

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

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

---

getText()

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

Renvois

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

Autorisation

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

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

---

getTextAlignment()

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

Renvois

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

Autorisation

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

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

---

getType()

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

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

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

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

const firstChild = body.getChild(0);

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

Renvois

ElementType : type d'élément.

Autorisation

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

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

---

insertParagraph(childIndex, paragraph)

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

Paramètres

Nom	Type	Description
childIndex	Integer	Index à insérer.
paragraph	Paragraph	Paragraphe à insérer.

Renvois

Paragraph : paragraphe inséré.

Autorisation

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

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

---

insertParagraph(childIndex, text)

Crée et insère un nouvel élément Paragraph à l'index spécifié, contenant le contenu textuel spécifié.

Paramètres

Nom	Type	Description
childIndex	Integer	Index à insérer.
text	String	Contenu textuel du paragraphe.

Renvois

Paragraph : nouveau paragraphe.

Autorisation

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

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

---

removeChild(child)

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

Paramètres

Nom	Type	Description
child	Element	Élément enfant à supprimer.

Renvois

FootnoteSection : élément actuel.

Autorisation

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

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

---

removeFromParent()

Supprime l'élément de son parent.

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

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

Renvois

FootnoteSection : élément supprimé.

Autorisation

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

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

---

replaceText(searchPattern, replacement)

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

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

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

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

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

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

Paramètres

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

Renvois

Element : élément actuel

Autorisation

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

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

---

setAttributes(attributes)

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

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

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

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

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

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

Paramètres

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

Renvois

FootnoteSection : élément actuel.

Autorisation

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

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

---

setText(text)

Définit le contenu en texte brut.

Remarque: Les contenus existants sont effacés.

Paramètres

Nom	Type	Description
text	String	Nouveaux contenus textuels.

Renvois

FootnoteSection : élément actuel.

Autorisation

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

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

---

setTextAlignment(textAlignment)

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

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

Paramètres

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

Renvois

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

Méthodes obsolètes

getFootnotes()

Obsolète. Cet élément ne peut pas contenir de Footnote.

Récupère tous les Footnotes contenus dans la section.

Renvois

Footnote[] : notes de bas de page de la section.

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()

Obsolète. Au lieu d'appliquer un lien à une section entière, appliquez-le à un élément de la section.

Récupère l'URL du lien.

Renvois

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

Autorisation

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

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

---

isAtDocumentEnd()

Obsolète. Cette méthode n'est pas fiable pour HeaderSection.

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

Renvois

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

Autorisation

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

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

---

setLinkUrl(url)

Obsolète. Au lieu d'appliquer un lien à une section entière, appliquez-le à un élément de la section.

Définit l'URL du lien.

Paramètres

Nom	Type	Description
url	String	l'URL du lien ;

Renvois

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