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 元素,代表包含 PositionParagraphListItem 的文字和格式,例如直接或透過子元素鏈結。
getSurroundingTextOffset()Integer取得 getSurroundingText() 傳回的 Text 元素中的此 Position 偏移值。
insertBookmark()Bookmark在此 Position 上建立並插入新的 Bookmark
insertInlineImage(image)InlineImage透過指定圖片 blob 在這個 Position 中插入並插入新的 InlineImage
insertText(text)Text在這個 Position 插入指定文字。

內容詳盡的說明文件

getElement()

取得包含這個Position的元素。這會是 Text 元素或 Paragraph 等容器元素。無論是哪一種情況,您都可以使用 getOffset() 確定元素中的相對位置。

Return 鍵

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


getOffset()

取得包含這個元素的 Position 位置相對位置。如果元素是 Text 元素,則偏移值為 Position 之前的字元數 (也就是這個 Position 之後的字元索引);針對任何其他元素,偏移是指同一個容器元素中 Position 之前的子元素數量 (也就是 Position 之後的子元素索引)。

Return 鍵

Integer:針對 Text 元素,這個 Position 之前的字元數;針對其他元素,相同容器元素中這個 Position 之前的子元素數量

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getSurroundingText()

建立人工 Text 元素,代表包含 PositionParagraphListItem 的文字和格式,例如直接或透過子元素鏈結。如要判斷傳回的 Text 元素中的 Position' 偏移量,請使用 getSurroundingTextOffset()

Return 鍵

Text:即與 Paragraph 或含有 PositionListItem 呼叫 editAsText() 的結果相等的 元素,無論是直接或跨子元素鏈結

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getSurroundingTextOffset()

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

Return 鍵

IntegerParagraphListItemPosition 之前的字元數,包含 Position,直接或透過子元素鏈結

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertBookmark()

在此 Position 上建立並插入新的 Bookmark

Return 鍵

Bookmark:新的書籤

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertInlineImage(image)

透過指定圖片 blob 在這個 Position 中插入並插入新的 InlineImage

參數

名稱類型說明
imageBlobSource要在這個 Position 插入的圖片資料

Return 鍵

InlineImage — 新的圖片元素,或 null 這個Position所在的元素不允許插入圖片

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertText(text)

在這個 Position 插入指定文字。這個方法會建立新的 Text 元素,即使字串是插入現有的 Text 元素中也一樣,因此能輕鬆設定新元素的樣式。

參數

名稱類型說明
textString要插入此 Position 的字串

Return 鍵

Text:新的文字元素,如果這個 Position 所在的元素不允許插入文字,則為 null

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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