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