Search code examples
ms-wordoffice-jsoffice-addinsoffice-js-helpers

How do I add a bookmark within the body of a Word doc using Office JS


The Office JS has provided the following function in preview, but I couldn't find any example.

Here is what I tried but it doesn't seem to work, any idea what I am missing here, since this code inserts the text but the bookmark is not created.

Word.run(function (context)
{
    let range = context.document.getSelection();
    return context.sync().then(function ()
    {
        range.insertText(`Test Bookmark`, Word.InsertLocation.replace);

        let uniqueStr = new Date().getTime();
        let bookmarkName = `Test_BookmarkCode_${uniqueStr}`;
        range.insertBookmark(bookmarkName);
    });
});

Cross posted here.


Solution

  • So, here is the working code. Apparently, when we insertText, a new range is returned, we need to use that range to insertBookmark.

    Word.run(function (context)
    {
        let range = context.document.getSelection();
        return context.sync().then(function ()
        {
            let insertedTextRange = range.insertText(`Test Bookmark`, Word.InsertLocation.replace);
    
            let uniqueStr = new Date().getTime();
            let bookmarkName = `Test_BookmarkCode_${uniqueStr}`;
            insertedTextRange.insertBookmark(bookmarkName);
        });
    });