Excel.WorkbookProtection class

Пакет:

excel

Представляет защиту объекта книги.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
protected	Указывает, защищена ли книга.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
protect(password)	Защищает книгу. Выдает ошибку, если книга защищена.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.WorkbookProtection является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.WorkbookProtectionData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
unprotect(password)	Снимает защиту с книги.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

protected

Указывает, защищена ли книга.

readonly protected: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection;

Параметры

options

Excel.Interfaces.WorkbookProtectionLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

Excel.WorkbookProtection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.WorkbookProtection

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.WorkbookProtection

protect(password)

Защищает книгу. Выдает ошибку, если книга защищена.

protect(password?: string): void;

Параметры

password

string

Пароль защиты книги.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

// 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 workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

    if (!workbook.protection.protected) {
        workbook.protection.protect(password);
    }
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.WorkbookProtection является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.WorkbookProtectionData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.WorkbookProtectionData;

Возвращаемое значение

Excel.Interfaces.WorkbookProtectionData

unprotect(password)

Снимает защиту с книги.

unprotect(password?: string): void;

Параметры

password

string

Пароль защиты книги.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

// 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 workbook = context.workbook;
    workbook.protection.unprotect(password);
});