Class TextRange

TextRange

Segment du contenu textuel d'un Shape ou d'un TableCell.

Si vous utilisez des méthodes qui modifient la façon dont le texte s'adapte à une forme, tous les paramètres d'ajustement automatique appliqués à la forme sont désactivés.

Méthodes

MéthodeType renvoyéBrève description
appendParagraph(text)ParagraphAjoute un paragraphe à la fin de la plage de texte.
appendRange(textRange)TextRangeAjoute une copie de la plage de texte fournie à la fin de la plage de texte actuelle.
appendRange(textRange, matchSourceFormatting)TextRangeAjoute une copie de la plage de texte fournie à la fin de la plage de texte actuelle.
appendText(text)TextRangeAjoute du texte à la fin de la plage de texte.
asRenderedString()StringRenvoie le texte rendu limité par cette plage de la forme ou de la cellule du tableau associée dans un format adapté à l'affichage pour les utilisateurs finaux.
asString()StringRenvoie le texte brut limité par cette plage de la forme ou de la cellule du tableau associées.
clear()voidEfface le texte limité par cette plage.
clear(startOffset, endOffset)voidEfface le texte limité par les décalages de début et de fin dans la plage.
find(pattern)TextRange[]Renvoie toutes les plages correspondant au format de recherche dans la plage de texte actuelle.
find(pattern, startOffset)TextRange[]Renvoie toutes les plages correspondant au modèle de recherche dans la plage de texte actuelle à partir du décalage de début.
getAutoTexts()AutoText[]Renvoie les textes automatiques dans la plage de texte actuelle.
getEndIndex()IntegerRenvoie l'index exclusif en base 0 pour le dernier caractère de cette plage.
getLength()IntegerRenvoie le nombre de caractères de cette plage.
getLinks()TextRange[]Renvoie une collection de plages de texte correspondant à tous les Link de la plage de texte actuelle ou chevauchant la plage de texte actuelle.
getListParagraphs()Paragraph[]Renvoie les paragraphes des listes qui chevauchent la plage de texte actuelle.
getListStyle()ListStyleRenvoie la valeur ListStyle de la plage de texte actuelle.
getParagraphStyle()ParagraphStyleRenvoie la valeur ParagraphStyle de la plage de texte actuelle.
getParagraphs()Paragraph[]Renvoie les paragraphes qui chevauchent la plage de texte actuelle.
getRange(startOffset, endOffset)TextRangeRenvoie une nouvelle valeur TextRange couvrant une partie de la plage dont elle est dérivée.
getRuns()TextRange[]Renvoie les exécutions de texte qui chevauchent la plage de texte actuelle.
getStartIndex()IntegerRenvoie l'index inclusif basé sur 0 pour le premier caractère de cette plage.
getTextStyle()TextStyleRenvoie le style de texte de la plage, ou null si la plage est vide.
insertParagraph(startOffset, text)ParagraphInsère un paragraphe au début du décalage.
insertRange(startOffset, textRange)TextRangeInsère une copie de la plage de texte fournie au début du décalage.
insertRange(startOffset, textRange, matchSourceFormatting)TextRangeInsère une copie de la plage de texte fournie au début du décalage.
insertText(startOffset, text)TextRangeInsère du texte au début du décalage.
isEmpty()BooleanRenvoie true s'il n'y a pas de caractères dans cette plage et renvoie false dans le cas contraire.
replaceAllText(findText, replaceText)IntegerRemplace toutes les occurrences de texte correspondant au texte recherché par le texte de remplacement.
replaceAllText(findText, replaceText, matchCase)IntegerRemplace toutes les occurrences de texte correspondant au texte recherché par le texte de remplacement.
select()voidSélectionne uniquement l'élément TextRange dans la présentation active et supprime toute sélection précédente.
setText(newText)TextRangeDéfinit le texte limité par cette plage de la forme ou de la cellule du tableau associées.

Documentation détaillée

appendParagraph(text)

Ajoute un paragraphe à la fin de la plage de texte. Le paragraphe conserve le style de la fin de la plage de texte actuelle.

La chaîne de texte fournie est ajoutée en tant que paragraphe en ajoutant au moins un caractère de retour à la ligne environnant à la chaîne.

Lorsque la chaîne de texte fournie contient des caractères de retour à la ligne (comportant donc plusieurs paragraphes), le paragraphe final ajouté est renvoyé.

Paramètres

NomTypeDescription
textStringChaîne à ajouter en tant que paragraphe.

Renvois

Paragraph : Paragraph ajouté.

Autorisation

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

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

appendRange(textRange)

Ajoute une copie de la plage de texte fournie à la fin de la plage de texte actuelle.

La mise en forme du texte inséré correspond à celle du texte source.

Paramètres

NomTypeDescription
textRangeTextRangePlage de texte à ajouter.

Renvois

TextRange : plage de texte représentant le texte ajouté

Autorisation

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

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

appendRange(textRange, matchSourceFormatting)

Ajoute une copie de la plage de texte fournie à la fin de la plage de texte actuelle.

S'il est défini pour correspondre à la mise en forme du texte de destination, les AutoText inclus dans la plage de texte fournie sont remplacés par leurs valeurs affichées. De plus, les éléments non textuels de la plage de texte fournie ne sont pas ajoutés.

Paramètres

NomTypeDescription
textRangeTextRangePlage de texte à ajouter.
matchSourceFormattingBooleanSi la valeur est true, correspond à la mise en forme du texte source. Si la valeur est false, correspond à la mise en forme du texte de destination.

Renvois

TextRange : plage de texte représentant le texte ajouté

Autorisation

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

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

appendText(text)

Ajoute du texte à la fin de la plage de texte. Le texte conserve le style de la fin du texte existant.

Paramètres

NomTypeDescription
textStringChaîne à ajouter.

Renvois

TextRange : plage de texte représentant le texte ajouté.

Autorisation

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

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

asRenderedString()

Renvoie le texte rendu limité par cette plage de la forme ou de la cellule du tableau associée dans un format adapté à l'affichage pour les utilisateurs finaux.

Les éléments de texte automatique, tels que les numéros de diapositives générés, sont remplacés par leurs valeurs affichées. Tous les éléments non textuels de la plage sont omis.

Renvois

String

Autorisation

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

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

asString()

Renvoie le texte brut limité par cette plage de la forme ou de la cellule du tableau associées.

Les éléments de texte automatique tels que les numéros de diapositives générés et tous les éléments non textuels de la plage sont remplacés par le caractère Unicode U+E907.

Renvois

String

Autorisation

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

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

clear()

Efface le texte limité par cette plage.

Étant donné que l'intégralité du texte de Shape ou TableCell doit se terminer par un retour à la ligne, le dernier saut de ligne du texte n'est pas supprimé.

Autorisation

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

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

clear(startOffset, endOffset)

Efface le texte limité par les décalages de début et de fin dans la plage.

Étant donné que le texte doit se terminer par un retour à la ligne, celui-ci n'est pas supprimé, même s'il est couvert par les décalages indiqués.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, utilisé pour déterminer l'index de début inclusif de la plage à effacer. Le décalage de début doit être supérieur ou égal à 0, et inférieur ou égal à endOffset. startOffset doit également être inférieur à la longueur de la plage actuelle.
endOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle permettant de déterminer l'index de fin exclusif de la plage à effacer. La valeur endOffset doit être supérieure ou égale à startOffset. endOffset doit également être inférieur ou égal à la longueur de la plage actuelle.

Autorisation

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

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

find(pattern)

Renvoie toutes les plages correspondant au format de recherche dans la plage de texte actuelle. La recherche est sensible à la casse.

Paramètres

NomTypeDescription
patternStringModèle d'expression régulière à rechercher. Toutes les barres obliques inverses dans le modèle doivent être échappées.

Renvois

TextRange[]

Autorisation

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

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

find(pattern, startOffset)

Renvoie toutes les plages correspondant au modèle de recherche dans la plage de texte actuelle à partir du décalage de début. La recherche est sensible à la casse.

Paramètres

NomTypeDescription
patternStringModèle d'expression régulière à rechercher. Toutes les barres obliques inverses dans le modèle doivent être échappées.
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, utilisé pour déterminer l'index de début inclusif de la plage à rechercher. startOffset doit également être inférieur à la longueur de la plage actuelle.

Renvois

TextRange[]

Autorisation

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

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

getAutoTexts()

Renvoie les textes automatiques dans la plage de texte actuelle.

Renvois

AutoText[]

Autorisation

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

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

getEndIndex()

Renvoie l'index exclusif en base 0 pour le dernier caractère de cette plage. Si les indices de début et de fin sont égaux, la plage est considérée comme vide.

Renvois

Integer

Autorisation

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

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

getLength()

Renvoie le nombre de caractères de cette plage.

Renvois

Integer

Autorisation

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

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

Renvoie une collection de plages de texte correspondant à tous les Link de la plage de texte actuelle ou chevauchant la plage de texte actuelle.

Chaque plage renvoyée couvre un lien lors de sa création. En effet, les modifications apportées au texte peuvent faire en sorte qu'il ne représente plus exactement un lien.

Chaque Link des plages renvoyées est accessible via TextStyle.getLink().

// Accesses the first link on a TextRange object.
var linkTextRange = textRange.getLinks()[0];
var textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink()); // logs 'true'
var link = textStyle.getLink();  // Link object

Renvois

TextRange[]

Autorisation

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

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

getListParagraphs()

Renvoie les paragraphes des listes qui chevauchent la plage de texte actuelle.

Renvois

Paragraph[]

Autorisation

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

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

getListStyle()

Renvoie la valeur ListStyle de la plage de texte actuelle.

Renvois

ListStyle

Autorisation

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

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

getParagraphStyle()

Renvoie la valeur ParagraphStyle de la plage de texte actuelle.

Renvois

ParagraphStyle

Autorisation

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

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

getParagraphs()

Renvoie les paragraphes qui chevauchent la plage de texte actuelle.

Renvois

Paragraph[]

Autorisation

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

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

getRange(startOffset, endOffset)

Renvoie une nouvelle valeur TextRange couvrant une partie de la plage dont elle est dérivée.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, utilisé pour déterminer l'index de début inclusif de la plage renvoyée. Le décalage de début doit être supérieur ou égal à 0, et inférieur ou égal à endOffset. startOffset doit également être inférieur à la longueur de la plage actuelle.
endOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, qui permet de déterminer l'index de fin exclusif de la plage renvoyée. La valeur endOffset doit être supérieure ou égale à startOffset. endOffset doit également être inférieur ou égal à la longueur de la plage actuelle.

Renvois

TextRange

Autorisation

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

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

getRuns()

Renvoie les exécutions de texte qui chevauchent la plage de texte actuelle. Une séquence de texte est un segment de texte dans lequel tous les caractères ont le même style de texte.

Chaque plage renvoyée ne couvrira qu'une seule exécution lors de sa création. Si vous modifiez le texte ou le style, il est possible qu'il ne représente plus exactement une exécution.

Renvois

TextRange[]

Autorisation

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

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

getStartIndex()

Renvoie l'index inclusif basé sur 0 pour le premier caractère de cette plage. Si les indices de début et de fin sont égaux, la plage est considérée comme vide.

Renvois

Integer

Autorisation

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

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

getTextStyle()

Renvoie le style de texte de la plage, ou null si la plage est vide.

Renvois

TextStyle

Autorisation

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

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

insertParagraph(startOffset, text)

Insère un paragraphe au début du décalage. Le paragraphe conserve le style de la plage de texte actuelle au début du décalage.

La chaîne de texte fournie est insérée sous forme de paragraphe en ajoutant au moins un caractère de retour à la ligne environnant à la chaîne.

Lorsque la chaîne de texte fournie contient des caractères de retour à la ligne (comportant donc plusieurs paragraphes), le paragraphe final ajouté est renvoyé.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, qui permet de déterminer l'index de début inclusif du texte à insérer.
textStringChaîne à insérer.

Renvois

Paragraph : Paragraph inséré.

Autorisation

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

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

insertRange(startOffset, textRange)

Insère une copie de la plage de texte fournie au début du décalage.

La mise en forme du texte inséré correspond à celle du texte source.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, qui permet de déterminer l'index de début inclusif du texte à insérer.
textRangeTextRangePlage de texte à insérer.

Renvois

TextRange : plage de texte représentant le texte inséré

Autorisation

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

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

insertRange(startOffset, textRange, matchSourceFormatting)

Insère une copie de la plage de texte fournie au début du décalage.

S'il est défini pour correspondre à la mise en forme du texte de destination, les AutoText inclus dans la plage de texte fournie sont remplacés par leurs valeurs affichées. De plus, les éléments non textuels de la plage de texte fournie ne sont pas insérés.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, qui permet de déterminer l'index de début inclusif du texte à insérer.
textRangeTextRangePlage de texte à insérer.
matchSourceFormattingBooleanSi la valeur est true, correspond à la mise en forme du texte source. Si la valeur est false, correspond à la mise en forme du texte de destination.

Renvois

TextRange : plage de texte représentant le texte inséré

Autorisation

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

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

insertText(startOffset, text)

Insère du texte au début du décalage. Le texte conserve le style du texte existant au niveau du décalage de début.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle, qui permet de déterminer l'index de début inclusif du texte à insérer.
textStringChaîne à insérer.

Renvois

TextRange : plage de texte représentant le texte inséré.

Autorisation

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

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

isEmpty()

Renvoie true s'il n'y a pas de caractères dans cette plage et renvoie false dans le cas contraire.

Renvois

Boolean

Autorisation

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

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

replaceAllText(findText, replaceText)

Remplace toutes les occurrences de texte correspondant au texte recherché par le texte de remplacement. La recherche n'est pas sensible à la casse.

Paramètres

NomTypeDescription
findTextStringTexte à rechercher.
replaceTextStringTexte pour remplacer le texte correspondant.

Renvois

Integer : le nombre d'occurrences a changé.

Autorisation

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

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

replaceAllText(findText, replaceText, matchCase)

Remplace toutes les occurrences de texte correspondant au texte recherché par le texte de remplacement.

Paramètres

NomTypeDescription
findTextStringTexte à rechercher.
replaceTextStringTexte pour remplacer le texte correspondant.
matchCaseBooleanSi la valeur est true, la recherche est sensible à la casse. Si la valeur est false, la recherche n'est pas sensible à la casse.

Renvois

Integer : le nombre d'occurrences a changé.

Autorisation

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

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

select()

Sélectionne uniquement l'élément TextRange dans la présentation active et supprime toute sélection précédente.

Un script ne peut accéder qu'à la sélection de l'utilisateur qui l'exécute, et uniquement s'il est lié à la présentation.

Le parent Page du Shape ou du TableCell correspondant est défini comme current page selection. Shape ou TableCell est défini comme selected page element.

    Selection peut être de deux types :
    • 1. Plage de texte. Utilisez select sur une TextRange non vide pour sélectionner la plage de caractères.
    • 2. Position du curseur : utilisez une classe TextRange vide pour placer le curseur à l'index souhaité.
      var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
      shape.getText().setText("Hello");
      // Range selection: Select the text range "He".
      shape.getText().getRange(0, 2).select();
      // Cursor selection: Place the cursor after "H" like "H|ello".
      shape.getText().getRange(1, 1).select();

      Autorisation

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

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

    setText(newText)

    Définit le texte limité par cette plage de la forme ou de la cellule du tableau associées. Le texte conserve le style du début du texte existant.

    Paramètres

    NomTypeDescription
    newTextStringChaîne à définir comme nouveau texte.

    Renvois

    TextRange : plage de texte représentant le texte défini

    Autorisation

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

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