このページは Cloud Translation API によって翻訳されました。

Class RichTextValueBuilder

リッチテキスト値のビルダー。

メソッド

メソッド	戻り値の型	概要
`build()`	`RichTextValue`	このビルダーからリッチテキスト値を作成します。
`setLinkUrl(startOffset, endOffset, linkUrl)`	`RichTextValueBuilder`	この値の指定された部分文字列のリンク URL を設定するか、`linkUrl` である場合はクリアします `null`。
`setLinkUrl(linkUrl)`	`RichTextValueBuilder`	値全体のリンク URL を設定するか、`linkUrl` が `null` の場合はクリアします。
`setText(text)`	`RichTextValueBuilder`	この値のテキストを設定し、既存のテキストスタイルをクリアします。
`setTextStyle(startOffset, endOffset, textStyle)`	`RichTextValueBuilder`	この値の指定された部分文字列にテキストスタイルを適用します。
`setTextStyle(textStyle)`	`RichTextValueBuilder`	値全体にテキストスタイルを適用します。

詳細なドキュメント

`build()`

このビルダーからリッチテキスト値を作成します。

戻る

RichTextValue - このビルダーから作成されたリッチテキスト値。

`setLinkUrl(startOffset, endOffset, linkUrl)`

この値の指定された部分文字列のリンク URL を設定するか、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`	設定するリンク URL。

戻る

RichTextValueBuilder - チェーン用のビルダー。

`setLinkUrl(linkUrl)`

値全体のリンク URL を設定するか、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`	設定するリンク URL。

戻る

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 - チェーン用のビルダー。