Class Text

Texte

Élément représentant une zone de texte enrichi. Tout le texte d'une Document est contenu dans des éléments Text. Un élément Text peut être contenu dans un élément Equation, EquationFunction, ListItem ou Paragraph, mais ne peut pas contenir lui-même un autre élément. Pour en savoir plus sur la structure des documents, consultez le guide d'extension de Google Docs.

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

// Use editAsText to obtain a single text element containing
// all the characters in the document.
var text = body.editAsText();

// Insert text at the beginning of the document.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the document.
text.appendText('\nAppended text.');

// Make the first half of the document blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

Méthodes

MéthodeType renvoyéBrève description
appendText(text)TextAjoute le texte spécifié à la fin de cette zone de texte.
copy()TextRenvoie une copie profonde et dissociée de l'élément actuel.
deleteText(startOffset, endOffsetInclusive)TextSupprime une plage de texte.
editAsText()TextObtient une version Text de l'élément actuel pour le modifier.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, en partant d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getAttributes(offset)ObjectRécupère les attributs au décalage de caractères spécifié.
getBackgroundColor()StringRécupère le paramètre de couleur d'arrière-plan.
getBackgroundColor(offset)StringRécupère la couleur d'arrière-plan au décalage de caractères spécifié.
getFontFamily()StringRécupère le paramètre de famille de polices.
getFontFamily(offset)StringRécupère la famille de polices au décalage de caractères spécifié.
getFontSize()NumberRécupère le paramètre de taille de police.
getFontSize(offset)NumberRécupère la taille de police au décalage de caractères spécifié.
getForegroundColor()StringRécupère le paramètre de couleur de premier plan.
getForegroundColor(offset)StringRécupère la couleur de premier plan selon le décalage de caractères spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getLinkUrl(offset)StringRécupère l'URL du lien au décalage de caractères spécifié.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
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 la forme d'une chaîne de texte.
getTextAlignment()TextAlignmentRécupère l'alignement du texte.
getTextAlignment(offset)TextAlignmentRécupère l'alignement du texte d'un seul caractère.
getTextAttributeIndices()Integer[]Récupère l'ensemble des index textuels correspondant au début d'exécutions distinctes de mise en forme de texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertText(offset, text)TextInsère le texte spécifié avec le décalage de caractères donné.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isBold()BooleanRécupère le paramètre en gras.
isBold(offset)BooleanRécupère le paramètre en gras au décalage de caractères spécifié.
isItalic()BooleanRécupère le paramètre italique.
isItalic(offset)BooleanRécupère le paramètre italique au décalage de caractères spécifié.
isStrikethrough()BooleanRécupère le paramètre barré.
isStrikethrough(offset)BooleanRécupère le paramètre barré au décalage de caractères spécifié.
isUnderline()BooleanRécupère le paramètre de soulignement.
isUnderline(offset)BooleanRécupère le paramètre de soulignement au décalage de caractères spécifié.
merge()TextFusionne l'élément avec le frère ou la sœur du même type.
removeFromParent()TextSupprime 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(startOffset, endOffsetInclusive, attributes)TextApplique les attributs spécifiés à la plage de caractères donnée.
setAttributes(attributes)TextDéfinit les attributs de l'élément.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextDéfinit la couleur d'arrière-plan de la plage de caractères spécifiée.
setBackgroundColor(color)TextDéfinit la couleur de l'arrière-plan.
setBold(bold)TextDéfinit le paramètre en gras.
setBold(startOffset, endOffsetInclusive, bold)TextDéfinit le paramètre en gras de la plage de caractères spécifiée.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextDéfinit la famille de polices pour la plage de caractères spécifiée.
setFontFamily(fontFamilyName)TextDéfinit la famille de polices.
setFontSize(startOffset, endOffsetInclusive, size)TextDéfinit la taille de la police pour la plage de caractères spécifiée.
setFontSize(size)TextDéfinit la taille de la police.
setForegroundColor(startOffset, endOffsetInclusive, color)TextDéfinit la couleur de premier plan de la plage de caractères spécifiée.
setForegroundColor(color)TextDéfinit la couleur de premier plan.
setItalic(italic)TextDéfinit le paramètre Italique.
setItalic(startOffset, endOffsetInclusive, italic)TextDéfinit le paramètre italique pour la plage de caractères spécifiée.
setLinkUrl(startOffset, endOffsetInclusive, url)TextDéfinit l'URL du lien correspondant à la plage de caractères spécifiée.
setLinkUrl(url)TextDéfinit l'URL du lien.
setStrikethrough(strikethrough)TextDéfinit le paramètre Barré.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextDéfinit le paramètre Barré pour la plage de caractères spécifiée.
setText(text)TextDéfinit le contenu du texte.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextDéfinit l'alignement du texte d'une plage de caractères donnée.
setTextAlignment(textAlignment)TextDéfinit l'alignement du texte.
setUnderline(underline)TextDéfinit le paramètre de soulignement.
setUnderline(startOffset, endOffsetInclusive, underline)TextDéfinit le paramètre de soulignement de la plage de caractères spécifiée.

Documentation détaillée

appendText(text)

Ajoute le texte spécifié à la fin de cette zone 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
textStringTexte à ajouter.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

copy()

Renvoie une copie profonde 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.

Aller-retour

Text : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

deleteText(startOffset, endOffsetInclusive)

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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage du premier caractère à supprimer.
endOffsetInclusiveIntegerDécalage du dernier caractère à supprimer.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

editAsText()

Obtient une version Text de l'élément actuel pour le modifier.

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 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 texte de l'élément actuel


findText(searchPattern)

Recherche dans le contenu de l'élément le modèle de texte spécifié à l'aide d'expressions régulières.

Un sous-ensemble des fonctionnalités des expressions régulières 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
searchPatternStringmodèle à rechercher

Aller-retour

RangeElement : résultat de recherche indiquant la position du texte de recherche, ou "null" s'il n'y a pas de correspondance

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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, en partant d'un résultat de recherche donné.

Un sous-ensemble des fonctionnalités des expressions régulières 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
searchPatternStringmodèle à rechercher
fromRangeElementle résultat de recherche à partir duquel effectuer la recherche

Aller-retour

RangeElement : résultat de recherche indiquant la position suivante du texte de recherche, ou "null" s'il n'y a pas de correspondance.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 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 pour un ou plusieurs des champs d'application suivants:

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

getAttributes(offset)

Récupère les attributs au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.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 document 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

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

Object : attributs de l'élément.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

getBackgroundColor()

Récupère le paramètre de couleur d'arrière-plan.

Aller-retour

String : couleur d'arrière-plan, au format CSS (par exemple, '#ffffff'), 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 pour un ou plusieurs des champs d'application suivants:

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

getBackgroundColor(offset)

Récupère la couleur d'arrière-plan au décalage de caractères 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/abc123456');

// Gets the document body.
const body = doc.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

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

String : couleur d'arrière-plan, au format CSS (par exemple, '#ffffff').

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

getFontFamily()

Récupère le paramètre de famille de polices. Vous pouvez choisir n'importe quelle police à partir du menu "Police" de Docs ou de Google Fonts, et le nom 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.

Aller-retour

String : famille de polices, 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 pour un ou plusieurs des champs d'application suivants:

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

getFontFamily(offset)

Récupère la famille de polices au décalage de caractères spécifié. Vous pouvez utiliser n'importe quelle police dans le menu "Police" de Docs ou de Google Fonts, et le nom 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/abc123456/edit');

// Gets the document body.
const body = doc.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 document body.
const fontFamily = text.getFontFamily(15);

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

Paramètres

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

String : famille de polices.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

getFontSize()

Récupère le paramètre de taille de police.

Aller-retour

Number : taille de police, 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 pour un ou plusieurs des champs d'application suivants:

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

getFontSize(offset)

Récupère la taille de police au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.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

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

Number : taille de la police.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

getForegroundColor()

Récupère le paramètre de couleur de premier plan.

Aller-retour

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

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

getForegroundColor(offset)

Récupère la couleur de premier plan selon le décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

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

Paramètres

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

String : couleur de premier plan au format CSS (par exemple, '#ffffff').

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 pour un ou plusieurs des champs d'application suivants :

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

getLinkUrl(offset)

Récupère l'URL du lien au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.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

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

String : URL du lien.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 sœur 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 pour 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 pour 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.

La sœur précédente a 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 pour 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 la forme d'une 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 pour 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'alignements de texte ou si l'alignement n'a jamais été défini.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

getTextAlignment(offset)

Récupère l'alignement du texte d'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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

// Sets the text alignment of the document 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

NomTypeDescription
offsetIntegerDécalage du caractère.

Aller-retour

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

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

getTextAttributeIndices()

Récupère l'ensemble des index textuels correspondant au début d'exécutions distinctes de mise en forme 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/abc123456/edit');

// Gets the document body.
const body = doc.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());

Aller-retour

Integer[] : ensemble d'index de texte permettant de modifier la mise en forme du texte.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 le ElementType de l'élément.

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

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

insertText(offset, text)

Insère le texte spécifié avec le décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.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

NomTypeDescription
offsetIntegerDécalage de caractère auquel insérer le texte.
textStringTexte à insérer.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 pour un ou plusieurs des champs d'application suivants:

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

isBold()

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

Aller-retour

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

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

isBold(offset)

Récupère le paramètre en gras au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

// Bolds the first 4 characters in the document 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

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

Boolean : paramètre en gras.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

isItalic()

Récupère le paramètre italique.

Aller-retour

Boolean : indique si le texte est en italique ou null si l'élément contient plusieurs valeurs pour cet attribut.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

isItalic(offset)

Récupère le paramètre italique au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

Paramètres

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

Boolean : paramètre italique.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

isStrikethrough()

Récupère le paramètre barré.

Aller-retour

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

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

isStrikethrough(offset)

Récupère le paramètre barré au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

Paramètres

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

Boolean : paramètre barré.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

isUnderline()

Récupère le paramètre de soulignement.

Aller-retour

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

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

isUnderline(offset)

Récupère le paramètre de soulignement au décalage de caractères 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

Paramètres

NomTypeDescription
offsetIntegerDécalage de caractère.

Aller-retour

Boolean : paramètre de soulignement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

merge()

Fusionne l'élément avec le frère ou la sœur 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.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Aller-retour

Text : élément fusionné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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

Text : élément supprimé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 compatible.

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
replacementStringle texte à utiliser en remplacement ;

Aller-retour

Element : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setAttributes(startOffset, endOffsetInclusive, attributes)

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

Le paramètre d'attributs spécifié doit être un objet où 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/abc123456/edit');

// Gets the document body and edits as text.
const body = doc.getBody().editAsText();

// 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 document body.
const text = body.setAttributes(0, 8, style);

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
attributesObjectAttributs de l'élément.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 de propriété est un élément de l'énumération DocumentApp.Attribute et chaque valeur de propriété est 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

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setBackgroundColor(startOffset, endOffsetInclusive, color)

Définit la couleur d'arrière-plan de 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
colorStringCouleur d'arrière-plan, au format CSS (par exemple, '#ffffff').

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setBackgroundColor(color)

Définit la couleur de l'arrière-plan.

Paramètres

NomTypeDescription
colorStringLa couleur d'arrière-plan, au format CSS (par exemple, '#ffffff')

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setBold(bold)

Définit le paramètre en gras.

Paramètres

NomTypeDescription
boldBooleanparamètre en gras

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setBold(startOffset, endOffsetInclusive, bold)

Définit le paramètre en gras de 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
boldBooleanParamètre en gras.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

Définit la famille de polices pour la plage de caractères spécifiée. Vous pouvez choisir n'importe quelle police à partir du menu "Police" de Docs ou de Google Fonts. Il est sensible à la casse. Les noms de polices non reconnus apparaîtront au format 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/abc123456/edit');

// Gets body of the document.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
fontFamilyNameStringNom de la famille de polices du menu des polices dans Docs ou Google Fonts.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setFontFamily(fontFamilyName)

Définit la famille de polices. Vous pouvez choisir n'importe quelle police à partir du menu "Police" de Docs ou de Google Fonts, et le nom est sensible à la casse. Les noms de polices non reconnus apparaîtront au format 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 cette énumération soit obsolète, elle restera disponible pour assurer la compatibilité avec les anciens scripts.

Paramètres

NomTypeDescription
fontFamilyNameStringNom de la famille de polices, disponible dans le menu des polices de Docs ou de Google Fonts

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setFontSize(startOffset, endOffsetInclusive, size)

Définit la taille de la 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
sizeNumberTaille de la police.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setFontSize(size)

Définit la taille de la police.

Paramètres

NomTypeDescription
sizeNumberla taille de police

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setForegroundColor(startOffset, endOffsetInclusive, color)

Définit la couleur de premier plan de 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

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

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
colorStringCouleur de premier plan au format CSS (par exemple, '#ffffff').

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setForegroundColor(color)

Définit la couleur de premier plan.

Paramètres

NomTypeDescription
colorStringLa couleur de premier plan, au format CSS (par exemple, '#ffffff')

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setItalic(italic)

Définit le paramètre Italique.

Paramètres

NomTypeDescription
italicBooleanparamètre italique

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setItalic(startOffset, endOffsetInclusive, italic)

Définit le paramètre 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
italicBooleanParamètre en italique.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setLinkUrl(startOffset, endOffsetInclusive, url)

Définit l'URL du lien correspondant à 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
urlStringURL du lien

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setStrikethrough(strikethrough)

Définit le paramètre Barré.

Paramètres

NomTypeDescription
strikethroughBooleanle paramètre Barré

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

Définit le paramètre Barré 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
strikethroughBooleanParamètre barré.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
textStringNouveau contenu textuel.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants :

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

setTextAlignment(startOffset, endOffsetInclusive, textAlignment)

Définit l'alignement du texte d'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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de caractères.
endOffsetInclusiveIntegerDécalage de fin de la plage de caractères (inclus).
textAlignmentTextAlignmentType d'alignement de texte à appliquer.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour 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 de texte à appliquer

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setUnderline(underline)

Définit le paramètre de soulignement.

Paramètres

NomTypeDescription
underlineBooleanparamètre de soulignement

Aller-retour

Text : élément actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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

setUnderline(startOffset, endOffsetInclusive, underline)

Définit le paramètre de soulignement de 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/abc123456/edit');

// Gets the document body.
const body = doc.getBody();

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

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la plage de texte.
endOffsetInclusiveIntegerDécalage final de la plage de texte.
underlineBooleanParamètre de soulignement.

Aller-retour

Text : élément actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation pour un ou plusieurs des champs d'application suivants:

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