ExcelScript.WorksheetProtection interface

Paquete:

ExcelScript

Representa la protección de un objeto de hoja de cálculo.

Comentarios

Ejemplos

/**
 * 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)	Agrega un AllowEditRange objeto a la hoja de cálculo. La protección de la hoja de cálculo debe deshabilitarse o pausarse para que este método funcione correctamente. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un error y se produce un AccessDenied error en la operación de adición.
checkPassword(password)	Especifica si la contraseña se puede usar para desbloquear la protección de la hoja de cálculo. Este método no cambia el estado de protección de la hoja de cálculo. Si se escribe una contraseña pero no se requiere ninguna contraseña para desbloquear la protección de la hoja de cálculo, este método devolverá false.
getAllowEditRange(key)	Obtiene el AllowEditRange objeto por su título.
getAllowEditRanges()	Especifica el AllowEditRangeCollection objeto encontrado en esta hoja de cálculo. Se trata de una colección de objetos, que funcionan con propiedades de AllowEditRange protección de hojas de cálculo. Cuando se habilita la protección de la hoja de cálculo, se puede usar un AllowEditRange objeto para permitir la edición de un rango específico, a la vez que se mantiene la protección en el resto de la hoja de cálculo.
getCanPauseProtection()	Especifica si la protección se puede pausar para esta hoja de cálculo.
getIsPasswordProtected()	Especifica si la hoja está protegida con contraseña.
getIsPaused()	Especifica si la protección de la hoja de cálculo está en pausa.
getOptions()	Especifica las opciones de protección de la hoja de cálculo.
getProtected()	Especifica si la hoja de cálculo está protegida.
getSavedOptions()	Especifica las opciones de protección guardadas en la hoja de cálculo. Esto devolverá el mismo WorksheetProtectionOptions objeto independientemente del estado de protección de la hoja de cálculo.
pauseProtection(password)	Pausa la protección de la hoja de cálculo para el objeto de hoja de cálculo especificado para el usuario en la sesión actual. Este método no hace nada si la protección de la hoja de cálculo no está habilitada o ya está en pausa. Si la contraseña es incorrecta, este método produce un InvalidArgument error y no puede pausar la protección. Este método no cambia el estado de protección si la protección de la hoja de cálculo no está habilitada o ya está en pausa.
pauseProtectionForAllAllowEditRanges(password)	Pausa la protección de la hoja de cálculo para todos los AllowEditRange objetos que se encuentran en esta hoja de cálculo que tienen la contraseña especificada para el usuario en la sesión actual. Este método no hace nada si la protección de la hoja de cálculo no está habilitada o está en pausa. Si no se puede pausar la protección de la hoja de cálculo, este método produce un UnsupportedOperation error y no puede pausar la protección para el intervalo. Si la contraseña no coincide con ningún AllowEditRange objeto de la colección, este método produce un BadPassword error y no puede pausar la protección para cualquier intervalo de la colección.
protect(options, password)	Protege una hoja de cálculo. Se produce un error si la hoja de cálculo ya se ha protegido.
resumeProtection()	Reanuda la protección de la hoja de cálculo para el objeto de hoja de cálculo especificado para el usuario en una sesión determinada. La protección de la hoja de cálculo debe estar en pausa para que este método funcione. Si la protección de la hoja de cálculo no está en pausa, este método no cambiará el estado de protección de la hoja de cálculo.
setPassword(password)	Cambia la contraseña asociada al WorksheetProtection objeto . Establecer la contraseña como una cadena vacía ("") o como null quitará la protección con contraseña del WorksheetProtection objeto. La protección de la hoja de cálculo debe estar habilitada y en pausa para que este método funcione correctamente. Si la protección de la hoja de cálculo está deshabilitada, este método produce un InvalidOperation error y no puede cambiar la contraseña. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un AccessDenied error y no puede cambiar la contraseña.
unprotect(password)	Desprotege una hoja de cálculo.
updateOptions(options)	Cambie las opciones de protección de la hoja de cálculo asociadas al WorksheetProtection objeto . La protección de la hoja de cálculo debe deshabilitarse o pausarse para que este método funcione correctamente. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un AccessDenied error y no puede cambiar las opciones de protección de la hoja de cálculo.

Detalles del método

addAllowEditRange(title, rangeAddress, options)

Agrega un AllowEditRange objeto a la hoja de cálculo. La protección de la hoja de cálculo debe deshabilitarse o pausarse para que este método funcione correctamente. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un error y se produce un AccessDenied error en la operación de adición.

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

Parámetros

title

string

Cadena de título del AllowEditRange objeto que se va a agregar.

rangeAddress

string

Dirección del intervalo del AllowEditRange objeto que se va a agregar.

options

ExcelScript.AllowEditRangeOptions

Opciones adicionales que se van a agregar al AllowEditRange objeto, como la contraseña.

Devoluciones

void

Ejemplos

/**
 * 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();
}

checkPassword(password)

Especifica si la contraseña se puede usar para desbloquear la protección de la hoja de cálculo. Este método no cambia el estado de protección de la hoja de cálculo. Si se escribe una contraseña pero no se requiere ninguna contraseña para desbloquear la protección de la hoja de cálculo, este método devolverá false.

checkPassword(password?: string): boolean;

Parámetros

password

string

Contraseña que se va a comprobar en la hoja de cálculo protegida.

Devoluciones

boolean

getAllowEditRange(key)

Obtiene el AllowEditRange objeto por su título.

getAllowEditRange(key: string): AllowEditRange | undefined;

Parámetros

key

string

Título de .AllowEditRange

Devoluciones

ExcelScript.AllowEditRange | undefined

getAllowEditRanges()

Especifica el AllowEditRangeCollection objeto encontrado en esta hoja de cálculo. Se trata de una colección de objetos, que funcionan con propiedades de AllowEditRange protección de hojas de cálculo. Cuando se habilita la protección de la hoja de cálculo, se puede usar un AllowEditRange objeto para permitir la edición de un rango específico, a la vez que se mantiene la protección en el resto de la hoja de cálculo.

getAllowEditRanges(): AllowEditRange[];

Devoluciones

ExcelScript.AllowEditRange[]

getCanPauseProtection()

Especifica si la protección se puede pausar para esta hoja de cálculo.

getCanPauseProtection(): boolean;

Devoluciones

boolean

getIsPasswordProtected()

Especifica si la hoja está protegida con contraseña.

getIsPasswordProtected(): boolean;

Devoluciones

boolean

getIsPaused()

Especifica si la protección de la hoja de cálculo está en pausa.

getIsPaused(): boolean;

Devoluciones

boolean

getOptions()

Especifica las opciones de protección de la hoja de cálculo.

getOptions(): WorksheetProtectionOptions;

Devoluciones

ExcelScript.WorksheetProtectionOptions

getProtected()

Especifica si la hoja de cálculo está protegida.

getProtected(): boolean;

Devoluciones

boolean

getSavedOptions()

Especifica las opciones de protección guardadas en la hoja de cálculo. Esto devolverá el mismo WorksheetProtectionOptions objeto independientemente del estado de protección de la hoja de cálculo.

getSavedOptions(): WorksheetProtectionOptions;

Devoluciones

ExcelScript.WorksheetProtectionOptions

pauseProtection(password)

Pausa la protección de la hoja de cálculo para el objeto de hoja de cálculo especificado para el usuario en la sesión actual. Este método no hace nada si la protección de la hoja de cálculo no está habilitada o ya está en pausa. Si la contraseña es incorrecta, este método produce un InvalidArgument error y no puede pausar la protección. Este método no cambia el estado de protección si la protección de la hoja de cálculo no está habilitada o ya está en pausa.

pauseProtection(password?: string): void;

Parámetros

password

string

Contraseña asociada a la hoja de cálculo protegida.

Devoluciones

void

pauseProtectionForAllAllowEditRanges(password)

Pausa la protección de la hoja de cálculo para todos los AllowEditRange objetos que se encuentran en esta hoja de cálculo que tienen la contraseña especificada para el usuario en la sesión actual. Este método no hace nada si la protección de la hoja de cálculo no está habilitada o está en pausa. Si no se puede pausar la protección de la hoja de cálculo, este método produce un UnsupportedOperation error y no puede pausar la protección para el intervalo. Si la contraseña no coincide con ningún AllowEditRange objeto de la colección, este método produce un BadPassword error y no puede pausar la protección para cualquier intervalo de la colección.

pauseProtectionForAllAllowEditRanges(password: string): void;

Parámetros

password

string

Contraseña para pausar la protección en los AllowEditRange objetos.

Devoluciones

void

protect(options, password)

Protege una hoja de cálculo. Se produce un error si la hoja de cálculo ya se ha protegido.

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

Parámetros

options

ExcelScript.WorksheetProtectionOptions

Opcional. Opciones de protección de la hoja.

password

string

Opcional. Contraseña de protección de hojas.

Devoluciones

void

Ejemplos

/**
 * 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()

Reanuda la protección de la hoja de cálculo para el objeto de hoja de cálculo especificado para el usuario en una sesión determinada. La protección de la hoja de cálculo debe estar en pausa para que este método funcione. Si la protección de la hoja de cálculo no está en pausa, este método no cambiará el estado de protección de la hoja de cálculo.

resumeProtection(): void;

Devoluciones

void

setPassword(password)

Cambia la contraseña asociada al WorksheetProtection objeto . Establecer la contraseña como una cadena vacía ("") o como null quitará la protección con contraseña del WorksheetProtection objeto. La protección de la hoja de cálculo debe estar habilitada y en pausa para que este método funcione correctamente. Si la protección de la hoja de cálculo está deshabilitada, este método produce un InvalidOperation error y no puede cambiar la contraseña. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un AccessDenied error y no puede cambiar la contraseña.

setPassword(password?: string): void;

Parámetros

password

string

Contraseña asociada al WorksheetProtection objeto .

Devoluciones

void

unprotect(password)

Desprotege una hoja de cálculo.

unprotect(password?: string): void;

Parámetros

password

string

Contraseña de protección de hojas.

Devoluciones

void

updateOptions(options)

Cambie las opciones de protección de la hoja de cálculo asociadas al WorksheetProtection objeto . La protección de la hoja de cálculo debe deshabilitarse o pausarse para que este método funcione correctamente. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un AccessDenied error y no puede cambiar las opciones de protección de la hoja de cálculo.

updateOptions(options: WorksheetProtectionOptions): void;

Parámetros

options

ExcelScript.WorksheetProtectionOptions

Interfaz de opciones asociada al WorksheetProtection objeto .

Devoluciones

void