Class Bookmark

添加书签

一个表示书签的对象。 

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

// Insert a bookmark at the cursor position (in the active tab) and log its ID.
var cursor = doc.getCursor();
var 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