RTF 格式的建構工具。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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()
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)
設定這個值的文字,並清除任何現有的文字樣式。建立新的 RTF 格式時
值,應在 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
:這個建構工具用於鏈結。