Class TableOfContents

Efface le contenu de l'élément.

Renvois

TableOfContents : élément actuel.

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

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

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

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

Paramètres

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

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

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

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

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

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

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

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

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

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

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

Paramètres

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

Récupère l'URL du lien.

Renvois

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 correspondant à un ou plusieurs des champs d'application 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.

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

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

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

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

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

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

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

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

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

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

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

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

Renvois

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

Définit l'URL du lien.

Paramètres

Renvois

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

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

Renvois

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