Excel.WorkbookProtection class

表示对工作簿对象的保护。Represents the protection of a workbook object.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

Extends

属性

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

protected

指示工作簿是否受保护。Indicates if the workbook is protected. 只读。Read-Only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

方法

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

protect(password)

保护工作簿。Protects a workbook. 如果工作簿处于受保护状态,则无法执行此方法。Fails if the workbook has been protected.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始 WorkbookProtection 对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.WorkbookProtectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.WorkbookProtection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookProtectionData), 其中包含原始对象中所有已加载的子属性的浅表副本。) that contains shallow copies of any loaded child properties from the original object.

unprotect(password)

解除保护工作簿。Unprotects a workbook.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

属性详细信息

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

context: RequestContext;

属性值

RequestContext

protected

指示工作簿是否受保护。Indicates if the workbook is protected. 只读。Read-Only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

readonly protected: boolean;

属性值

boolean

方法详细信息

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection;

参数

返回

注解

除了此签名之外, 此方法还具有以下签名:In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.WorkbookProtection-Where 选项是一个逗号分隔的字符串或一个字符串数组, 用于指定要加载的属性。load(option?: string | string[]): Excel.WorkbookProtection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.WorkbookProtection-Where 选项。选择是一个用逗号分隔的字符串, 用于指定要加载的属性和选项。 expand 是一个用逗号分隔的字符串, 用于指定要加载的导航属性。load(option?: { select?: string; expand?: string; }): Excel.WorkbookProtection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorkbookProtection-仅适用于集合类型。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.WorkbookProtection - Only available on collection types. 它类似于前面的签名。It is similar to the preceding signature. top 指定结果中可包含的集合项的最大数量。Option.top specifies the maximum number of collection items that can be included in the result. 选项。 skip 指定要跳过且不包含在结果中的项目数。Option.skip specifies the number of items that are to be skipped and not included in the result. 如果指定了 top 选项, 则在跳过指定数目的项目后将启动结果集。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.WorkbookProtection;

参数

propertyNames
string | string[]

一个以逗号分隔的字符串或字符串数组, 用于指定要加载的属性。A comma-delimited string or an array of strings that specify the properties to load.

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.WorkbookProtection;

参数

propertyNamesAndPaths
{ select?: string; expand?: string; }

其中, propertyNamesAndPaths 是用逗号分隔的字符串, 用于指定要加载的属性和 propertyNamesAndPaths。扩展是一个用逗号分隔的字符串, 用于指定要加载的导航属性。Where 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.

返回

protect(password)

保护工作簿。Protects a workbook. 如果工作簿处于受保护状态,则无法执行此方法。Fails if the workbook has been protected.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

protect(password?: string): void;

参数

password
string

工作簿保护密码。workbook protection password.

返回

void

示例Examples

await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

    if (!workbook.protection.protected) {
        workbook.protection.protect();
    }
});
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

    if (!workbook.protection.protected) {
        workbook.protection.protect(password);
    }
});

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始 WorkbookProtection 对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.WorkbookProtectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.WorkbookProtection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookProtectionData), 其中包含原始对象中所有已加载的子属性的浅表副本。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.WorkbookProtectionData;

返回

unprotect(password)

解除保护工作簿。Unprotects a workbook.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

unprotect(password?: string): void;

参数

password
string

工作簿保护密码。workbook protection password.

返回

void

示例Examples

await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.protection.unprotect();
});
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.protection.unprotect(password);
});