ExcelScript.WorkbookProtection interface

Paquete:

ExcelScript

Representa la protección de un objeto de libro.

Métodos

getProtected()	Especifica si el libro está protegido.
protect(password)	Protege el libro. Produce un error si se ha protegido el libro.
unprotect(password)	Desprotege el libro.

Detalles del método

getProtected()

Especifica si el libro está protegido.

getProtected(): boolean;

Devoluciones

boolean

Ejemplos

/**
 * 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 el libro. Produce un error si se ha protegido el libro.

protect(password?: string): void;

Parámetros

password

string

Contraseña de protección del libro.

Devoluciones

void

Ejemplos

/**
 * 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 el libro.

unprotect(password?: string): void;

Parámetros

password

string

Contraseña de protección del libro.

Devoluciones

void

Ejemplos

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