Class TextRange

Текстовый диапазон

Сегмент текстового содержимого Shape или TableCell .

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

Методы

Метод Тип возврата Краткое описание
appendParagraph(text) Paragraph Добавляет абзац в конец диапазона текста.
appendRange(textRange) TextRange Добавляет копию предоставленного текстового диапазона в конец текущего текстового диапазона.
appendRange(textRange, matchSourceFormatting) TextRange Добавляет копию предоставленного текстового диапазона в конец текущего текстового диапазона.
appendText(text) TextRange Добавляет текст в конец текстового диапазона.
asRenderedString() String Возвращает отображаемый текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы, в формате, подходящем для отображения конечным пользователям.
asString() String Возвращает необработанный текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы.
clear() void Очищает текст, ограниченный этим диапазоном.
clear(startOffset, endOffset) void Очищает текст, ограниченный начальным и конечным смещениями в диапазоне.
find(pattern) TextRange[] Возвращает все диапазоны, соответствующие шаблону поиска в текущем текстовом диапазоне.
find(pattern, startOffset) TextRange[] Возвращает все диапазоны, соответствующие шаблону поиска в текущем текстовом диапазоне, начиная с начального смещения.
getAutoTexts() AutoText[] Возвращает автоматические тексты в пределах текущего диапазона текста.
getEndIndex() Integer Возвращает эксклюзивный индекс, начинающийся с 0, для последнего символа в этом диапазоне.
getLength() Integer Возвращает количество символов в этом диапазоне.
getLinks() TextRange[] Возвращает коллекцию текстовых диапазонов, которые соответствуют всем Link внутри текущего текстового диапазона или перекрывают текущий текстовый диапазон.
getListParagraphs() Paragraph[] Возвращает абзацы в списках, которые перекрывают текущий диапазон текста.
getListStyle() ListStyle Возвращает ListStyle текущего диапазона текста.
getParagraphStyle() ParagraphStyle Возвращает ParagraphStyle текущего текстового диапазона.
getParagraphs() Paragraph[] Возвращает абзацы, перекрывающие текущий диапазон текста.
getRange(startOffset, endOffset) TextRange Возвращает новый TextRange , покрывающий часть диапазона, из которого он получен.
getRuns() TextRange[] Возвращает текстовые ряды, перекрывающие текущий текстовый диапазон.
getStartIndex() Integer Возвращает инклюзивный индекс, начинающийся с 0, для первого символа в этом диапазоне.
getTextStyle() TextStyle Возвращает стиль текста диапазона или null , если диапазон пуст.
insertParagraph(startOffset, text) Paragraph Вставляет абзац с начальным смещением.
insertRange(startOffset, textRange) TextRange Вставляет копию предоставленного текстового диапазона в начальное смещение.
insertRange(startOffset, textRange, matchSourceFormatting) TextRange Вставляет копию предоставленного текстового диапазона в начальное смещение.
insertText(startOffset, text) TextRange Вставляет текст по начальному смещению.
isEmpty() Boolean Возвращает true , если в этом диапазоне нет символов, и false в противном случае.
replaceAllText(findText, replaceText) Integer Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст.
replaceAllText(findText, replaceText, matchCase) Integer Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст.
select() void Выбирает только TextRange в активной презентации и удаляет любой предыдущий выбор.
setText(newText) TextRange Задает текст, ограниченный этим диапазоном связанной фигуры или ячейки таблицы.

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

appendParagraph(text)

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

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

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

Параметры

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

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

Paragraph — присоединенный Paragraph .

Авторизация

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

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

appendRange(textRange)

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

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

Параметры

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

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

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

Авторизация

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

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

appendRange(textRange, matchSourceFormatting)

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

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

Параметры

Имя Тип Описание
textRange TextRange Диапазон текста для добавления.
matchSourceFormatting Boolean Если true , соответствует форматированию исходного текста; если false , соответствует форматированию целевого текста.

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

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

Авторизация

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

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

appendText(text)

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

Параметры

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

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

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

Авторизация

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

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

asRenderedString()

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

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

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

String

Авторизация

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

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

asString()

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

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

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

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

Параметры

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

Авторизация

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

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

find(pattern)

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

Параметры

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

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

TextRange[]

Авторизация

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

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

find(pattern, startOffset)

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

Параметры

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

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

TextRange[]

Авторизация

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

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

getAutoTexts()

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

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

AutoText[]

Авторизация

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

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

getEndIndex()

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

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

Integer

Авторизация

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

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

getLength()

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

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

Integer

Авторизация

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

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

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

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

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

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

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

TextRange[]

Авторизация

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

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

getListParagraphs()

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

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

Paragraph[]

Авторизация

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

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

getListStyle()

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

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

ListStyle

Авторизация

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

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

getParagraphStyle()

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

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

ParagraphStyle

Авторизация

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

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

getParagraphs()

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

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

Paragraph[]

Авторизация

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

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

getRange(startOffset, endOffset)

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

Параметры

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

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

TextRange

Авторизация

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

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

getRuns()

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

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

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

TextRange[]

Авторизация

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

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

getStartIndex()

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

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

Integer

Авторизация

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

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

getTextStyle()

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

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

TextStyle

Авторизация

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

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

insertParagraph(startOffset, text)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insertRange(startOffset, textRange)

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

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

Параметры

Имя Тип Описание
startOffset Integer Количество символов после начального индекса текущего текстового диапазона, используемое для определения инклюзивного начального индекса вставляемого текста.
textRange TextRange Диапазон текста для вставки.

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

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

Авторизация

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

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

insertRange(startOffset, textRange, matchSourceFormatting)

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

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

Параметры

Имя Тип Описание
startOffset Integer Количество символов после начального индекса текущего текстового диапазона, используемое для определения инклюзивного начального индекса вставляемого текста.
textRange TextRange Диапазон текста для вставки.
matchSourceFormatting Boolean Если true , соответствует форматированию исходного текста; если false , соответствует форматированию целевого текста.

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

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

Авторизация

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

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

insertText(startOffset, text)

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

Параметры

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

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

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

Авторизация

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

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

isEmpty()

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

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

Boolean

Авторизация

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

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

replaceAllText(findText, replaceText)

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

Параметры

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

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

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

Авторизация

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

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

replaceAllText(findText, replaceText, matchCase)

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

Параметры

Имя Тип Описание
findText String Текст, который нужно найти.
replaceText String Текст для замены совпадающего текста.
matchCase Boolean Если true , поиск чувствителен к регистру; если false , поиск нечувствителен к регистру.

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

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

Авторизация

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

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

select()

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

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

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

    Selection может быть двух видов:
    • 1. Диапазон текста, используйте select для непустого TextRange, чтобы выбрать диапазон символов.
    • 2. Позиция курсора, используйте пустой TextRange, чтобы поместить курсор в желаемый индекс.
      var 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

    setText(newText)

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

    Параметры

    Имя Тип Описание
    newText String Строка для установки в качестве нового текста.

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

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

    Авторизация

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

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