Class Text

Ajoute le texte spécifié à la fin de cette région de texte.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds the text, 'Sample body text,' to the end of the tab body.
const text = body.editAsText().appendText('Sample body text');

Paramètres

Renvois

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

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

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

Supprime une plage de texte.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Deletes the first 10 characters in the body.
const text = body.editAsText().deleteText(0, 9);

Paramètres

Renvois

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

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 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 les attributs à l'offset de caractère spécifié.

Le résultat est un objet contenant une propriété pour chaque attribut de texte valide, où chaque nom de propriété correspond à un élément de l'énumération DocumentApp.Attribute.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes.
const style = {};
style[DocumentApp.Attribute.BOLD] = true;
style[DocumentApp.Attribute.ITALIC] = true;
style[DocumentApp.Attribute.FONT_SIZE] = 29;

// Sets the style attributes to the tab's body.
const text = body.editAsText();
text.setAttributes(style);

// Gets the style attributes applied to the eleventh character in the
// body and logs them to the console.
const attributes = text.getAttributes(10);
console.log(attributes);

Paramètres

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 le paramètre de couleur d'arrière-plan.

Renvois

String|null : couleur d'arrière-plan, formatée en notation CSS (comme '#ffffff'), ou 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 scopes suivants :

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

Récupère la couleur d'arrière-plan à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the body.
const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB');

// Gets the background color of the first character in the body.
const backgroundColor = text.getBackgroundColor(0);

// Logs the background color to the console.
console.log(backgroundColor);

Paramètres

Renvois

String|null : couleur d'arrière-plan, formatée en notation CSS (comme '#ffffff').

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 paramètre de la famille de polices. Le nom peut être n'importe quelle police du menu "Police" de Docs ou de Google Fonts. Il est sensible à la casse. Les méthodes getFontFamily() et setFontFamily(fontFamilyName) utilisent désormais des noms de chaîne pour les polices au lieu de l'énumération FontFamily. Bien que cette énumération soit obsolète, elle restera disponible pour assurer la compatibilité avec les anciens scripts.

Renvois

String|null : famille de police ou 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 scopes suivants :

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

Récupère la famille de polices à l'offset de caractère spécifié. Le nom peut être n'importe quelle police du menu "Police" dans Docs ou Google Fonts. Il est sensible à la casse. Les méthodes getFontFamily() et setFontFamily(fontFamilyName) utilisent désormais des noms de chaîne pour les polices au lieu de l'énumération FontFamily. Bien que cette énumération soit obsolète, elle restera disponible pour assurer la compatibilité avec les anciens scripts.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 16 characters to Impact.
const text = body.editAsText().setFontFamily(0, 15, 'Impact');

// Gets the font family of the 16th character in the tab body.
const fontFamily = text.getFontFamily(15);

// Logs the font family to the console.
console.log(fontFamily);

Paramètres

Renvois

String|null : famille de polices.

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 paramètre de taille de police.

Renvois

Number|null : taille de la police ou 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 scopes suivants :

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

Récupère la taille de la police à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font size of the first 13 characters to 15.
const text = body.editAsText().setFontSize(0, 12, 15);

// Gets the font size of the first character.
const fontSize = text.getFontSize(0);

// Logs the font size to the console.
console.log(fontSize);

Paramètres

Renvois

Number|null : taille de la police.

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 paramètre de couleur du premier plan.

Renvois

String|null : couleur de premier plan, au format CSS (par exemple, '#ffffff'), ou 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 scopes suivants :

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

Récupère la couleur de premier plan à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 3 characters in the tab body.
const text = body.editAsText().setForegroundColor(0, 2, '#0000FF');

// Gets the foreground color of the first character in the tab body.
const foregroundColor = text.getForegroundColor(0);

// Logs the foreground color to the console.
console.log(foregroundColor);

Paramètres

Renvois

String|null : couleur de premier plan, mise en forme dans la notation CSS (comme '#ffffff').

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'URL du lien.

Renvois

String|null : URL du lien ou valeur nulle 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 scopes suivants :

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

Récupère l'URL du lien à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 10 characters in the body.
const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/');

// Gets the URL of the link from the first character.
const link = text.getLinkUrl(0);

// Logs the link URL to the console.
console.log(link);

Paramètres

Renvois

String|null : URL du lien.

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 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 l'alignement du texte pour un seul caractère. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT et DocumentApp.TextAlignment.SUPERSCRIPT.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the text alignment of the tab's body to NORMAL.
const text =
    body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL);

// Gets the text alignment of the ninth character.
const alignment = text.getTextAlignment(8);

// Logs the text alignment to the console.
console.log(alignment.toString());

Paramètres

Renvois

TextAlignment|null : type d'alignement du texte ou null 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 l'ensemble des index de texte qui correspondent au début des différentes exécutions de mise en forme du texte.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text indices at which text formatting changes.
const indices = body.editAsText().getTextAttributeIndices();

// Logs the indices to the console.
console.log(indices.toString());

Renvois

Integer[] : ensemble des index de texte où la mise en forme du texte change.

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 texte spécifié au décalage de caractère donné.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Inserts the text, 'Sample inserted text', at the start of the body content.
const text = body.editAsText().insertText(0, 'Sample inserted text');

Paramètres

Renvois

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

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

Récupère le paramètre de mise en gras.

Renvois

Boolean|null : indique si le texte est en gras ou "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 scopes suivants :

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

Récupère le paramètre de mise en gras à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Bolds the first 4 characters in the tab body.
const text = body.editAsText().setBold(0, 3, true);

// Gets whether or not the text is bold.
const bold = text.editAsText().isBold(0);

// Logs the text's bold setting to the console
console.log(bold);

Paramètres

Renvois

Boolean|null : paramètre "Gras".

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 paramètre d'italique.

Renvois

Boolean|null : indique si le texte est en italique ou est défini sur "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 scopes suivants :

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

Récupère le paramètre d'italique à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to italic.
const text = body.editAsText().setItalic(0, 12, true);

// Gets whether the fifth character in the tab body is set to
// italic and logs it to the console.
const italic = text.isItalic(4);
console.log(italic);

Paramètres

Renvois

Boolean|null : paramètre d'italique.

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 paramètre de texte barré.

Renvois

Boolean|null : indique si le texte est barré ou 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 scopes suivants :

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

Récupère le paramètre de mise en forme barrée à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 17 characters of the tab body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 16, true);

// Gets whether the first character in the tab body is set to
// strikethrough and logs it to the console.
const strikethrough = text.isStrikethrough(0);
console.log(strikethrough);

Paramètres

Renvois

Boolean|null : paramètre de texte barré.

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 paramètre de soulignement.

Renvois

Boolean|null : indique si le texte est souligné ou 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 scopes suivants :

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

Récupère le paramètre de soulignement à l'offset de caractère spécifié.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to underline.
const text = body.editAsText().setUnderline(0, 12, false);

// Gets whether the first character in the tab body is set to
// underline and logs it to the console
const underline = text.editAsText().isUnderline(0);
console.log(underline);

Paramètres

Renvois

Boolean|null : paramètre de soulignement.

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

Fusionne l'élément avec l'élément frère précédent du même type.

Seuls les éléments du même ElementType peuvent être fusionnés. Tous les éléments enfants contenus dans l'élément actuel sont déplacés vers l'élément frère précédent.

L'élément actuel est supprimé du document.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Renvois

Text|null : élément fusionné.

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

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

Applique les attributs spécifiés à la plage de caractères donnée.

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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes for font size and font family.
const style = {};
style[DocumentApp.Attribute.FONT_SIZE] = 20;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact';

// Sets the style attributes to the first 9 characters in the tab's body.
const text = body.setAttributes(0, 8, style);

Paramètres

Renvois

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

Text : é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 la couleur d'arrière-plan pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the
// tab body to hex color #0000FF.
const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');

Paramètres

Renvois

Text : é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 la couleur d'arrière-plan.

Paramètres

Renvois

Text : é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 paramètre de mise en gras.

Paramètres

Renvois

Text : é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 paramètre de mise en gras pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to bold.
const text = body.editAsText().setBold(0, 10, true);

Paramètres

Renvois

Text : é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 la famille de polices pour la plage de caractères spécifiée. Le nom peut être n'importe quelle police du menu "Police" de Docs ou de Google Fonts. Il est sensible à la casse. Les noms de police non reconnus seront affichés en Arial. Les méthodes getFontFamily(offset) et setFontFamily(fontFamilyName) utilisent désormais des noms de chaîne pour les polices au lieu de l'énumération FontFamily. Bien que cette énumération soit obsolète, elle restera disponible pour assurer la compatibilité avec les anciens scripts.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 4 characters in the tab's body to Roboto.
const text = body.editAsText().setFontFamily(0, 3, 'Roboto');

Paramètres

Renvois

Text : é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 la famille de polices. Le nom peut être n'importe quelle police du menu "Police" de Docs ou de Google Fonts. Il est sensible à la casse. Les noms de police non reconnus seront affichés en Arial. Les méthodes getFontFamily() et setFontFamily(fontFamilyName) utilisent désormais des noms de chaîne pour les polices au lieu de l'énumération FontFamily. Bien que cet énumérateur soit obsolète, il restera disponible pour assurer la compatibilité avec les anciens scripts.

Paramètres

Renvois

Text : é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 la taille de police pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the size of the first 11 characters in the tab's body to 12.
const text = body.editAsText().setFontSize(0, 10, 12);

Paramètres

Renvois

Text : é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 la taille de la police.

Paramètres

Renvois

Text : é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 la couleur de premier plan pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 2 characters in the
// tab's body to hex color #FF0000.
const text = body.editAsText().setForegroundColor(0, 1, '#FF0000');

// Gets the foreground color for the second character in the tab's body.
const foregroundColor = text.getForegroundColor(1);

//  Logs the foreground color to the console.
console.log(foregroundColor);

Paramètres

Renvois

Text : é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 la couleur de premier plan.

Paramètres

Renvois

Text : é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 paramètre d'italique.

Paramètres

Renvois

Text : é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 paramètre d'italique pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to italic.
const text = body.editAsText().setItalic(0, 10, true);

Paramètres

Renvois

Text : é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'URL du lien pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 11 characters in the body.
const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');

Paramètres

Renvois

Text : é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'URL du lien.

Paramètres

Renvois

Text : é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 paramètre de mise en forme barrée.

Paramètres

Renvois

Text : é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 paramètre de mise en forme barrée pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 10, true);

Paramètres

Renvois

Text : é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 textuel.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Replaces the contents of the body with the text, 'New body text.'
const text = body.editAsText().setText('New body text.');

Paramètres

Renvois

Text : é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 pour une plage de caractères donnée. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT et DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the first character in the first paragraph of the active tab be
// superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Paramètres

Renvois

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

Text : é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 paramètre de soulignement.

Paramètres

Renvois

Text : é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 paramètre de soulignement pour la plage de caractères spécifiée.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to underline.
const text = body.editAsText().setUnderline(0, 10, true);

Paramètres

Renvois

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