Word.SettingCollection class
包含 Word 的集合。设置对象。
- Extends
注解
示例
// 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.");
});
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(key, value) | 创建新设置或设置现有设置。 |
| delete |
删除此加载项中的所有设置。 |
| get |
获取设置计数。 |
| get |
按键获取设置对象，该键区分大小写。 |
| get |
按键获取设置对象，该键区分大小写。 如果该设置不存在，则此方法将返回一个 对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 |
属性详细信息
context
items
获取此集合中已加载的子项。
readonly items: Word.Setting[];属性值
示例
// 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]);
}
}
});
方法详细信息
add(key, value)
创建新设置或设置现有设置。
add(key: string, value: any): Word.Setting;参数
- key
-
string
必需。 设置的键，区分大小写。
- value
-
any
必需。 设置的值。
返回
注解
示例
// 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:", setting);
});
deleteAll()
删除此加载项中的所有设置。
deleteAll(): void;返回
void
注解
示例
// 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()
获取设置计数。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
示例
// 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)
按键获取设置对象，该键区分大小写。 ItemNotFound如果该设置不存在，则引发错误。
getItem(key: string): Word.Setting;参数
- key
-
string
标识设置对象的键。
返回
注解
示例
// 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)
按键获取设置对象，该键区分大小写。 如果该设置不存在，则此方法将返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Word.Setting;参数
- key
-
string
必需。 标识设置对象的键。
返回
注解
示例
// 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)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.SettingCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Word.SettingCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.SettingCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Word.Interfaces.SettingCollectionData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
track(): Word.SettingCollection;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。
untrack(): Word.SettingCollection;返回
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈