Class RichTextValue
Stay organized with collections
Save and categorize content based on your preferences.
RichTextValue
A stylized text string used to represent cell text. Substrings of the text can have different
text styles.
A run is the longest unbroken substring having the same text style. For example, the
sentence, "This child is carrying apples" has 4 runs: ['This ', 'child ',
'is carrying ', 'apples'].
Detailed documentation
copy()
Returns a builder for a Rich Text value initialized with the values of this Rich Text value.
Return
RichTextValueBuilder — A builder for a Rich Text value.
getEndIndex()
Gets the end index of this value in the cell.
Return
Integer — The end index of this value in the cell.
getLinkUrl()
Returns the link URL for this value.
Return
String — The link URL for this value, or null if there is no link or if there are
multiple different links.
getLinkUrl(startOffset, endOffset)
Returns the link URL for the text from startOffset to endOffset. Offsets are 0
based and relative to the cell's text, with the start offset being inclusive and the end offset
being exclusive.
Parameters
| Name | Type | Description |
startOffset | Integer | The start offset. |
endOffset | Integer | The end offset. |
Return
String — The link URL for this value, or null if there is no link or if multiple
different links are in the given range.
getRuns()
Returns the Rich Text string split into an array of runs, wherein each run is the longest
possible substring having a consistent text style.
Return
RichTextValue[] — An array of runs.
getStartIndex()
Gets the start index of this value in the cell.
Return
Integer — The start index of this value in the cell.
getText()
Returns the text of this value.
Return
String — The text of this value.
getTextStyle()
Returns the text style of this value.
Return
TextStyle — The text style of this value.
getTextStyle(startOffset, endOffset)
Returns the text style of the text from startOffset to endOffset. Offsets are 0
based and relative to the cell's text, with the start offset being inclusive and the end offset
being exclusive.
Parameters
| Name | Type | Description |
startOffset | Integer | The start offset. |
endOffset | Integer | The end offset. |
Return
TextStyle — The text style of the given substring of this value.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[null,null,["Last updated 2024-12-03 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."]]
