Excel.WorksheetProtection class

Represents the protection of a sheet object.

[ API set: ExcelApi 1.2 ]

Extends

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

options

Specifies the protection options for the worksheet.

[ API set: ExcelApi 1.2 ]

protected

Specifies if the worksheet is protected.

[ API set: ExcelApi 1.2 ]

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

protect(options, password)

Protects a worksheet. Fails if the worksheet has already been protected.

[ API set: ExcelApi 1.2 for options; 1.7 for password ]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.WorksheetProtection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetProtectionData) that contains shallow copies of any loaded child properties from the original object.

unprotect(password)

Unprotects a worksheet.

[ API set: ExcelApi 1.7 for password ]

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

options

Specifies the protection options for the worksheet.

[ API set: ExcelApi 1.2 ]

readonly options: Excel.WorksheetProtectionOptions;

Property Value

protected

Specifies if the worksheet is protected.

[ API set: ExcelApi 1.2 ]

readonly protected: boolean;

Property Value

boolean

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options
Excel.Interfaces.WorksheetProtectionLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

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

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

protect(options, password)

Protects a worksheet. Fails if the worksheet has already been protected.

[ API set: ExcelApi 1.2 for options; 1.7 for password ]

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

Parameters

options
Excel.WorksheetProtectionOptions

Optional. Sheet protection options.

password
string

Optional. Sheet protection password.

Returns

void

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/samples/excel/50-workbook/data-protection.yaml
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();
    }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.WorksheetProtection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetProtectionData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Returns

unprotect(password)

Unprotects a worksheet.

[ API set: ExcelApi 1.7 for password ]

unprotect(password?: string): void;

Parameters

password
string

sheet protection password.

Returns

void

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/samples/excel/50-workbook/data-protection.yaml
await Excel.run(async (context) => {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect();
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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);
});