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 из указанного большого двоичного объекта изображения.
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 из указанного большого двоичного объекта изображения.

Параметры

Имя Тип Описание
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