Setting Object (JavaScript API for Excel)
Setting represents a key-value pair of a setting persisted to the document.
Properties
| Property | Type | Description | Req. Set |
|---|---|---|---|
| key | string | Returns the key that represents the id of the Setting. Read-only. | 1.4 |
| value | object | Represents the value stored for this setting. | 1.4 |
See property access examples.
Relationships
None
Methods
| Method | Return Type | Description | Req. Set |
|---|---|---|---|
| delete() | void | Deletes the setting. | 1.4 |
Method Details
delete()
Deletes the setting.
Syntax
settingObject.delete();
Parameters
None
Returns
void
load(param: object)
Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.
Syntax
object.load(param);
Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| param | object | Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object. |
Returns
void