Excel.SettingCollection class
表示属于工作簿一部分的键值对设置对象的集合。 范围限制为每个文件和加载项 (任务窗格或内容) 组合。
方法
| add(key, value) | 设置指定的 Setting 对象，或将其添加到工作簿中。 |
| get |
获取集合中的设置数。 |
| get |
通过键获取设置条目。 |
| get |
通过键获取设置条目。 如果该设置不存在，则此方法将返回其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
活动
| on |
更改文档中的设置时发生。 |
属性详细信息
context
items
方法详细信息
add(key, value)
设置指定的 Setting 对象，或将其添加到工作簿中。
add(key: string, value: string | number | boolean | Date | any[] | any): Excel.Setting;参数
- key
-
string
新设置的键。
- value
-
string | number | boolean | Date | any[] | any
新设置的值。
返回
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});
getCount()
获取集合中的设置数。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(key)
通过键获取设置条目。
getItem(key: string): Excel.Setting;参数
- key
-
string
设置的键。
返回
注解
getItemOrNullObject(key)
通过键获取设置条目。 如果该设置不存在，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Excel.Setting;参数
- key
-
string
设置的键。
返回
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/create-get-change-delete-settings.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
let needsReview = settings.getItem("NeedsReview");
needsReview.delete();
needsReview = settings.getItemOrNullObject("NeedsReview");
await context.sync();
if (needsReview.isNullObject) {
console.log("The setting has been deleted");
} else {
console.log("The setting was not deleted");
}
await context.sync();
});
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.SettingCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SettingCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SettingCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.SettingCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.SettingCollectionData;返回
事件详细信息
onSettingsChanged
更改文档中的设置时发生。
readonly onSettingsChanged: OfficeExtension.EventHandlers<Excel.SettingsChangedEventArgs>;事件类型
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});