Class RichTextValue

RichTextValue

一种用于表示单元格文本的样式化文本字符串。文本的子字符串可以具有不同的文本样式。

一个 run 是具有相同文本样式的最长不间断子字符串。例如， 句子“This child is carrying apples”包含 4 个 run：['This ', 'child ', 'is carrying ', 'apples']。

方法

方法	返回值类型	简介
copy()	RichTextValueBuilder	返回一个 Rich Text 值的构建器，该构建器使用此 Rich Text 值的值进行初始化。
getEndIndex()	Integer	获取此值在单元格中的结束索引。
getLinkUrl()	String|null	返回此值的链接网址。
getLinkUrl(startOffset, endOffset)	String|null	返回从 startOffset 到 endOffset 的文本的链接网址。
getRuns()	RichTextValue[]	返回拆分为 run 数组的 Rich Text 字符串，其中每个 run 都是具有一致文本样式的最长可能子字符串。
getStartIndex()	Integer	获取此值在单元格中的起始索引。
getText()	String	返回此值的文本。
getTextStyle()	TextStyle	返回此值的文本样式。
getTextStyle(startOffset, endOffset)	TextStyle	返回从 startOffset 到 endOffset 的文本样式。

详细文档

copy()

返回一个 Rich Text 值的构建器，该构建器使用此 Rich Text 值的值进行初始化。

返回

RichTextValueBuilder - Rich Text 值的构建器。

---

getEndIndex()

获取此值在单元格中的结束索引。

返回

Integer - 此值在单元格中的结束索引。

---

getLinkUrl()

返回此值的链接网址。

返回

String|null - 此值的链接网址；如果没有链接或有多个不同的链接，则返回 null。

---

getLinkUrl(startOffset, endOffset)

返回从 startOffset 到 endOffset 的文本的链接网址。偏移量从 0 开始，相对于单元格的文本，起始偏移量包含边界值，结束偏移量不包含边界值。

参数

名称	类型	说明
startOffset	Integer	起始偏移量。
endOffset	Integer	结束偏移量。

返回

String|null - 此值的链接网址；如果给定范围内没有链接或有多个 不同的链接，则返回 null。

---

getRuns()

返回拆分为 run 数组的 Rich Text 字符串，其中每个 run 都是具有一致文本样式的最长可能子字符串。

返回

RichTextValue[] - run 数组。

---

getStartIndex()

获取此值在单元格中的起始索引。

返回

Integer - 此值在单元格中的起始索引。

---

getText()

返回此值的文本。

返回

String - 此值的文本。

---

getTextStyle()

返回此值的文本样式。

返回

TextStyle - 此值的文本样式。

---

getTextStyle(startOffset, endOffset)

返回从 startOffset 到 endOffset 的文本样式。偏移量从 0 开始，相对于单元格的文本，起始偏移量包含边界值，结束偏移量不包含边界值。

参数

名称	类型	说明
startOffset	Integer	起始偏移量。
endOffset	Integer	结束偏移量。

返回

TextStyle - 此值的给定子字符串的文本样式。