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);
}