Class TextRange

TextRange

Segment du contenu textuel d'un élément Shape ou TableCell.

Si vous utilisez des méthodes qui modifient la façon dont le texte s'intègre à une forme, les paramètres d'ajustement automatique appliqués à le tracé 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.
asRenderedString()StringAffiche le texte rendu limité par cette plage de la forme ou de la cellule de tableau associée dans une adapté à l'affichage pour les utilisateurs finaux.
asString()StringAffiche le texte brut limité par cette plage de la forme ou de la cellule de table associée.
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 modèle de recherche de 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 de la le décalage de début.
getAutoTexts()AutoText[]Renvoie les textes automatiques compris 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 compris dans cette plage.
getLinks()TextRange[]Renvoie une collection de plages de texte correspondant à toutes les valeurs Link de la plage de dates actuelle plage de texte 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 un nouveau TextRange couvrant une partie de la plage dont il est dérivé.
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écalage de début.
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écalage de début.
isEmpty()BooleanRenvoie true s'il n'y a pas de caractères dans cette plage et false. sinon.
replaceAllText(findText, replaceText)IntegerRemplace toutes les occurrences de texte correspondant au texte à rechercher par le texte de remplacement.
replaceAllText(findText, replaceText, matchCase)IntegerRemplace toutes les occurrences de texte correspondant au texte à rechercher par le texte de remplacement.
select()voidSélectionne uniquement les TextRange dans la présentation active et supprime tous les éléments précédents de votre choix.
setText(newText)TextRangeDéfinit le texte limité par cette plage de la forme ou de la cellule du tableau associée.

Documentation détaillée

appendParagraph(text)

Ajoute un paragraphe à la fin de la plage de texte. Le paragraphe conserve le style à 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 entourage un caractère de nouvelle ligne à la chaîne.

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

Paramètres

NomTypeDescription
textStringChaîne à ajouter en tant que paragraphe.

Renvois

Paragraph : le Paragraph ajouté.

Autorisation

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

  • https://www.googleapis.com/auth/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 correspondant à 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, AutoText dans la plage plage de texte sont remplacées par leurs valeurs affichées. De plus, tout élément non textuel figurant dans la plage de texte fournie ne sont pas ajoutées.

Paramètres

NomTypeDescription
textRangeTextRangePlage de texte à ajouter.
matchSourceFormattingBooleanSi la valeur est true, respecter la mise en forme du texte source. si false, qui correspondent à 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 correspondant à 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. Le texte conserve le style de la fin de la 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 correspondant à un ou plusieurs des champs d'application suivants:

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

asRenderedString()

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

Les éléments AutoText, 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 correspondant à un ou plusieurs des champs d'application suivants:

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

asString()

Affiche le texte brut limité par cette plage de la forme ou de la cellule de table associée.

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

Renvois

String

Autorisation

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

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

clear()

Efface le texte limité par cette plage.

Étant donné que l'intégralité du texte dans Shape ou TableCell doit se terminer par une nouvelle ligne, le retour à la ligne final dans le texte n'est pas supprimé.

Autorisation

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

  • https://www.googleapis.com/auth/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 une nouvelle ligne, celle-ci n'est pas supprimée, même si elle est couvertes par les décalages donnés.

Paramètres

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

Autorisation

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

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

find(pattern)

Renvoie toutes les plages correspondant au modèle de recherche de la plage de texte actuelle. La recherche est sensible à la casse.

Paramètres

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

Renvois

TextRange[]

Autorisation

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

  • https://www.googleapis.com/auth/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 en cours à partir de la le décalage de début. La recherche est sensible à la casse.

Paramètres

NomTypeDescription
patternStringLe modèle d'expression régulière à rechercher. toutes les barres obliques inverses dans le modèle doivent être échappé.
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle pour déterminer l'index de début inclusif de la plage à rechercher. startOffset doit également être inférieure à la durée de la plage actuelle.

Renvois

TextRange[]

Autorisation

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

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

getAutoTexts()

Renvoie les textes automatiques compris dans la plage de texte actuelle.

Renvois

AutoText[]

Autorisation

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

  • https://www.googleapis.com/auth/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 le début et la 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 correspondant à 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 compris dans cette plage.

Renvois

Integer

Autorisation

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

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

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

Chaque plage renvoyée s'étend sur un lien lors de sa création. Modifications de texte peut 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 correspondant à 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 correspondant à 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 correspondant à 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 correspondant à 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 correspondant à 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 un nouveau TextRange couvrant une partie de la plage dont il est dérivé.

Paramètres

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

Renvois

TextRange

Autorisation

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

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

getRuns()

Renvoie les exécutions de texte qui chevauchent la plage de texte actuelle. Une exécution de texte est un segment de texte où tous les caractères ont le même style de texte.

Chaque plage renvoyée ne couvre qu'une exécution lors de sa création. Texte ou style modifications peut faire en sorte qu'il ne représente plus exactement une exécution.

Renvois

TextRange[]

Autorisation

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

  • https://www.googleapis.com/auth/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 champs de début et de fin si les index 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 correspondant à 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 correspondant à 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écalage de début. Le paragraphe conserve le style de la version actuelle plage de texte au décalage de début.

La chaîne de texte fournie est insérée en tant que paragraphe en ajoutant au moins un entourage un caractère de nouvelle ligne à la chaîne.

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

Paramètres

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

Renvois

Paragraph : Paragraph insérée.

Autorisation

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

  • https://www.googleapis.com/auth/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 pour 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 correspondant à 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, AutoText dans la plage plage de texte sont remplacées par leurs valeurs affichées. De plus, tout élément non textuel figurant dans la plage de texte fournie ne sont pas insérées.

Paramètres

NomTypeDescription
startOffsetIntegerNombre de caractères au-delà de l'index de début de la plage de texte actuelle pour déterminer l'index de début inclusif du texte à insérer.
textRangeTextRangePlage de texte à insérer.
matchSourceFormattingBooleanSi la valeur est true, respecter la mise en forme du texte source. si false, qui correspondent à 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 correspondant à 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écalage de début. Le texte conserve le style du texte existant au niveau le 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 pour 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 correspondant à 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 false. sinon.

Renvois

Boolean

Autorisation

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

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

replaceAllText(findText, replaceText)

Remplace toutes les occurrences de texte correspondant au texte à rechercher par le texte de remplacement. La recherche est un cas insensible.

Paramètres

NomTypeDescription
findTextStringTexte à rechercher.
replaceTextStringTexte de remplacement du texte correspondant.

Renvois

Integer : le nombre d'occurrences a changé.

Autorisation

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

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

replaceAllText(findText, replaceText, matchCase)

Remplace toutes les occurrences de texte correspondant au texte à rechercher par le texte de remplacement.

Paramètres

NomTypeDescription
findTextStringTexte à rechercher.
replaceTextStringTexte de remplacement du texte correspondant.
matchCaseBooleanSi la valeur est true, la recherche est sensible à la casse. Si la valeur est false, la recherche est non sensible à la casse.

Renvois

Integer : le nombre d'occurrences a changé.

Autorisation

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

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

select()

Sélectionne uniquement les TextRange dans la présentation active et supprime tous les éléments précédents de votre choix.

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

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

    Le Selection peut être de deux types: <ph type="x-smartling-placeholder">
      </ph>
    • 1. Plage de texte. Utilisez select sur une TextRange non vide pour sélectionner la plage de la caractères.
    • 2. Position du curseur : utilisez une classe TextRange vide pour placer le curseur sur 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 correspondant à 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ée. Le texte conserve au 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 correspondant à un ou plusieurs des champs d'application suivants:

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