Class Bookmark

书签

表示书签的对象。 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Insert a bookmark at the cursor position (in the active tab) and log its ID.
const cursor = doc.getCursor();
const bookmark = documentTab.addBookmark(cursor);
Logger.log(bookmark.getId());

方法

方法返回类型简介
getId()String获取 Bookmark 的 ID。
getPosition()Position获取 DocumentTab 中的 Bookmark 的 Position。
remove()void删除 Bookmark。

详细文档

getId()

获取 Bookmark 的 ID。该 ID 在 DocumentTab 中是唯一的。

返回

String - Bookmark 的 ID，在 DocumentTab 中是唯一的。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getPosition()

获取 DocumentTab 中的 Bookmark 的 Position。只要 Bookmark 未被删除，Position 就会保持准确，即使脚本更改了文档结构也是如此。

返回

Position - Bookmark 的位置。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

remove()

删除 Bookmark。对已删除的 Bookmark 调用此方法不会产生任何影响。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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