Excel.WorksheetProtection class

Paquete:

excel

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

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Propiedades

allowEditRanges	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.
canPauseProtection	Especifica si la protección se puede pausar para esta hoja de cálculo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
isPasswordProtected	Especifica si la hoja está protegida con contraseña.
isPaused	Especifica si la protección de la hoja de cálculo está en pausa.
options	Especifica las opciones de protección de la hoja de cálculo.
protected	Especifica si la hoja de cálculo está protegida.
savedOptions	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.

Métodos

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.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
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.
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.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.WorksheetProtection original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorksheetProtectionData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
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 de las propiedades

allowEditRanges

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.

readonly allowEditRanges: Excel.AllowEditRangeCollection;

Valor de propiedad

Excel.AllowEditRangeCollection

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

canPauseProtection

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

readonly canPauseProtection: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

isPasswordProtected

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

readonly isPasswordProtected: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

isPaused

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

readonly isPaused: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

options

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

readonly options: Excel.WorksheetProtectionOptions;

Valor de propiedad

Excel.WorksheetProtectionOptions

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

protected

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

readonly protected: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

savedOptions

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.

readonly savedOptions: Excel.WorksheetProtectionOptions;

Valor de propiedad

Excel.WorksheetProtectionOptions

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalles del método

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

Parámetros

password

string

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

Devoluciones

OfficeExtension.ClientResult<boolean>

Devuelve true si la contraseña se puede usar para desbloquear la protección de la hoja de cálculo. De lo contrario, devuelve false.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;

Parámetros

options

Excel.Interfaces.WorksheetProtectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.WorksheetProtection

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.WorksheetProtection;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.WorksheetProtection

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.WorksheetProtection;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.WorksheetProtection

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

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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?: Excel.WorksheetProtectionOptions, password?: string): void;

Parámetros

options

Excel.WorksheetProtectionOptions

Opcional. Opciones de protección de la hoja.

password

string

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

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 para opciones; 1.7 para contraseña ]

Ejemplos

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

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

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.WorksheetProtection original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorksheetProtectionData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Devoluciones

Excel.Interfaces.WorksheetProtectionData

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

Comentarios

[ Conjunto de API: ExcelApi 1.7 for password ]

Ejemplos

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

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

Parámetros

options

Excel.WorksheetProtectionOptions

Interfaz de opciones asociada al WorksheetProtection objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]