Excel.WorksheetProtection class

Pacote:

excel

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

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Propriedades

allowEditRanges	Especifica o AllowEditRangeCollection objeto encontrado nesta planilha. Essa é uma coleção de AllowEditRange objetos, que funcionam com propriedades de proteção de planilha. Quando a proteção de planilha está habilitada, um AllowEditRange objeto pode ser usado para permitir a edição de um intervalo específico, mantendo a proteção no restante da planilha.
canPauseProtection	Especifica se a proteção pode ser pausada para esta planilha.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
isPasswordProtected	Especifica se a planilha é protegida por senha.
isPaused	Especifica se a proteção de planilha está pausada.
options	Especifica as opções de proteção para a planilha.
protected	Especifica se a planilha está protegida.
savedOptions	Especifica as opções de proteção salvas na planilha. Isso retornará o mesmo WorksheetProtectionOptions objeto, independentemente do estado de proteção da planilha.

Métodos

checkPassword(password)	Especifica se a senha pode ser usada para desbloquear a proteção de planilha. Esse método não altera o estado de proteção de planilha. Se uma senha for inserida, mas nenhuma senha for necessária para desbloquear a proteção de planilha, esse método retornará false.
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.
pauseProtection(password)	Pausa a proteção de planilha para o objeto de planilha fornecido para o usuário na sessão atual. Esse método não faz nada se a proteção de planilha não estiver habilitada ou já estiver pausada. Se a senha estiver incorreta, esse método gera um InvalidArgument erro e falha ao pausar a proteção. Esse método não alterará o estado de proteção se a proteção de planilha não estiver habilitada ou já estiver pausada.
protect(options, password)	Protege uma planilha. Falhará se a planilha já tiver sido protegida.
resumeProtection()	Retoma a proteção de planilha para o objeto de planilha fornecido para o usuário em uma determinada sessão. A proteção de planilha deve ser pausada para que esse método funcione. Se a proteção de planilha não for pausada, esse método não alterará o estado de proteção da planilha.
setPassword(password)	Altera a senha associada ao WorksheetProtection objeto. Definir a senha como uma cadeia de caracteres vazia ("") ou como null removerá a proteção de senha do WorksheetProtection objeto. A proteção de planilha deve ser habilitada e pausada para que esse método funcione corretamente. Se a proteção de planilha estiver desabilitada, esse método gerará um InvalidOperation erro e não alterará a senha. Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e não alterará a senha.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.WorksheetProtection original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetProtectionData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
unprotect(password)	Desprotege uma planilha.
updateOptions(options)	Altere as opções de proteção de planilha associadas ao WorksheetProtection objeto. A proteção de planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e não alterará as opções de proteção de planilha.

Detalhes da propriedade

allowEditRanges

Especifica o AllowEditRangeCollection objeto encontrado nesta planilha. Essa é uma coleção de AllowEditRange objetos, que funcionam com propriedades de proteção de planilha. Quando a proteção de planilha está habilitada, um AllowEditRange objeto pode ser usado para permitir a edição de um intervalo específico, mantendo a proteção no restante da planilha.

readonly allowEditRanges: Excel.AllowEditRangeCollection;

Valor da propriedade

Excel.AllowEditRangeCollection

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

canPauseProtection

Especifica se a proteção pode ser pausada para esta planilha.

readonly canPauseProtection: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

isPasswordProtected

Especifica se a planilha é protegida por senha.

readonly isPasswordProtected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

isPaused

Especifica se a proteção de planilha está pausada.

readonly isPaused: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

options

Especifica as opções de proteção para a planilha.

readonly options: Excel.WorksheetProtectionOptions;

Valor da propriedade

Excel.WorksheetProtectionOptions

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

protected

Especifica se a planilha está protegida.

readonly protected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

savedOptions

Especifica as opções de proteção salvas na planilha. Isso retornará o mesmo WorksheetProtectionOptions objeto, independentemente do estado de proteção da planilha.

readonly savedOptions: Excel.WorksheetProtectionOptions;

Valor da propriedade

Excel.WorksheetProtectionOptions

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalhes do método

checkPassword(password)

Especifica se a senha pode ser usada para desbloquear a proteção de planilha. Esse método não altera o estado de proteção de planilha. Se uma senha for inserida, mas nenhuma senha for necessária para desbloquear a proteção de planilha, esse método retornará false.

checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;

Parâmetros

password

string

A senha a ser marcar na planilha protegida.

Retornos

OfficeExtension.ClientResult<boolean>

Retornará true se a senha puder ser usada para desbloquear a proteção de planilha. Caso contrário, retorna false.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.WorksheetProtection

pauseProtection(password)

Pausa a proteção de planilha para o objeto de planilha fornecido para o usuário na sessão atual. Esse método não faz nada se a proteção de planilha não estiver habilitada ou já estiver pausada. Se a senha estiver incorreta, esse método gera um InvalidArgument erro e falha ao pausar a proteção. Esse método não alterará o estado de proteção se a proteção de planilha não estiver habilitada ou já estiver pausada.

pauseProtection(password?: string): void;

Parâmetros

password

string

A senha associada à planilha protegida.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

protect(options, password)

Protege uma planilha. Falhará se a planilha 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. Senha de proteção de planilha.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.2 para opções; 1.7 para senha ]

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

resumeProtection()

Retoma a proteção de planilha para o objeto de planilha fornecido para o usuário em uma determinada sessão. A proteção de planilha deve ser pausada para que esse método funcione. Se a proteção de planilha não for pausada, esse método não alterará o estado de proteção da planilha.

resumeProtection(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

setPassword(password)

Altera a senha associada ao WorksheetProtection objeto. Definir a senha como uma cadeia de caracteres vazia ("") ou como null removerá a proteção de senha do WorksheetProtection objeto. A proteção de planilha deve ser habilitada e pausada para que esse método funcione corretamente. Se a proteção de planilha estiver desabilitada, esse método gerará um InvalidOperation erro e não alterará a senha. Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e não alterará a senha.

setPassword(password?: string): void;

Parâmetros

password

string

A senha associada ao WorksheetProtection objeto.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.WorksheetProtection original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetProtectionData) que contém cópias rasas de quaisquer propriedades filho 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

Senha de proteção de planilha.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 para senha ]

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

updateOptions(options)

Altere as opções de proteção de planilha associadas ao WorksheetProtection objeto. A proteção de planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e não alterará as opções de proteção de planilha.

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Parâmetros

options

Excel.WorksheetProtectionOptions

A interface de opções associada ao WorksheetProtection objeto.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]