Class RichTextValueBuilder

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

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

Методы

Метод Тип возврата Краткое описание
build() Rich Text Value Создает значение Rich Text из этого построителя.
set Link Url(startOffset, endOffset, linkUrl) Rich Text Value Builder Устанавливает URL-адрес ссылки для данной подстроки этого значения или очищает его, если link Url имеет null .
set Link Url(linkUrl) Rich Text Value Builder Устанавливает URL-адрес ссылки для всего значения или очищает его, если link Url имеет null .
set Text(text) Rich Text Value Builder Устанавливает текст для этого значения и удаляет любой существующий текстовый стиль.
set Text Style(startOffset, endOffset, textStyle) Rich Text Value Builder Применяет стиль текста к заданной подстроке этого значения.
set Text Style(textStyle) Rich Text Value Builder Применяет стиль текста ко всему значению.

Подробная документация

build()

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

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

Rich Text Value — значение форматированного текста, созданное с помощью этого построителя.

set Link Url(startOffset, endOffset, linkUrl)

Устанавливает URL-адрес ссылки для данной подстроки этого значения или очищает его, если link Url имеет 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();

Параметры

Имя Тип Описание
start Offset Integer Начальное смещение подстроки включительно.
end Offset Integer Конечное смещение подстроки, исключающее.
link Url String Устанавливается URL-адрес ссылки.

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

Rich Text Value Builder . Этот построитель предназначен для создания цепочек.

set Link Url(linkUrl)

Устанавливает URL-адрес ссылки для всего значения или очищает его, если link Url имеет 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();

Параметры

Имя Тип Описание
link Url String Устанавливается URL-адрес ссылки.

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

Rich Text Value Builder . Этот построитель предназначен для создания цепочек.

set Text(text)

Устанавливает текст для этого значения и удаляет любой существующий текстовый стиль. При создании нового значения форматированного текста его следует вызывать перед set Text Style(startOffset, endOffset, textStyle) .

Параметры

Имя Тип Описание
text String Текст этого значения.

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

Rich Text Value Builder . Этот построитель предназначен для создания цепочек.

set Text Style(startOffset, endOffset, textStyle)

Применяет стиль текста к заданной подстроке этого значения. Смещения основаны на 0 и относятся к текстовому значению ячейки. Ничего не делает, если text Style имеет 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();

Параметры

Имя Тип Описание
start Offset Integer Начальное смещение подстроки включительно.
end Offset Integer Конечное смещение подстроки, исключающее.
text Style Text Style Устанавливаемый стиль текста.

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

Rich Text Value Builder . Этот построитель предназначен для создания цепочек.

set Text Style(textStyle)

Применяет стиль текста ко всему значению. Ранее установленные стили текста будут затронуты только в том случае, если они напрямую перезаписаны значениями в text Style . Ничего не делает, если text Style имеет 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();

Параметры

Имя Тип Описание
text Style Text Style Устанавливаемый стиль текста.

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

Rich Text Value Builder . Этот построитель предназначен для создания цепочек.