Поделиться через

Excel.WorksheetProtection class

  • Ссылка
Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.2 ]

Свойства

context

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

Задает параметры защиты для листа.
protected

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

Методы

load(options)

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

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

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

Защищает лист. Сбой, если лист уже защищен.
toJSON()

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

options

Задает параметры защиты для листа.

readonly options: Excel.WorksheetProtectionOptions;

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

Excel.WorksheetProtectionOptions

Комментарии

[ Набор API: ExcelApi 1.2 ]

protected

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

readonly protected: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

load(options)

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

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

Параметры

options
Excel.Interfaces.WorksheetProtectionLoadOptions

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

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

Excel.WorksheetProtection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.WorksheetProtection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.WorksheetProtection

protect(options, password)

Защищает лист. Сбой, если лист уже защищен.

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

Параметры

options
Excel.WorksheetProtectionOptions

Необязательный параметр. Параметры защиты листа.

password

string

Необязательный параметр. Пароль защиты листа.

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

void

Комментарии

[ Набор API: ExcelApi 1.2 для параметров; 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 activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.load("protection/protected");

    await context.sync();

    if (!activeSheet.protection.protected) {
        activeSheet.protection.protect(null, password);
    }
});

toJSON()

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

toJSON(): Excel.Interfaces.WorksheetProtectionData;

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

Excel.Interfaces.WorksheetProtectionData