Excel.WorkbookProtection interface

Representa a proteção de um objeto Workbook.

Propriedades

protected

Especifica se a pasta de trabalho está protegida.

Métodos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

protect(password)

Protege uma pasta de trabalho. Falhará se a pasta de trabalho estiver protegida.

unprotect(password)

Desprotege uma pasta de trabalho.

Detalhes da propriedade

protected

Especifica se a pasta de trabalho está protegida.

readonly protected: boolean;

Valor da propriedade

boolean

Detalhes do método

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

protect(password)

Protege uma pasta de trabalho. Falhará se a pasta de trabalho estiver protegida.

protect(password?: string): void;

Parâmetros

password
string

senha de proteção da pasta de trabalho.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

    if (!workbook.protection.protected) {
        workbook.protection.protect();
    }
}
let password = await passwordHandler();
passwordHelper(password);
async function main(context: Excel.RequestContext) {
    let workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

    if (!workbook.protection.protected) {
        workbook.protection.protect(password);
    }
}

unprotect(password)

Desprotege uma pasta de trabalho.

unprotect(password?: string): void;

Parâmetros

password
string

senha de proteção da pasta de trabalho.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let workbook = context.workbook;
    workbook.protection.unprotect();
}
let password = await passwordHandler();
passwordHelper(password);
async function main(context: Excel.RequestContext) {
    let workbook = context.workbook;
    workbook.protection.unprotect(password);
}