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

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
options	Especifica las opciones de protección de la hoja de cálculo.
protected	Especifica si la hoja de cálculo está protegida.

Métodos

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.
protect(options, password)	Protege una hoja de cálculo. Se produce un error si la hoja de cálculo ya se ha protegido.
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 original Excel.WorksheetProtection 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.

Detalles de las propiedades

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

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 ]

Detalles del método

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

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

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 original Excel.WorksheetProtection 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);
});