Export (0) Print
Expand All

Settings.remove method (JavaScript API for Office v1.1)

JavaScript API for Office v1.1

Removes the specified setting.

Last modified: June 12, 2014

Available in requirement sets

Settings

Office.context.document.settings.remove(name);

name

Type: string

The case-sensitive name of the setting to remove.

null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.

Important note Important

Be aware that the Settings.remove method affects only the in-memory copy of the settings property bag. To persist the removal of the specified setting in the document, at some point after calling the Settings.remove method and before the app is closed, you must call the Settings.saveAsync method.

In version 1.1 of Office.js, you can create settings in content apps for Access.

function removeMySetting() {
    Office.context.document.settings.remove('mySetting');
}

App types

Content apps, Task pane apps

Supported clients

Access app for SharePoint, Excel 2013, Excel Online, Excel 2013 SP1, Excel 2013 RT, Word 2013, Word 2013 SP1, Word 2013 RT, PowerPoint 2013, PowerPoint 2013 SP1, PowerPoint 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft