Excel.WorksheetProtection interface

Representa a proteção de um objeto sheet.

Propriedades

options

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

protected

Especifica se a planilha 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(options, password)

Protege uma planilha. Falhará se a planilha já tiver sido protegida.

unprotect(password)

Desprotege uma planilha.

Detalhes da propriedade

options

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

readonly options: WorksheetProtectionOptions;

Valor da propriedade

protected

Especifica se a planilha 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(options, password)

Protege uma planilha. Falhará se a planilha já tiver sido protegida.

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

Parâmetros

options
WorksheetProtectionOptions

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

password
string

Opcional. Senha de proteção da planilha.

Retornos

void

Exemplos

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

    await context.sync();

    if (!activeSheet.protection.protected) {
        activeSheet.protection.protect();
    }
}

unprotect(password)

Desprotege uma planilha.

unprotect(password?: string): void;

Parâmetros

password
string

Senha de proteção para a planilha.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect();
}