Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

JavaScript API for Office v1.1

Sets or creates the specified setting.

Last modified: February 27, 2014

Office.context.roamingSettings.set(name, value);
name

Type: string

The case-sensitive name of the setting to set or create.

value

Type: string, number, boolean, null, object or array

Specifies the value to be stored.

The set method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name. The value is stored in the document as the serialized JSON representation of its data type. A maximum of 2MB is available for the settings of each app.

function setMySetting() {
    Office.context.roamingSettings.set('mySetting', 'mySetting value');
}

App types

Mail apps

Supported clients

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

Library

Office.js

Namespace

Office

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.