ExcelScript.WorkbookProtection interface

Pacote:

ExcelScript

Representa a proteção de um objeto de livro.

Métodos

getProtected()	Especifica se o livro está protegido.
protect(password)	Protege o livro. Falhará se a pasta de trabalho estiver protegida.
unprotect(password)	Desprotege o livro.

Detalhes do método

getProtected()

Especifica se o livro está protegido.

getProtected(): boolean;

Retornos

boolean

Exemplos

/**
 * 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)

Protege o livro. Falhará se a pasta de trabalho estiver protegida.

protect(password?: string): void;

Parâmetros

password

string

Palavra-passe de proteção do livro.

Retornos

void

Exemplos

/**
 * 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)

Desprotege o livro.

unprotect(password?: string): void;

Parâmetros

password

string

Palavra-passe de proteção do livro.

Retornos

void

Exemplos

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