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

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

Элементы автоматического текста, такие как сгенерированные номера слайдов и любые нетекстовые элементы в диапазоне, заменяются символом Юникода 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

Авторизация

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

  • 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