Class FootnoteSection

Ajoute le Paragraph donné.

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

Paramètres

Renvois

Paragraph : paragraphe ajouté.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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

Paramètres

Renvois

Paragraph : nouveau paragraphe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Efface le contenu de l'élément.

Renvois

FootnoteSection : élément actuel.

Renvoie une copie détachée et complète 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 : la nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Obtient une version Text de l'élément actuel, pour la 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 texte de l'élément actuel

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

Paramètres

Renvois

RangeElement|null : 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 scopes suivants :

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

Recherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le 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

Renvois

RangeElement|null : 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 scopes suivants :

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

Recherche le contenu de l'élément correspondant au modèle 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 pris en charge, comme les groupes de capture et les modificateurs de mode.

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

Paramètres

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Recherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.

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

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

Paramètres

Renvois

RangeElement|null : 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 avec un ou plusieurs des scopes suivants :

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

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 scopes suivants :

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

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

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 scopes suivants :

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

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

Paramètres

Renvois

Integer : index de l'enfant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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

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

Renvois

Element|null : élément frère suivant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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 scopes suivants :

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

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

Renvois

Paragraph[]|null : paragraphes de la section.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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

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

Renvois

ContainerElement|null : élément parent.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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|null : élément frère précédent.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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 scopes suivants :

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

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|null : type d'alignement du texte ou null si le texte contient plusieurs types d'alignement 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 scopes suivants :

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

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 scopes suivants :

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

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

Paramètres

Renvois

Paragraph : le paragraphe inséré.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Crée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.

Paramètres

Renvois

Paragraph : nouveau paragraphe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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

Paramètres

Renvois

FootnoteSection : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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|null : élément supprimé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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 sous forme de chaîne, et non d'objet d'expression régulière JavaScript. Pour cette raison, vous devrez échapper toutes les barres obliques inverses du 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 de manière indépendante 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

Renvois

Element : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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

Renvois

FootnoteSection : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Définit le contenu en tant que texte brut.

Remarque : Les contenus existants sont effacés.

Paramètres

Renvois

FootnoteSection : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

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

Renvois

FootnoteSection : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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