ExcelScript.WorksheetProtection interface

Pacote:

ExcelScript

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

Comentários

Exemplos

/**
 * This script pauses the protection of a worksheet by using the provided password.
 * This password could come from a Power Automate flow.
 */
function main(workbook: ExcelScript.Workbook, password: string) {
  // Get the worksheet named "Sales".
  const sheet = workbook.getWorksheet("Sales");
  const protection: ExcelScript.WorksheetProtection = sheet.getProtection();
  
  // Check if the provided password works.
  if (protection.checkPassword(password)) {
    protection.pauseProtection(password);

    // Edit the worksheet...

    protection.resumeProtection();
  } else {
    console.log("Incorrect password");
  }
}

Métodos

addAllowEditRange(title, rangeAddress, options)	Adiciona um AllowEditRange objeto à planilha. 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 a operação de adição falhará.
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.
getAllowEditRange(key)	Obtém o AllowEditRange objeto pelo título.
getAllowEditRanges()	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.
getCanPauseProtection()	Especifica se a proteção pode ser pausada para esta planilha.
getIsPasswordProtected()	Especifica se a planilha é protegida por senha.
getIsPaused()	Especifica se a proteção de planilha está pausada.
getOptions()	Especifica as opções de proteção para a planilha.
getProtected()	Especifica se a planilha está protegida.
getSavedOptions()	Especifica as opções de proteção salvas na planilha. Isso retornará o mesmo WorksheetProtectionOptions objeto, independentemente do estado de proteção da planilha.
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.
pauseProtectionForAllAllowEditRanges(password)	Pausa a proteção de planilha para todos os AllowEditRange objetos encontrados nesta planilha que têm a senha fornecida 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 for pausada. Se a proteção de planilha não puder ser pausada, esse método gerará um UnsupportedOperation erro e falhará em pausar a proteção para o intervalo. Se a senha não corresponder a nenhum AllowEditRange objeto na coleção, esse método gerará um BadPassword erro e falhará em pausar a proteção para qualquer intervalo na coleção.
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.
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 do método

addAllowEditRange(title, rangeAddress, options)

Adiciona um AllowEditRange objeto à planilha. 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 a operação de adição falhará.

addAllowEditRange(
            title: string,
            rangeAddress: string,
            options?: AllowEditRangeOptions
        ): void;

Parâmetros

title

string

A cadeia de caracteres de título do objeto a AllowEditRange ser adicionado.

rangeAddress

string

O endereço de intervalo do objeto a AllowEditRange ser adicionado.

options

ExcelScript.AllowEditRangeOptions

Opções adicionais a serem adicionadas ao AllowEditRange objeto, como a senha.

Retornos

void

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): boolean;

Parâmetros

password

string

A senha a ser marcar na planilha protegida.

Retornos

boolean

getAllowEditRange(key)

Obtém o AllowEditRange objeto pelo título.

getAllowEditRange(key: string): AllowEditRange | undefined;

Parâmetros

key

string

O título do AllowEditRange.

Retornos

ExcelScript.AllowEditRange | undefined

getAllowEditRanges()

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.

getAllowEditRanges(): AllowEditRange[];

Retornos

ExcelScript.AllowEditRange[]

getCanPauseProtection()

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

getCanPauseProtection(): boolean;

Retornos

boolean

getIsPasswordProtected()

Especifica se a planilha é protegida por senha.

getIsPasswordProtected(): boolean;

Retornos

boolean

getIsPaused()

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

getIsPaused(): boolean;

Retornos

boolean

getOptions()

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

getOptions(): WorksheetProtectionOptions;

Retornos

ExcelScript.WorksheetProtectionOptions

getProtected()

Especifica se a planilha está protegida.

getProtected(): boolean;

Retornos

boolean

getSavedOptions()

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

getSavedOptions(): WorksheetProtectionOptions;

Retornos

ExcelScript.WorksheetProtectionOptions

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

pauseProtectionForAllAllowEditRanges(password)

Pausa a proteção de planilha para todos os AllowEditRange objetos encontrados nesta planilha que têm a senha fornecida 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 for pausada. Se a proteção de planilha não puder ser pausada, esse método gerará um UnsupportedOperation erro e falhará em pausar a proteção para o intervalo. Se a senha não corresponder a nenhum AllowEditRange objeto na coleção, esse método gerará um BadPassword erro e falhará em pausar a proteção para qualquer intervalo na coleção.

pauseProtectionForAllAllowEditRanges(password: string): void;

Parâmetros

password

string

A senha para pausar a proteção nos AllowEditRange objetos.

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

ExcelScript.WorksheetProtectionOptions

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

password

string

Opcional. Senha de proteção de planilha.

Retornos

void

Exemplos

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

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

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

unprotect(password)

Desprotege uma planilha.

unprotect(password?: string): void;

Parâmetros

password

string

Senha de proteção de planilha.

Retornos

void

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: WorksheetProtectionOptions): void;

Parâmetros

options

ExcelScript.WorksheetProtectionOptions

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

Retornos

void