Excel.WorksheetProtection class
表示工作表对象的保护。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| options | 指定工作表的保护选项。 |
| protected | 指定工作表是否受保护。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| protect(options, password) | 保护 worksheet。 如果工作表已受保护，则失败。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
options
指定工作表的保护选项。
readonly options: Excel.WorksheetProtectionOptions;属性值
注解
protected
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.WorksheetProtection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.WorksheetProtection;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
protect(options, password)
保护 worksheet。 如果工作表已受保护，则失败。
protect(options?: Excel.WorksheetProtectionOptions, password?: string): void;参数
- options
- Excel.WorksheetProtectionOptions
可选。 工作表保护选项。
- password
-
string
可选。 工作表保护密码。
返回
void
注解
[ API set： ExcelApi 1.2 for options; 1.7 for password ]
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
let activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.load("protection/protected");
await context.sync();
if (!activeSheet.protection.protected) {
activeSheet.protection.protect(null, password);
}
});
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.WorksheetProtection 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.WorksheetProtectionData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.WorksheetProtectionData;