An object representing a 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());
Methods
| Method | Return type | Brief description |
|---|---|---|
getId() | String | Gets the ID of the Bookmark. |
getPosition() | Position | Gets the Position of the Bookmark within the DocumentTab. |
remove() | void | Deletes the Bookmark. |
Detailed documentation
getId()
Gets the ID of the Bookmark. The ID is unique within the DocumentTab.
Return
String — The Bookmark's ID, which is unique within the DocumentTab.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPosition()
Gets the Position of the Bookmark within the DocumentTab. The Position remains accurate so long as the Bookmark is not deleted, even if the script
changes the document structure.
Return
Position — The position of the Bookmark.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove()
Deletes the Bookmark. Calling this method on a Bookmark that has already been
deleted has no effect.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents