Excel.WorksheetProtection class

Указывает объект, найденный AllowEditRangeCollection на этом листе. Это коллекция AllowEditRange объектов, которые работают со свойствами защиты листа. Если включена защита листа, AllowEditRange объект можно использовать для разрешения редактирования определенного диапазона, сохраняя при этом защиту остальной части листа.

readonly allowEditRanges: Excel.AllowEditRangeCollection;

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Указывает, можно ли приостановить защиту для этого листа.

readonly canPauseProtection: boolean;

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

context: RequestContext;

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

Указывает, защищен ли лист паролем.

readonly isPasswordProtected: boolean;

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

readonly isPaused: boolean;

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

readonly options: Excel.WorksheetProtectionOptions;

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

readonly protected: boolean;

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

Указывает параметры защиты, сохраненные на листе. Это вернет один и тот же WorksheetProtectionOptions объект независимо от состояния защиты листа.

readonly savedOptions: Excel.WorksheetProtectionOptions;

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Указывает, можно ли использовать пароль для разблокировки защиты листа. Этот метод не изменяет состояние защиты листа. Если введен пароль, но для разблокировки защиты листа не требуется пароль, этот метод возвращает значение false.

checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;

Параметры

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

Возвращает значение true , если пароль можно использовать для разблокировки защиты листа. В противном случае возвращает .false

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

Приостанавливает защиту листа для заданного объекта листа для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или уже приостановлена. Если пароль неправильный, этот метод выдает ошибку InvalidArgument и не приостанавливает защиту. Этот метод не изменяет состояние защиты, если защита листа не включена или уже приостановлена.

pauseProtection(password?: string): void;

Параметры

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

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

Возобновляет защиту листа для заданного объекта листа для пользователя в заданном сеансе. Чтобы этот метод работал, защита листа должна быть приостановлена. Если защита листа не приостановлена, этот метод не изменит состояние защиты листа.

resumeProtection(): void;

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Изменяет пароль, связанный WorksheetProtection с объектом . Установка пароля в качестве пустой строки ("") или "как null " приведет к удалению защиты паролем WorksheetProtection для объекта . Чтобы этот метод работал правильно, необходимо включить и приостановить защиту листа. Если защита листа отключена, этот метод выдает ошибку InvalidOperation и не изменяет пароль. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и не изменяет пароль.

setPassword(password?: string): void;

Параметры

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

toJSON(): Excel.Interfaces.WorksheetProtectionData;

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

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

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

Измените параметры защиты листа, связанные с WorksheetProtection объектом . Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и не изменяет параметры защиты листа.

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Параметры

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]