IssueTracker

Before opening a new issue, please search for other related issues, click the ★ to subscribe to updates, and click +1 to vote.

Description

Script cycles through number of bookmarks in the same document and tab (based on their url) and updates the bookmarked text. However, after the first bookmark is fetched from the documentTab, the following bookmarks do have the proper ids but return the same position, and thus the same textElement. This results in only a single text line being updated.

In the code bellow the surrounding text ends up being the same, although the bookmarks are different.

A workaround resolves the issue by saving and closing the document.

Code

function test_bookmark_text_issue() {

  const bookmarkUrls = [
    "https://docs.google.com/document/d/DOC_ID_1/edit?tab=TAB_ID_1#bookmark=id.46t5xnlsxa6m",
    "https://docs.google.com/document/d/DOC_ID_1/edit?tab=TAB_ID_1#bookmark=id.p2frhfm62x1g",
    "https://docs.google.com/document/d/DOC_ID_1/edit?tab=TAB_ID_1#bookmark=id.mskbt79dkckm",
    "https://docs.google.com/document/d/DOC_ID_1/edit?tab=TAB_ID_1#bookmark=id.f12v079xz7jr",
  ]

  bookmarkUrls.forEach(
    bookmarkUrl => {
      const regex = /\/d\/([^\/]+)\/edit(?:\?tab=(t\.[^&#]+))?(?:#bookmark=(id\.[^&]+))?/
      const match = bookmarkUrl.match(regex)

      var documentId, tabId, bookmarkId
      if (match) {
        [_, documentId, tabId, bookmarkId] = match
      } else {
        throw "URL could not be parsed out."
      }

      const doc = DocumentApp.openById(documentId)
      const tab = doc.getTab(tabId)
      const documentTab = tab.asDocumentTab()
      const bookmark = documentTab.getBookmark(bookmarkId)

      const pos = bookmark.getPosition()
      const textElement = pos.getSurroundingText()
      let text = textElement.getText()
      log({ documentId, tabId, bookmarkId, text })

      // Update text on bookmark line to replace first character with '?'
      textElement
        .editAsText()
        .insertText(1, "?")
        .deleteText(0, 0)

      // Save and close the doc: resolves the issue of textElement being the same for all bookmarks.messes up the updates.
      // doc.saveAndClose()
    }
  )

  // Original text in tab:
  // {bm_1}A Text 1.
  // {bm_2}B Text 2.
  // {bm_3}C Text 3.
  // {bm_4}D Text 4.

  // Resulting text in tab:
  // {bm_1}? Text 1.
  // {bm_2}B Text 2.
  // {bm_3}C Text 3.
  // {bm_4}D Text 4.

  // Resulting text in tab when doc.saveAndClose() is added:
  // {bm_1}? Text 1.
  // {bm_2}? Text 2.
  // {bm_3}? Text 3.
  // {bm_4}? Text 4.
}

Output

6:51:31 PM Info { "documentId": "DOC_ID_1", "tabId": "TAB_ID_1", "bookmarkId": "id.46t5xnlsxa6m", "text": "A Text 1." } 6:51:31 PM Info { "documentId": "DOC_ID_1", "tabId": "TAB_ID_1", "bookmarkId": "id.p2frhfm62x1g", "text": "? Text 1." } 6:51:31 PM Info { "documentId": "DOC_ID_1", "tabId": "TAB_ID_1", "bookmarkId": "id.mskbt79dkckm", "text": "? Text 1." } 6:51:31 PM Info { "documentId": "DOC_ID_1", "tabId": "TAB_ID_1", "bookmarkId": "id.f12v079xz7jr", "text": "? Text 1." }

Steps

1. Create test document with one or more tabs.

2. Select one of the tabs and paste the following text: A Text 1. B Text 2. C Text 3. D Text 4.

3. Add a bookmark for each of the 4 lines with text.

4. In the provided code replace the values in 'bookmarkUrls' with the actual bookmark urls.

5. Execute the 'test_bookmark_text_issue' function.

6. Verify the changes in the document. Upon execution my script only changes the first bookmarked text.

7. Reset the text in the first line. Uncomment the .doc.saveAndClose() line in the script and execute again. Upon execution my script changes all bookmarked texts properly.