Class RichTextValue
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Valeurtextuelleriche
Chaîne de texte stylisée utilisée pour représenter le texte de la cellule. Les sous-chaînes du texte peuvent avoir différents styles de texte.
Une chaîne est la sous-chaîne la plus longue et continue ayant le même style de texte. Par exemple, la phrase "Cet enfant porte des pommes" comporte quatre exécutions: ['This ', 'child ',
'is carrying ', 'apples'].
Documentation détaillée
copy()
Renvoie un générateur pour une valeur de texte enrichi initialisée avec les valeurs de cette valeur de texte enrichi.
Renvois
RichTextValueBuilder : outil de création d'une valeur de texte enrichi.
getEndIndex()
Récupère l'indice de fin de cette valeur dans la cellule.
Renvois
Integer : index de fin de cette valeur dans la cellule.
getLinkUrl()
Renvoie l'URL du lien pour cette valeur.
Renvois
String : URL du lien pour cette valeur, ou null s'il n'y a pas de lien ou s'il y en a plusieurs.
getLinkUrl(startOffset, endOffset)
Renvoie l'URL du lien pour le texte de startOffset à endOffset. Les décalages sont basés sur 0 et sont relatifs au texte de la cellule, le décalage de début étant inclusif et le décalage de fin étant exclusif.
Paramètres
| Nom | Type | Description |
startOffset | Integer | Décalage de début. |
endOffset | Integer | Décalage de fin. |
Renvois
String : URL du lien pour cette valeur, ou null s'il n'y a pas de lien ou si plusieurs liens différents se trouvent dans la plage donnée.
getRuns()
Renvoie la chaîne de texte enrichi divisée en un tableau d'exécutions, où chaque exécution est la sous-chaîne la plus longue possible avec un style de texte cohérent.
Renvois
RichTextValue[] : tableau d'exécutions.
getStartIndex()
Récupère l'index de début de cette valeur dans la cellule.
Renvois
Integer : index de début de cette valeur dans la cellule.
getText()
Renvoie le texte de cette valeur.
Renvois
String : texte de cette valeur.
getTextStyle()
Renvoie le style de texte de cette valeur.
Renvois
TextStyle : style de texte de cette valeur.
getTextStyle(startOffset, endOffset)
Renvoie le style de texte de startOffset à endOffset. Les décalages sont basés sur 0 et sont relatifs au texte de la cellule, le décalage de début étant inclusif et le décalage de fin étant exclusif.
Paramètres
| Nom | Type | Description |
startOffset | Integer | Décalage de début. |
endOffset | Integer | Décalage de fin. |
Renvois
TextStyle : style de texte de la sous-chaîne donnée de cette valeur.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eRichTextValue\u003c/code\u003e objects represent stylized text within a spreadsheet cell, allowing substrings to have varied styles.\u003c/p\u003e\n"],["\u003cp\u003eText is broken into "runs," which are the longest continuous substrings sharing the same style.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRichTextValue\u003c/code\u003e class provides methods to access and manipulate text, styles, and links within these runs.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can retrieve individual runs, get/set text styles, and extract link URLs using dedicated methods.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003ecopy()\u003c/code\u003e, \u003ccode\u003egetText()\u003c/code\u003e, \u003ccode\u003egetRuns()\u003c/code\u003e, and \u003ccode\u003egetTextStyle()\u003c/code\u003e offer manipulation of \u003ccode\u003eRichTextValues\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class RichTextValue\n\nRichTextValue\n\nA stylized text string used to represent cell text. Substrings of the text can have different\ntext styles.\n\nA *run* is the longest unbroken substring having the same text style. For example, the\nsentence, \"This **child** *is carrying* apples\" has 4 runs: `['This ', 'child ',\n'is carrying ', 'apples']`. \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------------|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| [copy()](#copy()) | [RichTextValueBuilder](/apps-script/reference/spreadsheet/rich-text-value-builder) | Returns a builder for a Rich Text value initialized with the values of this Rich Text value. |\n| [getEndIndex()](#getEndIndex()) | `Integer` | Gets the end index of this value in the cell. |\n| [getLinkUrl()](#getLinkUrl()) | `String` | Returns the link URL for this value. |\n| [getLinkUrl(startOffset, endOffset)](#getLinkUrl(Integer,Integer)) | `String` | Returns the link URL for the text from `start``Offset` to `end``Offset`. |\n| [getRuns()](#getRuns()) | [RichTextValue[]](#) | Returns the Rich Text string split into an array of runs, wherein each run is the longest possible substring having a consistent text style. |\n| [getStartIndex()](#getStartIndex()) | `Integer` | Gets the start index of this value in the cell. |\n| [getText()](#getText()) | `String` | Returns the text of this value. |\n| [getTextStyle()](#getTextStyle()) | [TextStyle](/apps-script/reference/spreadsheet/text-style) | Returns the text style of this value. |\n| [getTextStyle(startOffset, endOffset)](#getTextStyle(Integer,Integer)) | [TextStyle](/apps-script/reference/spreadsheet/text-style) | Returns the text style of the text from `start``Offset` to `end``Offset`. |\n\nDetailed documentation\n----------------------\n\n### `copy()`\n\nReturns a builder for a Rich Text value initialized with the values of this Rich Text value.\n\n#### Return\n\n\n[RichTextValueBuilder](/apps-script/reference/spreadsheet/rich-text-value-builder) --- A builder for a Rich Text value.\n\n*** ** * ** ***\n\n### `get``End``Index()`\n\nGets the end index of this value in the cell.\n\n#### Return\n\n\n`Integer` --- The end index of this value in the cell.\n\n*** ** * ** ***\n\n### `get``Link``Url()`\n\nReturns the link URL for this value.\n\n#### Return\n\n\n`String` --- The link URL for this value, or `null` if there is no link or if there are\nmultiple different links.\n\n*** ** * ** ***\n\n### `get``Link``Url(startOffset, endOffset)`\n\nReturns the link URL for the text from `start``Offset` to `end``Offset`. Offsets are 0\nbased and relative to the cell's text, with the start offset being inclusive and the end offset\nbeing exclusive.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|-----------|-------------------|\n| `start``Offset` | `Integer` | The start offset. |\n| `end``Offset` | `Integer` | The end offset. |\n\n#### Return\n\n\n`String` --- The link URL for this value, or `null` if there is no link or if multiple\ndifferent links are in the given range.\n\n*** ** * ** ***\n\n### `get``Runs()`\n\nReturns the Rich Text string split into an array of runs, wherein each run is the longest\npossible substring having a consistent text style.\n\n#### Return\n\n\n[RichTextValue[]](#) --- An array of runs.\n\n*** ** * ** ***\n\n### `get``Start``Index()`\n\nGets the start index of this value in the cell.\n\n#### Return\n\n\n`Integer` --- The start index of this value in the cell.\n\n*** ** * ** ***\n\n### `get``Text()`\n\nReturns the text of this value.\n\n#### Return\n\n\n`String` --- The text of this value.\n\n*** ** * ** ***\n\n### `get``Text``Style()`\n\nReturns the text style of this value.\n\n#### Return\n\n\n[TextStyle](/apps-script/reference/spreadsheet/text-style) --- The text style of this value.\n\n*** ** * ** ***\n\n### `get``Text``Style(startOffset, endOffset)`\n\nReturns the text style of the text from `start``Offset` to `end``Offset`. Offsets are 0\nbased and relative to the cell's text, with the start offset being inclusive and the end offset\nbeing exclusive.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|-----------|-------------------|\n| `start``Offset` | `Integer` | The start offset. |\n| `end``Offset` | `Integer` | The end offset. |\n\n#### Return\n\n\n[TextStyle](/apps-script/reference/spreadsheet/text-style) --- The text style of the given substring of this value."]]
