OfficeDev/Excel-Add-in-JavaScript-PersistCustomSettings

Name: Excel-Add-in-JavaScript-PersistCustomSettings

Owner: Office Developer

Description: This sample demonstrates how to save custom settings in an Excel Add-in. The add-in stores data as key/value pairs, using the JavaScript API for Office property bag, browser cookies, web storage (localStorage and sessionStorage), or by storing the data in a hidden div in the document.

Created: 2015-08-12 23:25:41.0

Updated: 2017-06-10 20:09:21.0

Pushed: 2018-01-31 20:32:20.0

Homepage:

Size: 1241

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Excel-Add-in-JavaScript-PersistCustomSettings

Table of contents

• Summary
• Prerequisites
• Key components of the sample
• Build and debug
• Troubleshooting
• Questions and comments
• Additional resources

Summary

This sample demonstrates how to save custom settings inside an Excel Add-in. The add-in stores data as key/value pairs, using the JavaScript API for Office property bag, browser cookies, web storage (localStorage and sessionStorage), or by storing the data in a hidden div in the document. The add-in also demonstrates best practices for implementing multiple-page navigation in an add-in for Office.

Prerequisites

This sample requires the following:

• Visual Studio 2013 with Update 5 or Visual Studio 2015.
• Excel 2013
• Internet Explorer 9 or later, which must be installed but doesn't have to be the default browser. To support Office Add-ins, the Office client that acts as host uses browser components that are part of Internet Explorer 9 or later.
• One of the following as the default browser: Internet Explorer 9, Safari 5.0.6, Firefox 5, Chrome 13, or a later version of one of these browsers. Familiarity with JavaScript programming and web services.

Key components of the sample

The Persist custom settings sample add-in contains the following notable files:

The CodeSample_PersistCustomSettings project, including:

• CodeSample_PersistCustomSettings.xml manifest
• Home.js file
• Home.html file
• StorageLibrary.js file
• toast.js file
• App.css file

Build and debug

1. Choose the F5 key in Visual Studio to build and deploy the add-in.
2. Use the add-in?s interface to save data as key/value pairs and to retrieve a stored value using its key.

Troubleshooting

If the add-in fails to install, ensure that the SourceLocation element in the CodeSample_PersistCustomSettings.xml has the correct URL value for the DefaultValue attribute.

Questions and comments

• If you have any trouble running this sample, please log an issue.
• Questions about Office Add-in development in general should be posted to Stack Overflow. Make sure that your questions or comments are tagged with [office-addins].

Additional resources

• More Add-in samples
• Introduction to Web Storage
• Settings object

Copyright

Copyright (c) 2015 Microsoft. All rights reserved.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.