Class FooterSection

FooterSection

Élément représentant une section de pied de page. Un élément Document contient généralement au maximum un élément FooterSection. FooterSection peut contenir ListItem, Paragraph et Table. Pour en savoir plus sur la structure des documents, consultez le guide sur l'extension de Google Docs.

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un nouveau HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage donné.
appendListItem(listItem)ListItemAjoute l'élément ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouveau ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouveau Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un nouveau Table.
appendTable(cells)TableAjoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute l'élément Table donné.
clear()FooterSectionEfface le contenu de l'élément.
copy()FooterSectionRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de l'élément enfant spécifié.
getImages()InlineImage[]Récupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]Récupère tous les ListItems contenus dans la section.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]Récupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElementRécupère l'élément parent de l'élément.
getTables()Table[]Récupère tous les Tables contenus dans la section.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignmentRécupère l'alignement du texte.
getType()ElementTypeRécupère l'ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un nouveau HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un objet InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un nouveau ListItem à l'index spécifié, contenant les du texte.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouveau Paragraph à l'index spécifié, contenant les du texte.
insertTable(childIndex)TableCrée et insère un nouveau Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un nouveau Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)FooterSectionSupprime l'élément enfant spécifié.
removeFromParent()FooterSectionSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
setAttributes(attributes)FooterSectionDéfinit les attributs de l'élément.
setText(text)FooterSectionDéfinit le contenu en texte brut.
setTextAlignment(textAlignment)FooterSectionDéfinit l'alignement du texte.

Documentation détaillée

appendHorizontalRule()

Crée et ajoute un nouveau HorizontalRule.

Le HorizontalRule sera contenu dans un nouveau Paragraph.

Renvois

HorizontalRule : nouvelle règle horizontale.

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

appendImage(image)

Crée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.

L'image sera contenue dans un nouveau Paragraph.

Paramètres

NomTypeDescription
imageBlobSourceDonnées de l'image.

Renvois

InlineImage : image ajoutée.

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

appendImage(image)

Ajoute l'élément InlineImage donné.

Le InlineImage sera contenu dans un nouveau Paragraph.

Utilisez cette version de appendImage lorsque vous ajoutez une copie d'un InlineImage existant.

Paramètres

NomTypeDescription
imageInlineImageDonnées de l'image.

Renvois

InlineImage : image ajoutée.

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

appendListItem(listItem)

Ajoute l'élément ListItem donné.

Utilisez cette version de appendListItem lorsque vous ajoutez une copie d'un ListItem existant.

Paramètres

NomTypeDescription
listItemListItemÉlément de liste à ajouter.

Renvois

ListItem : élément de liste ajouté.

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

appendListItem(text)

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

Les éléments de liste consécutifs sont ajoutés dans la même liste.

Paramètres

NomTypeDescription
textStringContenu du texte de l'élément de liste.

Renvois

ListItem : nouvel élément de la liste.

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

appendParagraph(paragraph)

Ajoute l'élément Paragraph donné.

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

Paramètres

NomTypeDescription
paragraphParagraphParagraphe à ajouter.

Renvois

Paragraph : paragraphe ajouté.

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

appendParagraph(text)

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

Paramètres

NomTypeDescription
textStringContenu du texte du paragraphe.

Renvois

Paragraph : nouveau paragraphe.

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

appendTable()

Crée et ajoute un nouveau Table.

Cette méthode ajoute également un paragraphe vide après le tableau, puisque les documents Google Docs ne peut pas se terminer par un tableau.

Renvois

Table : nouvelle table.

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

appendTable(cells)

Ajoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée.

Cette méthode ajoute également un paragraphe vide après le tableau, puisque les documents Google Docs ne peut pas se terminer par un tableau.

Paramètres

NomTypeDescription
cellsString[][]Contenu textuel des cellules du tableau à ajouter au nouveau tableau.

Renvois

Table : table ajoutée.

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

appendTable(table)

Ajoute l'élément Table donné.

Utilisez cette version de appendTable lorsque vous ajoutez une copie d'un Table existant. Cette méthode ajoute également un paragraphe vide après le tableau, puisque les documents Google Docs ne peut pas se terminer par un tableau.

Paramètres

NomTypeDescription
tableTableTableau à ajouter.

Renvois

Table : table ajoutée.

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

clear()

Efface le contenu de l'élément.

Renvois

FooterSection : élément actuel.


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

FooterSection : 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

editAsText()

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

Utilisez editAsText pour manipuler le contenu des éléments en 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 retirés de l'élément.

var 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


findElement(elementType)

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

Paramètres

NomTypeDescription
elementTypeElementTypeType 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 correspondant à 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é.

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

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher.
fromRangeElementRésultat de recherche à partir duquel effectuer la 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 correspondant à 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é dans le contenu de l'élément à l'aide d'expressions régulières.

Un sous-ensemble des fonctionnalités des expressions régulières JavaScript ne sont pas entièrement compatibles : des groupes de capture et des modificateurs de mode.

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

Paramètres

NomTypeDescription
searchPatternStringle modèle à rechercher

Renvois

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

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

findText(searchPattern, from)

Recherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.

Un sous-ensemble des fonctionnalités des expressions régulières JavaScript ne sont pas entièrement compatibles : des groupes de capture et des modificateurs de mode.

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

Paramètres

NomTypeDescription
searchPatternStringle modèle à rechercher
fromRangeElementle résultat de recherche à partir duquel effectuer la recherche

Renvois

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

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

getChild(childIndex)

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

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

// Obtain the first element in the tab.
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

NomTypeDescription
childIndexIntegerIndex de l'élément enfant à récupérer.

Renvois

Element : élément enfant au niveau de l'index spécifié.

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

getChildIndex(child)

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

Paramètres

NomTypeDescription
childElementÉ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 correspondant à un ou plusieurs des champs d'application suivants:

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

getImages()

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

Renvois

InlineImage[] : images de la section.

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

getListItems()

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

Renvois

ListItem[] : éléments de la liste de sections.

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

getNumChildren()

Récupère le nombre d'enfants.

var 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 correspondant à 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 correspondant à 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

getTables()

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

Renvois

Table[] : tables de sections.

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

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 correspondant à 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 de 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 correspondant à 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

insertHorizontalRule(childIndex)

Crée et insère un nouveau HorizontalRule à l'index spécifié.

Le HorizontalRule sera contenu dans un nouveau Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément.

Renvois

HorizontalRule : nouvelle règle horizontale.

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

insertImage(childIndex, image)

Crée et insère un objet InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément.
imageBlobSourceDonnées de l'image.

Renvois

InlineImage : image intégrée insérée.

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

insertImage(childIndex, image)

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

L'image sera contenue dans un nouveau Paragraph.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel insérer l'élément.
imageInlineImageImage à insérer.

Renvois

InlineImage : image intégrée insérée.

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

insertListItem(childIndex, listItem)

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

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.
listItemListItemÉlément de liste à insérer.

Renvois

ListItem : élément de liste inséré.

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

insertListItem(childIndex, text)

Crée et insère un nouveau ListItem à l'index spécifié, contenant les du texte.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.
textStringContenu du texte de l'élément de liste.

Renvois

ListItem : nouvel élément de la liste.

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

insertParagraph(childIndex, paragraph)

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

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.
paragraphParagraphParagraphe à insérer.

Renvois

Paragraph : paragraphe inséré.

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

insertParagraph(childIndex, text)

Crée et insère un nouveau Paragraph à l'index spécifié, contenant les du texte.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.
textStringContenu du texte du paragraphe.

Renvois

Paragraph : nouveau paragraphe.

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

insertTable(childIndex)

Crée et insère un nouveau Table à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.

Renvois

Table : nouvelle table.

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

insertTable(childIndex, cells)

Crée et insère un nouveau Table contenant les cellules spécifiées, à l'index spécifié.

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.
cellsString[][]Contenu textuel des cellules du tableau à ajouter au nouveau tableau.

Renvois

Table : nouvelle table.

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

insertTable(childIndex, table)

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

Paramètres

NomTypeDescription
childIndexIntegerIndex auquel l'insertion doit être effectuée.
tableTableTableau à insérer.

Renvois

Table : table insérée.

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

removeChild(child)

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

Paramètres

NomTypeDescription
childElementÉlément enfant à supprimer.

Renvois

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

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

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

replaceText(searchPattern, replacement)

Remplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .

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 toutes les barres obliques inverses dans le modèle.

Cette méthode utilise la norme RE2 standard de Google bibliothèque d'expressions, ce qui limite la syntaxe compatible.

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

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

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

Paramètres

NomTypeDescription
searchPatternStringle modèle d'expression régulière à rechercher
replacementStringTexte à utiliser comme remplacement

Renvois

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

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

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

setText(text)

Définit le contenu en texte brut.

Remarque: Les contenus existants sont effacés.

Paramètres

NomTypeDescription
textStringContenu du nouveau texte.

Renvois

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

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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Paramètres

NomTypeDescription
textAlignmentTextAlignmentle type d'alignement de texte à appliquer

Renvois

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

Méthodes obsolètes