Excel.WorkbookProtection class

Pacote:

excel

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

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
protected	Especifica se o livro está protegido.

Métodos

load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)	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 o livro. Falhará se a pasta de trabalho estiver protegida.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.WorkbookProtection original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorkbookProtectionData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
unprotect(password)	Desprotege o livro.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

protected

Especifica se o livro está protegido.

readonly protected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Detalhes do método

load(options)

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

load(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection;

Parâmetros

options

Excel.Interfaces.WorkbookProtectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.WorkbookProtection

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[]): Excel.WorkbookProtection;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.WorkbookProtection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.WorkbookProtection;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.WorkbookProtection

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml

let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

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

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.WorkbookProtection original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorkbookProtectionData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.WorkbookProtectionData;

Retornos

Excel.Interfaces.WorkbookProtectionData

unprotect(password)

Desprotege o livro.

unprotect(password?: string): void;

Parâmetros

password

string

Palavra-passe de proteção do livro.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml

let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.protection.unprotect(password);
});