Class RichTextValueBuilder

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 с помощью этого конструктора.

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

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();

Параметры

Имя Тип Описание
start Offset Integer Начальное смещение для подстроки включительно.
end Offset Integer Конечное смещение для подстроки, исключая его.
link Url 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();

Параметры

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

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

RichTextValueBuilder — этот конструктор предназначен для создания цепочек вызовов.

setText(text)

Устанавливает текст для этого значения и удаляет все существующие стили текста. При создании нового значения в формате Rich 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.
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 Устанавливаемый стиль текста.

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

RichTextValueBuilder — этот конструктор предназначен для создания цепочек вызовов.

setTextStyle(textStyle)

Применяет стиль текста ко всему значению. Ранее установленные стили текста изменяются только в том случае, если они напрямую перезаписываются значениями в textStyle . Ничего не делает, если textStyle равен 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 Устанавливаемый стиль текста.

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

RichTextValueBuilder — этот конструктор предназначен для создания цепочек вызовов.