本頁面由 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` 元素，用來代表包含 `Position` 的 `Paragraph` 或 `ListItem` (直接或透過子項元素鏈結)。
`getSurroundingTextOffset()`	`Integer`	取得此 `Position` 在 `getSurroundingText()` 傳回的 `Text` 元素中的偏移值。
`insertBookmark()`	`Bookmark`	在這個 `Position` 中建立及插入新的 `Bookmark`。
`insertInlineImage(image)`	`InlineImage`	從指定圖片在這個 `Position` 建立及插入新的 `InlineImage` blob。
`insertText(text)`	`Text`	在這個 `Position` 插入指定文字。

內容詳盡的說明文件

`getElement()`

取得包含此 Position 的元素。這可能是 Text 元素或容器元素，例如 Paragraph。無論是哪種情況，可使用 getOffset() 決定元素中的位置。

回攻員

Element：這個 Position 物件所在的容器或 Text 元素

`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 元素，用來代表包含 Position 的 Paragraph 或 ListItem (直接或透過子項元素鏈結)。如要判斷傳回的 Text 元素中 Position 的偏移情形，請使用 getSurroundingTextOffset()。

回攻員

Text：元素相當於呼叫 editAsText() 的結果在包含 Position 的 Paragraph 或 ListItem 上 (直接或透過子項元素鏈結)

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getSurroundingTextOffset()`

取得此 Position 在 getSurroundingText() 傳回的 Text 元素中的偏移值。偏移值是指 Position 之前的字元數 (也就是此 Position 之後的字元索引)。

回攻員

Integer：包含 Position 的 Paragraph 或 ListItem 中，這個 Position 之前的字元數，可能是直接或透過子項元素鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`insertBookmark()`

在這個 Position 中建立及插入新的 Bookmark。

回攻員

Bookmark — 新的書籤

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`insertInlineImage(image)`

從指定圖片在這個 Position 建立及插入新的 InlineImage 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