Class TableOfContents

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
TableDuContenu

Élément contenant une table des matières. Un TableOfContents peut contenir des éléments ListItem, Paragraph et Table, bien que le contenu d'un TableOfContents soit généralement généré automatiquement par Google Docs. Pour en savoir plus sur la structure des documents, consultez le guide d'extension de Google Docs.

Méthodes

MéthodeType renvoyéBrève description
clear()TableOfContentsEfface le contenu de l'élément.
copy()TableOfContentsRenvoie une copie dissociée de l'élément actif.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index de l'élément enfant spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
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.
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'élément ElementType.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeFromParent()TableOfContentsSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace 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)TableOfContentsDéfinit les attributs de l'élément.
setLinkUrl(url)TableOfContentsDéfinit l'URL du lien.
setTextAlignment(textAlignment)TableOfContentsDéfinit l'alignement du texte.

Documentation détaillée

clear()

Efface le contenu de l'élément.

Aller-retour

TableOfContents : élément actuel


copy()

Renvoie une copie dissociée de l'élément actif.

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

Aller-retour

TableOfContents : 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 contenus entièrement dans une plage de texte supprimée sont retiré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);

Aller-retour

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

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher

Aller-retour

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é, en commençant par le 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

NomTypeDescription
elementTypeElementTypeType d'élément à rechercher
fromRangeElementle résultat de recherche à partir duquel

Aller-retour

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 le format de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.

Un sous-ensemble de 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

NomTypeDescription
searchPatternStringle modèle à rechercher

Aller-retour

RangeElement : résultat de recherche indiquant la position du texte de recherche ou valeur 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 dans le contenu de l'élément le format de texte spécifié, à partir d'un résultat de recherche donné.

Un sous-ensemble de 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

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

Aller-retour

RangeElement : résultat de recherche indiquant la position suivante du texte de recherche ou valeur 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

getAttributes()

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

Il en résulte 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]);
}

Aller-retour

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é.

// 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

NomTypeDescription
childIndexIntegerindex de l'élément enfant à récupérer

Aller-retour

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 spécifié.

Paramètres

NomTypeDescription
childElementÉlément enfant pour lequel récupérer l'index

Aller-retour

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

getLinkUrl()

Récupère l'URL du lien.

Aller-retour

String : URL du lien, ou valeur"null"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

getNextSibling()

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

La fratrie suivante a le même parent et suit l'élément actuel.

Aller-retour

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.

// 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.");

Aller-retour

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

getParent()

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

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

Aller-retour

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 et la sœur précédents ont le même parent et précède l'élément actuel.

Aller-retour

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.

Aller-retour

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.

Aller-retour

TextAlignment : type d'alignement du texte, ou null si le texte contient plusieurs types d'alignement de texte ou si l'alignement 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 l'élément ElementType.

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.');
}

Aller-retour

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

isAtDocumentEnd()

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

Aller-retour

Boolean : indique si l'élément se trouve à la fin du document.

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.

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

Aller-retour

TableOfContents : é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 modèle 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 acceptée.

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

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

Aller-retour

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

NomTypeDescription
attributesObjectAttributs de l'élément.

Aller-retour

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

setLinkUrl(url)

Définit l'URL du lien.

Paramètres

NomTypeDescription
urlStringURL du lien

Aller-retour

TableOfContents : é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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Paramètres

NomTypeDescription
textAlignmentTextAlignmentType d'alignement du texte à appliquer.

Aller-retour

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