Class Footnote

Note de bas de page

Élément représentant une note de bas de page. Chaque Footnote est contenue dans une ListItem. ou Paragraph et dispose d'un élément FootnoteSection correspondant pour les notes de bas de page contenus. Le Footnote lui-même ne peut contenir aucun autre élément. Pour en savoir plus sur structure du document, consultez le guide Extension de Google Docs

Méthodes

MéthodeType renvoyéBrève description
copy()FootnoteRenvoie une copie complète et dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getFootnoteContents()FootnoteSectionRécupère le contenu de l'élément de note de bas de page.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère l'ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeFromParent()FootnoteSupprime l'élément de son parent.
setAttributes(attributes)FootnoteDéfinit les attributs de l'élément.

Documentation détaillée

copy()

Renvoie une copie complète et 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

Footnote : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 la propriété correspond à un élément de l'énumération DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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 correspondant à un ou plusieurs des champs d'application suivants:

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

getFootnoteContents()

Récupère le contenu de l'élément de note de bas de page.

Renvois

FootnoteSection : section des notes de bas de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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

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 correspondant à 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 est antérieur à 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

getType()

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

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

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

// Obtain the first element in the active tab's 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 correspondant à 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 de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

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

Renvois

Footnote : élément supprimé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 où chaque nom d'établissement est un élément dans l'énumération DocumentApp.Attribute, et chaque valeur de propriété correspond à la nouvelle valeur à appliquée.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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

NomTypeDescription
attributesObjectAttributs de l'élément.

Renvois

Footnote : élément actuel.

Autorisation

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

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