Word.SettingCollection class
Contains the collection of Word.Setting objects.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Deletes all custom settings this add-in had set on this document.
await Word.run(async (context) => {
const settings = context.document.settings;
settings.deleteAll();
await context.sync();
console.log("All settings deleted");
});
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(key, value) | Creates a new setting or sets an existing setting. |
| delete |
Deletes all settings in this add-in. |
| get |
Gets the count of settings. |
| get |
Gets a setting object by its key, which is case-sensitive. Throws an |
| get |
Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Gets the loaded child items in this collection.
readonly items: Word.Setting[];Property Value
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
const settings = context.document.settings;
settings.load("items");
await context.sync();
if (settings.items.length == 0) {
console.log("There are no settings");
} else {
console.log("All settings:");
for (let i = 0; i < settings.items.length; i++) {
console.log(settings.items[i]);
}
}
});
Method Details
add(key, value)
Creates a new setting or sets an existing setting.
add(key: string, value: any): Word.Setting;Parameters
- key
-
string
Required. The setting's key, which is case-sensitive.
- value
-
any
Required. The setting's value.
Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Adds a new custom setting or
// edits the value of an existing one.
await Word.run(async (context) => {
const key = $("#key")
.val()
.toString();
if (key == "") {
console.error("Key shouldn't be empty");
return;
}
const value = $("#value")
.val()
.toString();
const settings = context.document.settings;
const setting = settings.add(key, value);
setting.load();
await context.sync();
console.log("Setting added or edited:");
console.log(setting);
});
deleteAll()
Deletes all settings in this add-in.
deleteAll(): void;Returns
void
Remarks
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue a command to get the count of settings.
const count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
// Queue a command to delete all settings.
settings.deleteAll();
// Queue a command to get the new count of settings.
count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
});
getCount()
Gets the count of settings.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue a command to get the count of settings.
const count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
// Queue a command to delete all settings.
settings.deleteAll();
// Queue a command to get the new count of settings.
count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
});
getItem(key)
Gets a setting object by its key, which is case-sensitive. Throws an ItemNotFound error if the setting doesn't exist.
getItem(key: string): Word.Setting;Parameters
- key
-
string
The key that identifies the setting object.
Returns
Remarks
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue a command to retrieve a setting.
const startMonth = settings.getItem('startMonth');
// Queue a command to load the setting.
startMonth.load();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(JSON.stringify(startMonth.value));
});
getItemOrNullObject(key)
Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(key: string): Word.Setting;Parameters
- key
-
string
Required. The key that identifies the setting object.
Returns
Remarks
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue commands to retrieve settings.
const startMonth = settings.getItemOrNullObject('startMonth');
const endMonth = settings.getItemOrNullObject('endMonth');
// Queue commands to load settings.
startMonth.load();
endMonth.load();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (startMonth.isNullObject) {
console.log("No such setting.");
}
else {
console.log(JSON.stringify(startMonth.value));
}
if (endMonth.isNullObject) {
console.log("No such setting.");
}
else {
console.log(JSON.stringify(endMonth.value));
}
});
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.SettingCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.SettingCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.SettingCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Word.Interfaces.SettingCollectionData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.SettingCollection;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.SettingCollection;Returns
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for