Class RichTextValueBuilder

RichTextValueBuilder

Построитель значений форматированного текста.

Методы

Метод Тип возврата Краткое описание
build() RichTextValue Создает значение Rich Text из этого построителя.
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()

Создает значение Rich Text из этого построителя.

Возвращаться

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 — этот построитель для создания цепочек.