Class Position

Позиция

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

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Методы

Метод Тип возврата Краткое описание
get Element() Element Получает элемент, содержащий эту Position .
get Offset() Integer Получает относительное расположение этой Position внутри элемента, который ее содержит.
get Surrounding Text() Text Создает искусственный элемент Text , который представляет текст и форматирование Paragraph или List Item , содержащего Position , напрямую или через цепочку дочерних элементов.
get Surrounding Text Offset() Integer Получает смещение этой Position внутри элемента Text , возвращаемого методом get Surrounding Text() .
insert Bookmark() Bookmark Создает и вставляет новую Bookmark в эту Position .
insert Inline Image(image) Inline Image Создает и вставляет новое Inline Image в эту Position из указанного BLOB-объекта изображения.
insert Text(text) Text Вставляет указанный текст в эту Position .

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

get Element()

Получает элемент, содержащий эту Position . Это будет либо элемент Text , либо элемент-контейнер, например Paragraph . В любом случае относительное положение внутри элемента можно определить с помощью get Offset() .

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

Element — контейнер или Text элемент, в котором находится этот объект Position

get Offset()

Получает относительное расположение этой Position внутри элемента, который ее содержит. Если элемент является Text элементом, смещение — это количество символов до Position (то есть индекс символа после этой Position ); для любого другого элемента смещение — это количество дочерних элементов до этой Position в одном и том же элементе-контейнере (то есть индекс дочернего элемента после Position ).

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

Integer — для элементов Text количество символов до этой Position ; для других элементов — количество дочерних элементов до этой Position в том же элементе-контейнере.

Авторизация

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

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

get Surrounding Text()

Создает искусственный элемент Text , который представляет текст и форматирование Paragraph или List Item , содержащего Position , напрямую или через цепочку дочерних элементов. Чтобы определить смещение Position в возвращаемом элементе Text , используйте get Surrounding Text Offset() .

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

Text — элемент, эквивалентный результату вызова edit As Text() для элемента Paragraph или List Item который содержит Position , напрямую или через цепочку дочерних элементов.

Авторизация

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

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

get Surrounding Text Offset()

Получает смещение этой Position внутри элемента Text , возвращаемого методом get Surrounding Text() . Смещение — это количество символов до Position (то есть индекс символа после этой Position ).

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

Integer — количество символов перед этой Position в Paragraph или List Item , который содержит Position , напрямую или через цепочку дочерних элементов.

Авторизация

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

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

insert Bookmark()

Создает и вставляет новую Bookmark в эту Position .

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

Bookmark — новая закладка

Авторизация

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

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

insert Inline Image(image)

Создает и вставляет новое Inline Image в эту Position из указанного BLOB-объекта изображения.

Параметры

Имя Тип Описание
image Blob Source данные изображения для вставки в эту Position

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

Inline Image — новый элемент изображения или null , если элемент, в котором находится эта Position не позволяет вставлять изображения.

Авторизация

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

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

insert Text(text)

Вставляет указанный текст в эту Position . Этот метод создает новый элемент Text , даже если строка вставлена ​​в существующий элемент Text , что упрощает стилизацию нового элемента.

Параметры

Имя Тип Описание
text String строка для вставки в эту Position

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

Text — новый текстовый элемент или null , если элемент, в котором находится эта Position не позволяет вставлять текст.

Авторизация

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

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