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

Class TextRange

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

Si vous utilisez des méthodes qui modifient l'ajustement du texte dans une forme, tous les paramètres d'ajustement automatique qui lui sont appliqués 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 active.
`appendRange(textRange, matchSourceFormatting)`	`TextRange`	Ajoute une copie de la plage de texte fournie à la fin de la plage de texte active.
`appendText(text)`	`TextRange`	Ajoute du texte à la fin de la plage de texte.
`asRenderedString()`	`String`	Renvoie le texte rendu limité par cette plage de cellules ou de cellules du tableau dans un format adapté à l'utilisateur final.
`asString()`	`String`	Renvoie le texte brut limité par cette plage de la forme ou de la cellule du tableau associée.
`clear()`	`void`	Efface le texte délimité par cette plage.
`clear(startOffset, endOffset)`	`void`	Efface 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 de la plage de texte actuelle, à partir du décalage de début.
`getAutoTexts()`	`AutoText[]`	Affiche les textes automatiques compris dans la plage de texte actuelle.
`getEndIndex()`	`Integer`	Renvoie l'index exclusif basé sur 0 pour le dernier caractère de cette plage.
`getLength()`	`Integer`	Renvoie le nombre de caractères de cette plage.
`getLinks()`	`TextRange[]`	Renvoie une collection de plages de texte qui correspondent à tous les `Link` de la plage de texte actuelle ou qui la chevauchent.
`getListParagraphs()`	`Paragraph[]`	Affiche les paragraphes des listes qui chevauchent la plage de texte actuelle.
`getListStyle()`	`ListStyle`	Renvoie le `ListStyle` de la plage de texte actuelle.
`getParagraphStyle()`	`ParagraphStyle`	Renvoie le `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 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()`	`Integer`	Renvoie l'index inclusif à base de 0 pour le premier caractère de cette plage.
`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ébut du décalage.
`insertRange(startOffset, textRange)`	`TextRange`	Insère une copie de la plage de texte fournie au début du décalage.
`insertRange(startOffset, textRange, matchSourceFormatting)`	`TextRange`	Insère une copie de la plage de texte fournie au début du décalage.
`insertText(startOffset, text)`	`TextRange`	Insère le texte au début de la décalage.
`isEmpty()`	`Boolean`	Renvoie `true` si cette plage ne contient aucun caractère et renvoie `false` dans les autres cas.
`replaceAllText(findText, replaceText)`	`Integer`	Remplace toutes les occurrences de texte correspondant au texte recherché par le texte de remplacement.
`replaceAllText(findText, replaceText, matchCase)`	`Integer`	Remplace toutes les occurrences de texte correspondant au texte recherché par le texte de remplacement.
`select()`	`void`	Ne sélectionne que le `TextRange` dans la présentation active et supprime toute sélection précédente.
`setText(newText)`	`TextRange`	Dé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 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 autour de la chaîne.

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

Paramètres

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

Aller-retour

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 active.

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

Paramètres

Nom	Type	Description
`textRange`	`TextRange`	Plage de texte à ajouter.

Aller-retour

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 active.

S'il est défini pour correspondre au format du texte de destination, AutoText dans la plage de texte fournie est remplacé par les valeurs affichées. De plus, aucun élément non textuel compris dans 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`, correspond à la mise en forme du texte source. Si elle est `false`, correspond à la mise en forme du texte de destination.

Aller-retour

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.

Aller-retour

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 rendu limité par cette plage de cellules ou de cellules du tableau dans un format adapté à l'utilisateur final.

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.

Aller-retour

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 limité par cette plage de la forme ou de la cellule du tableau associée.

Les éléments AutoText, 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.

Aller-retour

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'ensemble du texte d'une forme ou d'une cellule de cellule doit se terminer par une nouvelle ligne, la nouvelle ligne finale dans le texte n'est pas supprimée.

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 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 ne sera pas supprimée, même si elle est couverte par les décalages indiqué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 à 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. La valeur de `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 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 de 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. Toutes les barres obliques inverses du modèle doivent être échappées.

Aller-retour

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 de 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. Toutes 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.

Aller-retour

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()`

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

Aller-retour

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

Aller-retour

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 de cette plage.

Aller-retour

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 une collection de plages de texte qui correspondent à tous les Link de la plage de texte actuelle ou qui la chevauchent.

Lors de sa création, il est garanti que chaque plage renvoyée couvre un lien. Les modifications de texte risquent de ne plus représenter 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

Aller-retour

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()`

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

Aller-retour

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 le ListStyle de la plage de texte actuelle.

Aller-retour

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 le ParagraphStyle de la plage de texte actuelle.

Aller-retour

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.

Aller-retour

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 nouveau TextRange couvrant une partie de la plage dont 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ée pour déterminer l'index de fin exclusif de la plage renvoyée. La valeur de `endOffset` doit être supérieure ou égale à `startOffset`. `endOffset` doit également être inférieur ou égal à la longueur de la plage actuelle.

Aller-retour

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 exécutions de texte qui chevauchent la plage de texte actuelle. Une exécution de texte est un segment de texte dans lequel tous les caractères ont le même style.

Lors de sa création, chaque plage renvoyée ne peut couvrir qu'une seule exécution. Les modifications de texte ou de style peuvent entraîner qu'elles ne représentent plus exactement une exécution.

Aller-retour

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 inclusif à base de 0 pour le premier caractère de cette plage. Si les index de début et de fin sont égaux, la plage est considérée comme vide.

Aller-retour

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.

Aller-retour

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ébut du décalage. Le paragraphe conserve le style de la plage de texte actuelle au début du début.

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

Lorsque la chaîne de texte fournie contient des caractères de retour à la ligne (composés 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.

Aller-retour

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ébut du décalage.

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.

Aller-retour

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ébut du décalage.

S'il est défini pour correspondre au format du texte de destination, AutoText dans la plage de texte fournie est remplacé par les valeurs affichées. De plus, tous les éléments non textuels de la plage de texte fournie ne sont pas inséré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 du texte à insérer.
`textRange`	`TextRange`	Plage de texte à insérer.
`matchSourceFormatting`	`Boolean`	Si la valeur est `true`, correspond à la mise en forme du texte source. Si elle est `false`, correspond à la mise en forme du texte de destination.

Aller-retour

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 le texte au début de la décalage. Le texte conserve le style du texte existant au début du décalage.

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.

Aller-retour

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 renvoie false dans les autres cas.

Aller-retour

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 de texte correspondant au texte recherché 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 à utiliser pour remplacer le texte correspondant.

Aller-retour

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 de texte correspondant au texte recherché par le texte de remplacement.

Paramètres

Nom	Type	Description
`findText`	`String`	Texte à rechercher.
`replaceText`	`String`	Texte à utiliser pour remplacer le texte correspondant.
`matchCase`	`Boolean`	Si la valeur `true` est sélectionnée, la recherche est sensible à la casse. Si la valeur est `false`, la recherche n'est pas sensible à la casse.

Aller-retour

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()`

Ne sélectionne que le TextRange dans la présentation active et supprime toute sélection précédente.

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

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

Il existe deux types de Selection :

1. Plage de texte. Sélectionnez une plage de texte non vide pour sélectionner la plage de caractères.
2. Position du curseur : utilisez une valeur 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 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 limité par cette plage de la forme ou de la cellule du 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.

Aller-retour

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