Settings.remove method

Removes the specified setting.

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

Parameters

name
    Type: string

    The case-sensitive name of the setting to remove.

Remarks

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

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 add-in is closed, you must call the Settings.saveAsync method.

Example

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

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Support history