ExcelScript.WorkbookProtection interface

包:

ExcelScript

表示对工作簿对象的保护。

方法

getProtected()	指定工作簿是否受保护。
protect(password)	保护工作簿。 如果工作簿处于受保护状态，则无法执行此方法。
unprotect(password)	取消保护工作簿。

方法详细信息

getProtected()

指定工作簿是否受保护。

getProtected(): boolean;

返回

boolean

示例

/**
 * This script protects the workbook with a default password, if there is not already protection.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
    // Apply a default password.
    protection.protect("1234");
  }
}

protect(password)

保护工作簿。 如果工作簿处于受保护状态，则无法执行此方法。

protect(password?: string): void;

参数

password

string

工作簿保护密码。

返回

void

示例

/**
 * This script protects the workbook using a password given in a user prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Protect the workbook with the given password.
  // If the optional password was omitted, 
  // no password will be needed to unprotect the workbook.
  protection.protect(password);
}

unprotect(password)

取消保护工作簿。

unprotect(password?: string): void;

参数

password

string

工作簿保护密码。

返回

void

示例

/**
 * This script removes protection from the workbook using a password given in a user prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Unprotect the workbook with the given password.
  protection.unprotect(password);
}