ExcelScript.WorkbookProtection interface

Paket:

ExcelScript

Stellt den Schutz eines Arbeitsmappenobjekts dar.

Methoden

getProtected()	Gibt an, ob die Arbeitsmappe geschützt ist.
protect(password)	Schützt die Arbeitsmappe. Schlägt fehl, wenn die Arbeitsmappe geschützt ist.
unprotect(password)	Hebt den Schutz der Arbeitsmappe auf.

Details zur Methode

getProtected()

Gibt an, ob die Arbeitsmappe geschützt ist.

getProtected(): boolean;

Gibt zurück

boolean

Beispiele

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

Schützt die Arbeitsmappe. Schlägt fehl, wenn die Arbeitsmappe geschützt ist.

protect(password?: string): void;

Parameter

password

string

Kennwort für den Arbeitsmappenschutz.

Gibt zurück

void

Beispiele

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

Hebt den Schutz der Arbeitsmappe auf.

unprotect(password?: string): void;

Parameter

password

string

Kennwort für den Arbeitsmappenschutz.

Gibt zurück

void

Beispiele

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