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

JavaScript API for Office v1.1

Removes the specified setting.

Last modified: June 12, 2014

Office.context.roamingSettings.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.

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

App types

Mail apps

Supported clients

Outlook 2013, Outlook Web App, Outlook 2013 SP1, Outlook 2013 RT, and OWA for Devices

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft