Excel.WorksheetProtection class

Pacote:

excel

Representa a proteção de um objeto de folha de cálculo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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.
options	Especifica as opções de proteção para a folha de cálculo.
protected	Especifica se a folha de cálculo está protegida.

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(options, password)	Protege uma planilha. Falha se a folha de cálculo já tiver sido 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.WorksheetProtection original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetProtectionData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
unprotect(password)	Desprotege uma planilha.

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

options

Especifica as opções de proteção para a folha de cálculo.

readonly options: Excel.WorksheetProtectionOptions;

Valor da propriedade

Excel.WorksheetProtectionOptions

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

protected

Especifica se a folha de cálculo está protegida.

readonly protected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;

Parâmetros

options

Excel.Interfaces.WorksheetProtectionLoadOptions

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

Retornos

Excel.WorksheetProtection

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.WorksheetProtection;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.WorksheetProtection

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.WorksheetProtection;

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.WorksheetProtection

protect(options, password)

Protege uma planilha. Falha se a folha de cálculo já tiver sido protegida.

protect(options?: Excel.WorksheetProtectionOptions, password?: string): void;

Parâmetros

options

Excel.WorksheetProtectionOptions

Opcional. Opções de proteção da planilha.

password

string

Opcional. Palavra-passe de proteção de folha.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.2 para opções; 1,7 para palavra-passe ]

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 activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.load("protection/protected");

    await context.sync();

    if (!activeSheet.protection.protected) {
        activeSheet.protection.protect(null, 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.WorksheetProtection original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetProtectionData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Retornos

Excel.Interfaces.WorksheetProtectionData

unprotect(password)

Desprotege uma planilha.

unprotect(password?: string): void;

Parâmetros

password

string

Palavra-passe de proteção de folha.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 para palavra-passe ]

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 activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect(password);
});