Class RichTextValue

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

Methods

Method	Return type	Brief description
`copy()`	`RichTextValueBuilder`	Returns a builder for a Rich Text value initialized with the values of this Rich Text value.
`getEndIndex()`	`Integer`	Gets the end index of this value in the cell.
`getLinkUrl()`	`String`	Returns the link URL for this value.
`getLinkUrl(startOffset, endOffset)`	`String`	Returns the link URL for the text from `startOffset` to `endOffset` .
`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.
`getStartIndex()`	`Integer`	Gets the start index of this value in the cell.
`getText()`	`String`	Returns the text of this value.
`getTextStyle()`	`TextStyle`	Returns the text style of this value.
`getTextStyle(startOffset, endOffset)`	`TextStyle`	Returns the text style of the text from `startOffset` to `endOffset` .

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.