Эта страница переведена с помощью Cloud Translation API.

Class Position

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

// Insert some text at the cursor position and make it bold.
var 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.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Методы

Метод	Тип возврата	Краткое описание
`getElement()`	`Element`	Получает элемент, содержащий эту `Position` .
`getOffset()`	`Integer`	Получает относительное расположение этой `Position` внутри элемента, который ее содержит.
`getSurroundingText()`	`Text`	Создает искусственный элемент `Text` , который представляет текст и форматирование `Paragraph` или `ListItem` , содержащего `Position` , напрямую или через цепочку дочерних элементов.
`getSurroundingTextOffset()`	`Integer`	Получает смещение этой `Position` в элементе `Text` , возвращаемом методом `getSurroundingText()` .
`insertBookmark()`	`Bookmark`	Создает и вставляет новую `Bookmark` в эту `Position` .
`insertInlineImage(image)`	`InlineImage`	Создает и вставляет новый `InlineImage` в эту `Position` из указанного BLOB-объекта изображения.
`insertText(text)`	`Text`	Вставляет указанный текст в эту `Position` .

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

`getElement()`

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

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

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

`getOffset()`

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

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

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

Авторизация

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

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

`getSurroundingText()`

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

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

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

Авторизация

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

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

`getSurroundingTextOffset()`

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

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

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

Авторизация

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

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

`insertBookmark()`

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

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

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

Авторизация

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

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

`insertInlineImage(image)`

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

Параметры

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

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

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

Авторизация

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

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

`insertText(text)`

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

Параметры

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

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

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

Авторизация

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

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