Class TextRange

Диапазон текста

Фрагмент текстового содержимого Shape или Table Cell .

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

Методы

Метод Тип возврата Краткое описание
append Paragraph(text) Paragraph Добавляет абзац в конец текстового диапазона.
append Range(textRange) Text Range Добавляет копию предоставленного текстового диапазона в конец текущего текстового диапазона.
append Range(textRange, matchSourceFormatting) Text Range Добавляет копию предоставленного текстового диапазона в конец текущего текстового диапазона.
append Text(text) Text Range Добавляет текст в конец текстового диапазона.
as Rendered String() String Возвращает визуализированный текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы, в формате, подходящем для отображения конечным пользователям.
as String() String Возвращает необработанный текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы.
clear() void Очищает текст, ограниченный этим диапазоном.
clear(startOffset, endOffset) void Очищает текст, ограниченный начальным и конечным смещениями в диапазоне.
find(pattern) Text Range[] Возвращает все диапазоны, соответствующие шаблону поиска в текущем текстовом диапазоне.
find(pattern, startOffset) Text Range[] Возвращает все диапазоны, соответствующие шаблону поиска в текущем текстовом диапазоне, начиная с начального смещения.
get Auto Texts() Auto Text[] Возвращает автоматические тексты в текущем текстовом диапазоне.
get End Index() Integer Возвращает исключительный индекс, начинающийся с 0, для последнего символа в этом диапазоне.
get Length() Integer Возвращает количество символов в этом диапазоне.
get Links() Text Range[] Возвращает коллекцию текстовых диапазонов, соответствующих всем Link в текущем текстовом диапазоне или перекрывающим текущий текстовый диапазон.
get List Paragraphs() Paragraph[] Возвращает абзацы в списках, которые перекрывают текущий текстовый диапазон.
get List Style() List Style Возвращает List Style текущего текстового диапазона.
get Paragraph Style() Paragraph Style Возвращает Paragraph Style текущего текстового диапазона.
get Paragraphs() Paragraph[] Возвращает абзацы, которые перекрывают текущий текстовый диапазон.
get Range(startOffset, endOffset) Text Range Возвращает новый Text Range , охватывающий часть диапазона, из которого он был получен.
get Runs() Text Range[] Возвращает текстовые фрагменты, перекрывающие текущий текстовый диапазон.
get Start Index() Integer Возвращает включительный индекс (начинающийся с 0) для первого символа в данном диапазоне.
get Text Style() Text Style Возвращает стиль текста диапазона или null , если диапазон пуст.
insert Paragraph(startOffset, text) Paragraph Вставляет абзац в начальное смещение.
insert Range(startOffset, textRange) Text Range Вставляет копию указанного текстового диапазона в начальное смещение.
insert Range(startOffset, textRange, matchSourceFormatting) Text Range Вставляет копию указанного текстового диапазона в начальное смещение.
insert Text(startOffset, text) Text Range Вставляет текст в начальное смещение.
is Empty() Boolean Возвращает true если в этом диапазоне нет символов, в противном случае возвращает false .
replace All Text(findText, replaceText) Integer Заменяет все вхождения текста, соответствующего найденному тексту, на заменяемый текст.
replace All Text(findText, replaceText, matchCase) Integer Заменяет все вхождения текста, соответствующего найденному тексту, на заменяемый текст.
select() void Выбирает только Text Range в активной презентации и удаляет любое предыдущее выделение.
set Text(newText) Text Range Задает текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы.

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

append Paragraph(text)

Добавляет абзац в конец текстового диапазона. Абзац сохраняет стиль конца текущего текстового диапазона.

Предоставленная текстовая строка добавляется как абзац путем добавления к строке по крайней мере одного окружающего ее символа новой строки.

Если предоставленная текстовая строка содержит символы новой строки (состоя, таким образом, из нескольких абзацев), возвращается последний добавленный абзац.

Параметры

Имя Тип Описание
text String Строка, добавляемая как абзац.

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

Paragraph — Прикрепленный Paragraph .

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

append Range(textRange)

Добавляет копию предоставленного текстового диапазона в конец текущего текстового диапазона.

Форматирование вставленного текста соответствует форматированию исходного текста.

Параметры

Имя Тип Описание
text Range Text Range Диапазон текста для добавления.

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

Text Range — диапазон текста, представляющий добавляемый текст.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

append Range(textRange, matchSourceFormatting)

Добавляет копию предоставленного текстового диапазона в конец текущего текстового диапазона.

Если задано соответствие форматированию конечного текста, Auto Text в указанном текстовом диапазоне заменяется своими визуализированными значениями. Более того, любые нетекстовые элементы в указанном текстовом диапазоне не добавляются.

Параметры

Имя Тип Описание
text Range Text Range Диапазон текста для добавления.
match Source Formatting Boolean Если true , соответствует форматированию исходного текста; если false , соответствует форматированию целевого текста.

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

Text Range — диапазон текста, представляющий добавляемый текст.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

append Text(text)

Добавляет текст в конец текстового диапазона. Текст сохраняет стиль окончания существующего текста.

Параметры

Имя Тип Описание
text String Строка для добавления.

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

Text Range — диапазон текста, представляющий добавляемый текст.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

as Rendered String()

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

Элементы автотекста, такие как сгенерированные номера слайдов, заменяются их визуализированными значениями. Любые нетекстовые элементы в диапазоне опускаются.

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

String — отображаемый текст в диапазоне.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

as String()

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

Элементы Auto Text, такие как сгенерированные номера слайдов и любые нетекстовые элементы в диапазоне, заменяются символом Unicode U+E907.

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

String — необработанный текст в диапазоне.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

clear()

Очищает текст, ограниченный этим диапазоном.

Поскольку весь текст в Shape или TableCell должен заканчиваться новой строкой, последняя новая строка в тексте не удаляется.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

clear(startOffset, endOffset)

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

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

Параметры

Имя Тип Описание
start Offset Integer Количество символов после начального индекса текущего текстового диапазона, используемое для определения начального индекса очищаемого диапазона (включительно). Начальное смещение должно быть равно или больше 0 и меньше или равно end Offset . start Offset также должно быть меньше длины текущего диапазона.
end Offset Integer Количество символов после начального индекса текущего текстового диапазона, используемое для определения конечного индекса очищаемого диапазона. end Offset должно быть равно или больше start Offset . end Offset также должно быть меньше или равно длине текущего диапазона.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

find(pattern)

Возвращает все диапазоны, соответствующие шаблону поиска в текущем текстовом диапазоне. Поиск чувствителен к регистру.

Параметры

Имя Тип Описание
pattern String Шаблон регулярного выражения для поиска; любые обратные косые черты в шаблоне должны быть экранированы.

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

Text Range[] — список текстовых диапазонов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

find(pattern, startOffset)

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

Параметры

Имя Тип Описание
pattern String Шаблон регулярного выражения для поиска; любые обратные косые черты в шаблоне должны быть экранированы.
start Offset Integer Число символов после начального индекса текущего текстового диапазона, используемое для определения включительного начального индекса диапазона для поиска. start Offset также должно быть меньше длины текущего диапазона.

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

Text Range[] — список текстовых диапазонов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Auto Texts()

Возвращает автоматические тексты в текущем текстовом диапазоне.

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

Auto Text[] — Список автотекстов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get End Index()

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

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

Integer — конечный индекс диапазона.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Length()

Возвращает количество символов в этом диапазоне.

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

Integer — количество символов в этом диапазоне.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

Возвращает коллекцию текстовых диапазонов, соответствующих всем Link в текущем текстовом диапазоне или перекрывающим текущий текстовый диапазон.

Каждый возвращаемый диапазон при создании гарантированно охватывает одну ссылку. Изменение текста может привести к тому, что он перестанет представлять собой только одну ссылку.

Доступ к каждой Link в возвращаемых диапазонах можно получить через Text Style.getLink() .

// Accesses the first link on a TextRange object.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
const linkTextRange = textRange.getLinks()[0];
const textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink());   // logs 'true'
const link = textStyle.getLink();  // Link object

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

Text Range[] — список текстовых диапазонов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get List Paragraphs()

Возвращает абзацы в списках, которые перекрывают текущий текстовый диапазон.

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

Paragraph[] — Список абзацев в списках.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get List Style()

Возвращает List Style текущего текстового диапазона.

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

List Style — стиль списка текущего текстового диапазона.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Paragraph Style()

Возвращает Paragraph Style текущего текстового диапазона.

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

Paragraph Style — стиль абзаца текущего текстового диапазона.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Paragraphs()

Возвращает абзацы, которые перекрывают текущий текстовый диапазон.

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

Paragraph[] — Список абзацев.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Range(startOffset, endOffset)

Возвращает новый Text Range , охватывающий часть диапазона, из которого он был получен.

Параметры

Имя Тип Описание
start Offset Integer Количество символов после начального индекса текущего текстового диапазона, используемое для определения включительного начального индекса возвращаемого диапазона. Начальное смещение должно быть равно или больше 0 и меньше или равно end Offset . start Offset также должно быть меньше длины текущего диапазона.
end Offset Integer Количество символов после начального индекса текущего текстового диапазона, используемое для определения эксклюзивного конечного индекса возвращаемого диапазона. end Offset должно быть равно или больше start Offset . end Offset также должно быть меньше или равно длине текущего диапазона.

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

Text Range — новый текстовый диапазон.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Runs()

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

Каждый возвращаемый диапазон гарантированно охватывает только один цикл при его создании. Изменения текста или стиля могут привести к тому, что он больше не будет представлять собой один цикл.

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

Text Range[] — список текстовых диапазонов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Start Index()

Возвращает индекс первого символа в диапазоне (включительно, начиная с 0). Если начальный и конечный индексы равны, диапазон считается пустым.

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

Integer — начальный индекс диапазона.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

get Text Style()

Возвращает стиль текста диапазона или null , если диапазон пуст.

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

Text Style — стиль текста диапазона.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insert Paragraph(startOffset, text)

Вставляет абзац с начальным смещением. Абзац сохраняет стиль текущего текстового диапазона с начальным смещением.

Предоставленная текстовая строка вставляется как абзац путем добавления к строке по крайней мере одного окружающего ее символа новой строки.

Если предоставленная текстовая строка содержит символы новой строки (состоя, таким образом, из нескольких абзацев), возвращается последний добавленный абзац.

Параметры

Имя Тип Описание
start Offset Integer Число символов после начального индекса текущего текстового диапазона, используемое для определения включающего начального индекса текста для вставки.
text String Строка для вставки.

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

Paragraph — Вставленный Paragraph .

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insert Range(startOffset, textRange)

Вставляет копию указанного текстового диапазона в начальное смещение.

Форматирование вставленного текста соответствует форматированию исходного текста.

Параметры

Имя Тип Описание
start Offset Integer Число символов после начального индекса текущего текстового диапазона, используемое для определения включающего начального индекса текста для вставки.
text Range Text Range Диапазон текста для вставки.

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

Text Range — диапазон текста, представляющий вставленный текст.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insert Range(startOffset, textRange, matchSourceFormatting)

Вставляет копию указанного текстового диапазона в начальное смещение.

Если задано соответствие форматированию конечного текста, Auto Text в указанном текстовом диапазоне заменяется своими визуализированными значениями. Кроме того, любые нетекстовые элементы в указанном текстовом диапазоне не вставляются.

Параметры

Имя Тип Описание
start Offset Integer Число символов после начального индекса текущего текстового диапазона, используемое для определения включающего начального индекса текста для вставки.
text Range Text Range Диапазон текста для вставки.
match Source Formatting Boolean Если true , соответствует форматированию исходного текста; если false , соответствует форматированию целевого текста.

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

Text Range — диапазон текста, представляющий вставленный текст.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insert Text(startOffset, text)

Вставляет текст с начальным смещением. Текст сохраняет стиль существующего текста с начальным смещением.

Параметры

Имя Тип Описание
start Offset Integer Число символов после начального индекса текущего текстового диапазона, используемое для определения включающего начального индекса текста для вставки.
text String Строка для вставки.

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

Text Range — диапазон текста, представляющий вставленный текст.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

is Empty()

Возвращает true если в этом диапазоне нет символов, в противном случае возвращает false .

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

Boolean — true , если в этом диапазоне нет символов, в противном случае возвращает false .

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

replace All Text(findText, replaceText)

Заменяет все вхождения текста, соответствующего фразе «найти», на «заменить». Поиск нечувствителен к регистру.

Параметры

Имя Тип Описание
find Text String Текст, который нужно найти.
replace Text String Текст, которым следует заменить совпадающий текст.

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

Integer — количество измененных вхождений

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

replace All Text(findText, replaceText, matchCase)

Заменяет все вхождения текста, соответствующего найденному тексту, на заменяемый текст.

Параметры

Имя Тип Описание
find Text String Текст, который нужно найти.
replace Text String Текст, которым следует заменить совпадающий текст.
match Case Boolean Если true , поиск чувствителен к регистру; если false , поиск нечувствителен к регистру.

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

Integer — количество измененных вхождений

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select()

Выбирает только Text Range в активной презентации и удаляет любое предыдущее выделение.

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

Родительская Page соответствующей Shape или Table Cell устанавливается в качестве current page selection . Shape или Table Cell устанавливается в качестве selected page element .

    Selection может быть двух типов:
    • 1. Диапазон текста. Используйте select для непустого TextRange, чтобы выбрать диапазон символов.
    • 2. Позиция курсора. Используйте пустой TextRange, чтобы поместить курсор в нужную позицию. 
      const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
shape.getText().setText('Hello');
// Range selection: Select the text range "He".
shape.getText().getRange(0, 2).select();
// Cursor selection: Place the cursor after "H" like "H|ello".
shape.getText().getRange(1, 1).select();

      Авторизация

      Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

      • https://www.googleapis.com/auth/presentations.currentonly
      • https://www.googleapis.com/auth/presentations

    set Text(newText)

    Задаёт текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы. Текст сохраняет стиль начала существующего текста.

    Параметры

    Имя Тип Описание
    new Text String Строка, которую необходимо установить в качестве нового текста.

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

    Text Range — диапазон текста, представляющий заданный текст.

    Авторизация

    Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

    • https://www.googleapis.com/auth/presentations.currentonly
    • https://www.googleapis.com/auth/presentations