ExcelScript.WorksheetProtection interface

Adiciona um AllowEditRange objeto à planilha. A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e a operação adicionar falhará.

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

Parâmetros

Retornos

Exemplos

/**
 * This script adds a password-protected, editable range
 * to an otherwise protected worksheet.
 */
function main(workbook: ExcelScript.Workbook, password: string) {
    // Get the protection object for the "Data" worksheet.
    const dataSheet = workbook.getWorksheet("Data");
    const sheetProtection = dataSheet.getProtection();

    // Set the password needed to edit the range to be the user provided string.
    const editRangeProperties : ExcelScript.AllowEditRangeOptions = {
        password: password
    };

    // Set range "D2:D6" to be editable if the password is provided.
    sheetProtection.addAllowEditRange("Notes Section", "D2:D6", editRangeProperties);
    
    // Protect the worksheet.
    sheetProtection.protect();
}

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

checkPassword(password?: string): boolean;

Parâmetros

Retornos

Recebe o AllowEditRange objeto pelo título.

getAllowEditRange(key: string): AllowEditRange | undefined;

Parâmetros

Retornos

Especifica o AllowEditRangeCollection objeto encontrado nesta planilha. Esta é uma coleção de objetos que funcionam com propriedades de proteção de AllowEditRange planilha. Quando a proteção da 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

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

getCanPauseProtection(): boolean;

Retornos

Especifica se a planilha é protegida por senha.

getIsPasswordProtected(): boolean;

Retornos

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

getIsPaused(): boolean;

Retornos

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

getOptions(): WorksheetProtectionOptions;

Retornos

Especifica se a planilha está protegida.

getProtected(): boolean;

Retornos

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

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

pauseProtection(password?: string): void;

Parâmetros

Retornos

Pausa a proteção da planilha para todos os AllowEditRange objetos encontrados nesta planilha que tenham a senha fornecida para o usuário na sessão atual. Esse método não fará nada se a proteção da planilha não estiver habilitada ou estiver pausada. Se a proteção da planilha não puder ser pausada, esse método gerará um UnsupportedOperation erro e não pausará a proteção do intervalo. Se a senha não corresponder a nenhum AllowEditRange objeto na coleção, esse método gerará um BadPassword erro e falhará ao pausar a proteção para nenhum intervalo na coleção.

pauseProtectionForAllAllowEditRanges(password: string): void;

Parâmetros

Retornos

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

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

Parâmetros

Retornos

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

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

resumeProtection(): void;

Retornos

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

Retornos

Desprotege uma planilha.

unprotect(password?: string): void;

Parâmetros

Retornos

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

updateOptions(options: WorksheetProtectionOptions): void;

Parâmetros

Retornos