Word.Setting class
表示加载项的设置。
注解
使用方
示例
// 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 = (document.getElementById("key") as HTMLInputElement).value;
if (key == "") {
console.error("Key shouldn't be empty.");
return;
}
const value = (document.getElementById("value") as HTMLInputElement).value;
const settings: Word.SettingCollection = context.document.settings;
const setting: Word.Setting = settings.add(key, value);
setting.load();
await context.sync();
console.log("Setting added or edited:", setting);
});
方法
| delete() | 删除 Setting 对象。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
context
key
获取设置的键。
readonly key: string;属性值
string
注解
示例
// 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 = (document.getElementById("key") as HTMLInputElement).value;
if (key == "") {
console.error("Key shouldn't be empty.");
return;
}
const value = (document.getElementById("value") as HTMLInputElement).value;
const settings: Word.SettingCollection = context.document.settings;
const setting: Word.Setting = settings.add(key, value);
setting.load();
await context.sync();
console.log("Setting added or edited:", setting);
});
value
指定设置的值。
value: any;属性值
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 = (document.getElementById("key") as HTMLInputElement).value;
if (key == "") {
console.error("Key shouldn't be empty.");
return;
}
const value = (document.getElementById("value") as HTMLInputElement).value;
const settings: Word.SettingCollection = context.document.settings;
const setting: Word.Setting = settings.add(key, value);
setting.load();
await context.sync();
console.log("Setting added or edited:", setting);
});
方法详细信息
delete()
删除 Setting 对象。
delete(): 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;
const startMonth = 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 the setting.
startMonth.delete();
// 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);
});
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.SettingLoadOptions): Word.Setting;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.Setting;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Setting;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.SettingUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.Setting 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.SettingData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.SettingData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.Setting;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.Setting;