Class RichTextValue

Значение форматированного текста

Стилизованная текстовая строка, используемая для представления текста в ячейке. Подстроки текста могут иметь разные стили.

Подстрока — это самая длинная непрерывная подстрока, имеющая одинаковый стиль текста. Например, предложение "This child is carrying apples" содержит 4 подстроки: ['This ', 'child ', 'is carrying ', 'apples'] .

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Rich Text Value Builder Возвращает конструктор для значения форматированного текста, инициализированный значениями этого значения форматированного текста.
get End Index() Integer Получает конечный индекс этого значения в ячейке.
get Link Url() String|null Возвращает URL-адрес ссылки для этого значения.
get Link Url(startOffset, endOffset) String|null Возвращает URL-адрес ссылки для текста от start Offset до end Offset .
get Runs() Rich Text Value[] Возвращает строку форматированного текста, разделенную на массив фрагментов, где каждый фрагмент представляет собой максимально длинную подстроку, имеющую согласованный стиль текста.
get Start Index() Integer Получает начальный индекс данного значения в ячейке.
get Text() String Возвращает текст этого значения.
get Text Style() Text Style Возвращает стиль текста данного значения.
get Text Style(startOffset, endOffset) Text Style Возвращает стиль текста от start Offset до end Offset .

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

copy()

Возвращает конструктор для значения форматированного текста, инициализированный значениями этого значения форматированного текста.

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

Rich Text Value Builder — инструмент для создания значений форматированного текста.


get End Index()

Получает конечный индекс этого значения в ячейке.

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

Integer — конечный индекс этого значения в ячейке.


get Link Url()

Возвращает URL-адрес ссылки для этого значения.

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

String|null — URL-адрес ссылки для этого значения или null , если ссылки нет или если существует несколько разных ссылок.


get Link Url(startOffset, endOffset)

Возвращает URL-адрес ссылки для текста от start Offset до end Offset . Смещения отсчитываются от 0 и являются относительными по отношению к тексту ячейки, при этом начальное смещение включается, а конечное — исключается.

Параметры

Имя Тип Описание
start Offset Integer Начальное смещение.
end Offset Integer Конечное смещение.

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

String|null — URL-адрес ссылки для этого значения или null , если ссылки нет или если в заданном диапазоне находится несколько разных ссылок.


get Runs()

Возвращает строку форматированного текста, разделенную на массив фрагментов, где каждый фрагмент представляет собой максимально длинную подстроку, имеющую согласованный стиль текста.

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

Rich Text Value[] — массив результатов выполнения.


get Start Index()

Получает начальный индекс данного значения в ячейке.

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

Integer — начальный индекс этого значения в ячейке.


get Text()

Возвращает текст этого значения.

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

String — Текст данного значения.


get Text Style()

Возвращает стиль текста данного значения.

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

Text Style — Стиль текста для данного значения.


get Text Style(startOffset, endOffset)

Возвращает стиль текста от start Offset до end Offset . Смещения отсчитываются от 0 и являются относительными по отношению к тексту ячейки, при этом начальное смещение включается, а конечное — исключается.

Параметры

Имя Тип Описание
start Offset Integer Начальное смещение.
end Offset Integer Конечное смещение.

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

Text Style — стиль текста для заданной подстроки этого значения.