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 Возвращает стиль текста диапазона или 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()

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

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

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

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

Авторизация

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

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

clear()

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

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

Авторизация

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

  • 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 |null — Стиль текста диапазона.

Авторизация

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

  • 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 в активной презентации и удаляет любое предыдущее выделение.

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

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

    Selection может быть двух типов:
    • 1. Диапазон текста: используйте функцию выделения непустого текстового диапазона (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