Cette page a été traduite par l'API Cloud Translation.

Class TextRange

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

Si vous utilisez des méthodes qui modifient l'ajustement du texte dans une forme, tous les paramètres d'ajustement automatique appliqués à la forme sont désactivés.

Méthodes

Méthode	Type renvoyé	Brève description
`appendParagraph(text)`	`Paragraph`	Ajoute un paragraphe à la fin de la plage de texte.
`appendRange(textRange)`	`TextRange`	Ajoute une copie de la plage de texte fournie à la fin de la plage de texte actuelle.
`appendRange(textRange, matchSourceFormatting)`	`TextRange`	Ajoute une copie de la plage de texte fournie à la fin de la plage de texte actuelle.
`appendText(text)`	`TextRange`	Ajoute du texte à la fin de la plage de texte.
`asRenderedString()`	`String`	Renvoie le texte affiché délimité par cette plage de la forme ou de la cellule de tableau associée dans un format approprié à l'affichage auprès des utilisateurs finaux.
`asString()`	`String`	Renvoie le texte brut délimité par cette plage de la forme ou de la cellule de tableau associée.
`clear()`	`void`	Efface le texte délimité par cette plage.
`clear(startOffset, endOffset)`	`void`	Efface le texte délimité par les décalages de début et de fin de la plage.
`find(pattern)`	`TextRange[]`	Renvoie toutes les plages correspondant au modèle 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()`	`Integer`	Renvoie l'index exclusif, basé sur 0, du dernier caractère de cette plage.
`getLength()`	`Integer`	Renvoie le nombre de caractères dans cette plage.
`getLinks()`	`TextRange[]`	Renvoie un ensemble de plages de texte qui correspondent à tous les `Link` de la plage de texte actuelle ou qui se chevauchent avec la plage de texte actuelle.
`getListParagraphs()`	`Paragraph[]`	Renvoie les paragraphes des listes qui chevauchent la plage de texte actuelle.
`getListStyle()`	`ListStyle`	Renvoie l'`ListStyle` de la plage de texte actuelle.
`getParagraphStyle()`	`ParagraphStyle`	Renvoie l'`ParagraphStyle` de la plage de texte actuelle.
`getParagraphs()`	`Paragraph[]`	Renvoie les paragraphes qui chevauchent la plage de texte actuelle.
`getRange(startOffset, endOffset)`	`TextRange`	Renvoie un nouvel élément `TextRange` couvrant une partie de la plage à partir de laquelle il est dérivé.
`getRuns()`	`TextRange[]`	Renvoie les étendues de texte qui chevauchent la plage de texte actuelle.
`getStartIndex()`	`Integer`	Renvoie l'index en base 0 du premier caractère de cette plage, y compris.
`getTextStyle()`	`TextStyle`	Renvoie le style de texte de la plage, ou `null` si la plage est vide.
`insertParagraph(startOffset, text)`	`Paragraph`	Insère un paragraphe au décalage de début.
`insertRange(startOffset, textRange)`	`TextRange`	Insère une copie de la plage de texte fournie au décalage de début.
`insertRange(startOffset, textRange, matchSourceFormatting)`	`TextRange`	Insère une copie de la plage de texte fournie au décalage de début.
`insertText(startOffset, text)`	`TextRange`	Insère du texte au décalage de début.
`isEmpty()`	`Boolean`	Renvoie `true` si cette plage ne contient aucun caractère, et `false` dans les autres cas.
`replaceAllText(findText, replaceText)`	`Integer`	Remplace toutes les occurrences du texte correspondant au texte à rechercher par le texte de remplacement.
`replaceAllText(findText, replaceText, matchCase)`	`Integer`	Remplace toutes les occurrences du texte correspondant au texte à rechercher par le texte de remplacement.
`select()`	`void`	Sélectionne uniquement le `TextRange` dans la présentation active et supprime toute sélection précédente.
`setText(newText)`	`TextRange`	Définit le texte délimité par cette plage de la forme ou de la cellule de tableau associée.

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 nouvelle ligne à la chaîne.

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

Paramètres

Nom	Type	Description
`text`	`String`	Chaîne à ajouter en tant que paragraphe.

Renvois

Paragraph : Paragraph ajouté.

Autorisation

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

Nom	Type	Description
`textRange`	`TextRange`	Plage 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 avec 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.

Si l'option est définie pour correspondre à la mise en forme du texte de destination, AutoText dans la plage de texte fournie est remplacé par ses valeurs affichées. De plus, aucun élément non textuel de la plage de texte fournie n'est ajouté.

Paramètres

Nom	Type	Description
`textRange`	`TextRange`	Plage de texte à ajouter.
`matchSourceFormatting`	`Boolean`	Si la valeur est `true`, utilisez la mise en forme du texte source. Si la valeur est `false`, utilisez 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 avec 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

Nom	Type	Description
`text`	`String`	Chaîne à ajouter.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 affiché délimité par cette plage de la forme ou de la cellule de tableau associée dans un format approprié à l'affichage auprès des utilisateurs finaux.

Les éléments de texte Auto, 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 avec 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 délimité par cette plage de la forme ou de la cellule de tableau associée.

Les éléments de texte automatique tels que les numéros de diapositives générés et les éléments autres que du texte 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 avec 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 délimité par cette plage.

Étant donné que l'intégralité du texte d'une forme ou d'une cellule de tableau doit se terminer par un saut de ligne, le dernier saut de ligne du texte n'est pas supprimé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 délimité par les décalages de début et de fin de la plage.

Comme le texte doit se terminer par un retour à la ligne, le dernier retour à la ligne du texte n'est pas supprimé, même s'il est couvert par les décalages donnés.

Paramètres

Nom	Type	Description
`startOffset`	`Integer`	Nombre 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 égal ou supérieur à 0, et inférieur ou égal à `endOffset`. `startOffset` doit également être inférieur à la longueur de la plage actuelle.
`endOffset`	`Integer`	Nombre de caractères au-delà de l'index de début de la plage de texte actuelle utilisé pour déterminer l'index de fin exclusif de la plage à effacer. `endOffset` doit être égal ou supérieur à `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 avec 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 dans la plage de texte actuelle. La recherche est sensible à la casse.

Paramètres

Nom	Type	Description
`pattern`	`String`	Modèle d'expression régulière à rechercher. Les barres obliques inverses du modèle doivent être échappées.

Renvois

TextRange[]

Autorisation

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

Nom	Type	Description
`pattern`	`String`	Modèle d'expression régulière à rechercher. Les barres obliques inverses du modèle doivent être échappées.
`startOffset`	`Integer`	Nombre 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 avec 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 avec 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, basé sur 0, du 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 avec 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 dans cette plage.

Renvois

Integer

Autorisation

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

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

`getLinks()`

Renvoie un ensemble de plages de texte qui correspondent à tous les Link de la plage de texte actuelle ou qui se chevauchent avec la plage de texte actuelle.

Chaque plage renvoyée couvre un lien lorsqu'elle est créée. Les modifications de texte peuvent entraîner la perte de la précision d'un lien.

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

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

Renvois

TextRange[]

Autorisation

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

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

`getListStyle()`

Renvoie l'ListStyle de la plage de texte actuelle.

Renvois

ListStyle

Autorisation

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

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

`getParagraphStyle()`

Renvoie l'ParagraphStyle de la plage de texte actuelle.

Renvois

ParagraphStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 avec 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 nouvel élément TextRange couvrant une partie de la plage à partir de laquelle il est dérivé.

Paramètres

Nom	Type	Description
`startOffset`	`Integer`	Nombre 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 égal ou supérieur à 0, et inférieur ou égal à `endOffset`. `startOffset` doit également être inférieur à la longueur de la plage actuelle.
`endOffset`	`Integer`	Nombre de caractères au-delà de l'index de début de la plage de texte actuelle utilisé pour déterminer l'index de fin exclusif de la plage renvoyée. `endOffset` doit être égal ou supérieur à `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 avec un ou plusieurs des champs d'application suivants:

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

`getRuns()`

Renvoie les étendues 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 couvre qu'une seule exécution lorsqu'elle est créée. Les modifications de texte ou de style peuvent entraîner une représentation qui ne correspond plus exactement à une seule diffusion.

Renvois

TextRange[]

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 en base 0 du premier caractère de cette plage, y compris. 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 avec 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 avec 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 plage de texte actuelle 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 caractère de nouvelle ligne à la chaîne.

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

Paramètres

Nom	Type	Description
`startOffset`	`Integer`	Nombre 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 du texte à insérer.
`text`	`String`	Chaîne à insérer.

Renvois

Paragraph : Paragraph inséré.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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écalage de début.

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

Paramètres

Nom	Type	Description
`startOffset`	`Integer`	Nombre 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 du texte à insérer.
`textRange`	`TextRange`	Plage 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 avec 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écalage de début.

Paramètres

Nom	Type	Description
`startOffset`	`Integer`	Nombre 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 du texte à insérer.
`textRange`	`TextRange`	Plage de texte à insérer.
`matchSourceFormatting`	`Boolean`	Si la valeur est `true`, utilisez la mise en forme du texte source. Si la valeur est `false`, utilisez 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 avec 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 décalage de début.

Paramètres

Nom	Type	Description
`startOffset`	`Integer`	Nombre 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 du texte à insérer.
`text`	`String`	Chaî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 avec un ou plusieurs des champs d'application suivants:

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

`isEmpty()`

Renvoie true si cette plage ne contient aucun caractère, et false dans les autres cas.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 du texte correspondant au texte à rechercher par le texte de remplacement. La recherche n'est pas sensible à la casse.

Paramètres

Nom	Type	Description
`findText`	`String`	Texte à rechercher.
`replaceText`	`String`	Texte à remplacer par le texte correspondant.

Renvois

Integer : nombre d'occurrences modifiées

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 du texte correspondant au texte à rechercher par le texte de remplacement.

Paramètres

Nom	Type	Description
`findText`	`String`	Texte à rechercher.
`replaceText`	`String`	Texte à remplacer par le texte correspondant.
`matchCase`	`Boolean`	Si 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 : nombre d'occurrences modifiées

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 le 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 si le script est lié à la présentation.

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

Les Selection peuvent être de deux types :

1. Plage de texte : utilisez la sélection sur une plage de texte non vide pour sélectionner la plage de caractères.
2. Position du curseur : utilisez une TextRange vide pour placer le curseur à l'index souhaité.
```
const 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 avec 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 délimité par cette plage de la forme ou de la cellule de tableau associée. Le texte conserve le style du début du texte existant.

Paramètres

Nom	Type	Description
`newText`	`String`	Chaî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 avec un ou plusieurs des champs d'application suivants:

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