A builder for Rich Text values.
Methods
Method | Return type | Brief description |
---|---|---|
Rich
|
Creates a Rich Text value from this builder. | |
Rich
|
Sets the link URL for the given substring of this value, or clears it if link
is null
. |
|
Rich
|
Sets the link URL for the entire value, or clears it if link
is null
. |
|
Rich
|
Sets the text for this value and clears any existing text style. | |
Rich
|
Applies a text style to the given substring of this value. | |
Rich
|
Applies a text style to the entire value. |
Detailed documentation
build()
Creates a Rich Text value from this builder.
Return
Rich
— A Rich Text value created from this builder.
set
Link
Url(startOffset, endOffset, linkUrl)
Sets the link URL for the given substring of this value, or clears it if link
is 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 ();
Parameters
Name | Type |
---|---|
start
|
Integer
|
Description : The start offset for the substring, inclusive. | |
end
|
Integer
|
Description : The end offset for the substring, exclusive. | |
link
|
String
|
Description : The link URL being set. |
Return
Rich
— This builder, for chaining.
set
Link
Url(linkUrl)
Sets the link URL for the entire value, or clears it if link
is 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 ();
Parameters
Name | Type |
---|---|
link
|
String
|
Description : The link URL being set. |
Return
Rich
— This builder, for chaining.
set
Text(text)
Sets the text for this value and clears any existing text style. When creating a new Rich Text
value, this should be called before set
.
Parameters
Name | Type |
---|---|
text
|
String
|
Description : The text for this value. |
Return
Rich
— This builder, for chaining.
set
Text
Style(startOffset, endOffset, textStyle)
Applies a text style to the given substring of this value. Offsets are 0 based and are relative
to the cell's text value. Does nothing if text
is 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 ();
Parameters
Name | Type | Description |
---|---|---|
start
|
Integer
|
The start offset for the substring, inclusive. |
end
|
Integer
|
The end offset for the substring, exclusive. |
text
|
Text
|
The text style being set. |
Return
Rich
— This builder, for chaining.
set
Text
Style(textStyle)
Applies a text style to the entire value. Previously set text styles are only affected if they
are directly overwritten by values within text
. Does nothing if text
is 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 ();
Parameters
Name | Type |
---|---|
text
|
Text
|
Description : The text style being set. |
Return
Rich
— This builder, for chaining.