Class RichTextValueBuilder

富文本值构建器

富文本值的构建器。

方法

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

详细文档

build()

使用此构建器创建富文本值。

返回

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();

参数

名称类型说明
startOffsetInteger子字符串的起始偏移量（包括该偏移量）。
endOffsetInteger子字符串的结束偏移量（不含此偏移量）。
linkUrlString要设置的链接网址。

返回

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();

参数

名称类型说明
linkUrlString要设置的链接网址。

返回

RichTextValueBuilder - 此构建器，用于链式调用。

setText(text)

为此值设置文本，并清除所有现有文本样式。创建新的富文本值时，应先调用此方法，然后再调用 setTextStyle(startOffset, endOffset, textStyle)。

参数

名称类型说明
textString此值对应的文本。

返回

RichTextValueBuilder - 此构建器，用于链式调用。

setTextStyle(startOffset, endOffset, textStyle)

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

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

参数

名称类型说明
startOffsetInteger子字符串的起始偏移量（包括该偏移量）。
endOffsetInteger子字符串的结束偏移量（不含此偏移量）。
textStyleTextStyle要设置的文本样式。

返回

RichTextValueBuilder - 此构建器，用于链式调用。

setTextStyle(textStyle)

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

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

参数

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

返回

RichTextValueBuilder - 此构建器，用于链式调用。