Class RichTextValueBuilder

RichTextValueBuilder

富文本值的构建器。

方法

方法	返回类型	简介
build()	RichTextValue	通过此构建器创建 RTF 值。
setLinkUrl(startOffset, endOffset, linkUrl)	RichTextValueBuilder	设置此值的指定子字符串的链接网址，如果 linkUrl 为 null。
setLinkUrl(linkUrl)	RichTextValueBuilder	设置整个值的链接网址；如果 linkUrl 为 null，则清除该网址。
setText(text)	RichTextValueBuilder	设置此值的文本并清除所有现有文本样式。
setTextStyle(startOffset, endOffset, textStyle)	RichTextValueBuilder	将文本样式应用于此值的给定子字符串。
setTextStyle(textStyle)	RichTextValueBuilder	将文本样式应用于整个值。

详细文档

build()

通过此构建器创建 RTF 值。

返回

RichTextValue - 通过此构建器创建的富文本值。

---

setLinkUrl(startOffset, endOffset, linkUrl)

设置此值的指定子字符串的链接网址，如果 linkUrl 为 null。

// Creates a Rich Text value for the text "foo no baz" with "foo" pointing to
// "https://bar.foo" and "baz" to "https://abc.xyz".
// "foo" is underlined with the default link color, whereas "baz" has its text style
// overridden by a call to `setTextStyle`, and is therefore black and bold with no underlining.
const boldStyle = SpreadsheetApp.newTextStyle()
    .setUnderline(false)
    .setBold(true)
    .setForegroundColor("#000000")
    .build();
const value = SpreadsheetApp.newRichTextValue()
    .setText("foo no baz")
    .setLinkUrl(0, 3, "https://bar.foo")
    .setLinkUrl(7, 10, "https://abc.xyz")
    .setTextStyle(7, 10, boldStyle)
    .build();

参数

名称	类型	说明
startOffset	Integer	子字符串的起始偏移量（含边界值）。
endOffset	Integer	子字符串的结束偏移量（不含）。
linkUrl	String	正在设置的链接网址。

返回

RichTextValueBuilder - 此构建器，用于链接。

---

setLinkUrl(linkUrl)

设置整个值的链接网址；如果 linkUrl 为 null，则清除该网址。

// Creates a Rich Text value for the text "Foo" which points to "https://bar.foo".
const value = SpreadsheetApp.newRichTextValue()
    .setText("Foo")
    .setLinkUrl("https://bar.foo")
    .build();

参数

名称	类型	说明
linkUrl	String	正在设置的链接网址。

返回

RichTextValueBuilder - 此构建器，用于链接。

---

setText(text)

设置此值的文本并清除所有现有文本样式。创建新的富文本时 值，应在 setTextStyle(startOffset, endOffset, textStyle) 之前调用。

参数

名称	类型	说明
text	String	此值的文本。

返回

RichTextValueBuilder - 此构建器，用于链接。

---

setTextStyle(startOffset, endOffset, textStyle)

将文本样式应用于此值的给定子字符串。偏移量以 0 为起点，是相对的 单元格的文本值。如果 textStyle 为 null，则不执行任何操作。

// Creates a Rich Text value for the text "HelloWorld", with "Hello" bolded, and "World"
// italicized.
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("HelloWorld")
    .setTextStyle(0, 5, bold)
    .setTextStyle(5, 10, italic)
    .build();

参数

名称	类型	说明
startOffset	Integer	子字符串的起始偏移量（含边界值）。
endOffset	Integer	子字符串的结束偏移量（不含）。
textStyle	TextStyle	要设置的文本样式。

返回

RichTextValueBuilder - 此构建器，用于链接。

---

setTextStyle(textStyle)

将文本样式应用于整个值。只有在以下情况下，之前设置的文本样式才会受到影响： 会被 textStyle 中的值直接覆盖。如果 textStyle，则不执行任何操作 为 null。

// Creates a Rich Text value for the text "HelloWorld" with "Hello" bolded and italicized,
// and "World" only italicized.
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("HelloWorld")
    .setTextStyle(0, 5, bold)
    .setTextStyle(italic)
    .build();

参数

名称	类型	说明
textStyle	TextStyle	要设置的文本样式。

返回

RichTextValueBuilder - 此构建器，用于链接。