Persisting data in word document using office add-in

Question

I'm trying to develop word add-in which allows to modify word content. One of the requirement is to select some text and mark it:

change its style (look) - and that is done
Associate that piece of text with some custom/hidden data, ex. an ID.

I want to somehow persist that data within the document, so that:

My add-in can read the document on the start and build a list of 'marked' elements
It should work on different machines - I can create a document on one machine, later open in on other machine, and add-in should be able to retrieve that data.

So far I tried to persist that data by first, getting data as HTML, and add attributes to tags, but that didn't work. Also tried to add some hidden div, but it was only available during word app lifetime. Recently, found this link: https://github.com/OfficeDev/Excel-Add-in-JavaScript-PersistCustomSettings , but still it allows to persist data in scope of "browser", so, I assume that on other machine it won't work.

What are my possibilities? Maybe I shouldn't store it within a document, but if not, where?

Developing it using office-js - it should work for both Word 2013 and Word 2016 (so I don't have an access to Word 2016 specific API).

Christian C · Accepted Answer · 2023-03-10 16:10:14Z

4

Check out https://learn.microsoft.com/en-us/javascript/api/office/office.settings

The Office JS Settings object allows you to save custom data that persists with the document. It is pretty straight-forward to use. Getting settings is synchronous - saving settings is async. The biggest thing is that you have to remember to call Office.settings.saveAsync() after you have made your changes using Office.settings.set() in order to actually save the changes to the document.

edited Mar 10, 2023 at 16:10

Christian C

3453 silver badges8 bronze badges

answered Dec 20, 2016 at 23:23

Nick Carruthers

947 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

dodocs Over a year ago

Thank you. I read something, that I thought said "Settings" are not available in Office-js, but in fact, it was only in scope of Microsoft Project Task-pane add-in.

dodocs · Accepted Answer · 2016-12-21 23:05:25Z

0

Moreover to Nick's answer which is absolutely correct, you can use "Binding" mechanism. Bindings are stored in document out-of-the-box, so that, you can access those later at any time. An example, which fits my needs:

Select some text and click on button in add-in (to call some method)
Call addFromSelectionAsync() method (you can specify an id for it to reference it later)
Access it using getAllAsync() or getByIdAsync() method at any time you need it.

More about it: https://dev.office.com/docs/add-ins/develop/bind-to-regions-in-a-document-or-spreadsheet

answered Dec 21, 2016 at 23:05

dodocs

617 bronze badges

Collectives™ on Stack Overflow

Persisting data in word document using office add-in

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related