Excel.WorksheetProtection class

Especifica o AllowEditRangeCollection objeto encontrado nesta folha de cálculo. Esta é uma coleção de AllowEditRange objetos, que funcionam com propriedades de proteção de folhas de cálculo. Quando a proteção da folha de cálculo está ativada, um AllowEditRange objeto pode ser utilizado para permitir a edição de um intervalo específico, mantendo a proteção no resto da folha de cálculo.

readonly allowEditRanges: Excel.AllowEditRangeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Especifica se a proteção pode ser colocada em pausa para esta folha de cálculo.

readonly canPauseProtection: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

Especifica se a folha está protegida por palavra-passe.

readonly isPasswordProtected: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Especifica se a proteção da folha de cálculo está em pausa.

readonly isPaused: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

readonly options: Excel.WorksheetProtectionOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

readonly protected: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Especifica as opções de proteção guardadas na folha de cálculo. Esta ação irá devolver o mesmo WorksheetProtectionOptions objeto, independentemente do estado de proteção da folha de cálculo.

readonly savedOptions: Excel.WorksheetProtectionOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Especifica se a palavra-passe pode ser utilizada para desbloquear a proteção da folha de cálculo. Este método não altera o estado de proteção da folha de cálculo. Se for introduzida uma palavra-passe, mas não for necessária nenhuma palavra-passe para desbloquear a proteção da folha de cálculo, este método devolverá false.

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

Parâmetros

Retornos

Devolve true se a palavra-passe puder ser utilizada para desbloquear a proteção da folha de cálculo. Caso contrário, devolve false.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

Retornos

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

Retornos

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

Retornos

Coloca em pausa a proteção da folha de cálculo para o objeto de folha de cálculo especificado para o utilizador na sessão atual. Este método não faz nada se a proteção da folha de cálculo não estiver ativada ou já estiver em pausa. Se a palavra-passe estiver incorreta, este método gera um InvalidArgument erro e não interrompe a proteção. Este método não altera o estado de proteção se a proteção da folha de cálculo não estiver ativada ou já estiver em pausa.

pauseProtection(password?: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

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

Parâmetros

Retornos

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

Retoma a proteção da folha de cálculo para o objeto de folha de cálculo especificado para o utilizador numa determinada sessão. A proteção da folha de cálculo tem de ser colocada em pausa para que este método funcione. Se a proteção da folha de cálculo não estiver em pausa, este método não alterará o estado de proteção da folha de cálculo.

resumeProtection(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Altera a palavra-passe associada ao WorksheetProtection objeto. Definir a palavra-passe como uma cadeia vazia ("") ou removerá null a proteção por palavra-passe do WorksheetProtection objeto. A proteção da folha de cálculo tem de estar ativada e colocada em pausa para que este método funcione corretamente. Se a proteção da folha de cálculo estiver desativada, este método gera um InvalidOperation erro e não altera a palavra-passe. Se a proteção da folha de cálculo estiver ativada e não estiver em pausa, este método gera um AccessDenied erro e não altera a palavra-passe.

setPassword(password?: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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 original Excel.WorksheetProtection é 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

Desprotege uma planilha.

unprotect(password?: string): void;

Parâmetros

Retornos

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

Altere as opções de proteção da folha de cálculo associadas ao WorksheetProtection objeto. A proteção da folha de cálculo tem de ser desativada ou colocada em pausa para que este método funcione corretamente. Se a proteção da folha de cálculo estiver ativada e não estiver em pausa, este método gera um AccessDenied erro e não altera as opções de proteção da folha de cálculo.

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]