Excel.WorksheetProtection class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

allowEditRanges	Указывает объект, найденный `AllowEditRangeCollection` на этом листе. Это коллекция `AllowEditRange` объектов, которые работают со свойствами защиты листа. Если включена защита листа, `AllowEditRange` объект можно использовать для разрешения редактирования определенного диапазона, сохраняя при этом защиту остальной части листа.
canPauseProtection	Указывает, можно ли приостановить защиту для этого листа.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
isPasswordProtected	Указывает, защищен ли лист паролем.
isPaused	Указывает, приостановлена ли защита листа.
options	Задает параметры защиты для листа.
protected	Указывает, защищен ли лист.
savedOptions	Указывает параметры защиты, сохраненные на листе. Это вернет один и тот же `WorksheetProtectionOptions` объект независимо от состояния защиты листа.

Методы

checkPassword(password)	Указывает, можно ли использовать пароль для разблокировки защиты листа. Этот метод не изменяет состояние защиты листа. Если введен пароль, но для разблокировки защиты листа не требуется пароль, этот метод возвращает значение false.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
pauseProtection(password)	Приостанавливает защиту листа для заданного объекта листа для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или уже приостановлена. Если пароль неправильный, этот метод выдает ошибку `InvalidArgument` и не приостанавливает защиту. Этот метод не изменяет состояние защиты, если защита листа не включена или уже приостановлена.
protect(options, password)	Защищает лист. Сбой, если лист уже защищен.
resumeProtection()	Возобновляет защиту листа для заданного объекта листа для пользователя в заданном сеансе. Чтобы этот метод работал, защита листа должна быть приостановлена. Если защита листа не приостановлена, этот метод не изменит состояние защиты листа.
setPassword(password)	Изменяет пароль, связанный `WorksheetProtection` с объектом . Установка пароля в качестве пустой строки ("") или "как `null` " приведет к удалению защиты паролем `WorksheetProtection` для объекта . Чтобы этот метод работал правильно, необходимо включить и приостановить защиту листа. Если защита листа отключена, этот метод выдает ошибку `InvalidOperation` и не изменяет пароль. Если защита листа включена и не приостановлена, этот метод выдает ошибку `AccessDenied` и не изменяет пароль.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.WorksheetProtection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.WorksheetProtectionData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
unprotect(password)	Снимает защиту с листа.
updateOptions(options)	Измените параметры защиты листа, связанные с `WorksheetProtection` объектом . Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку `AccessDenied` и не изменяет параметры защиты листа.

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

allowEditRanges

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

readonly allowEditRanges: Excel.AllowEditRangeCollection;

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

Excel.AllowEditRangeCollection

canPauseProtection

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

readonly canPauseProtection: boolean;

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

boolean

context

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

context: RequestContext;

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

Excel.RequestContext

isPasswordProtected

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

readonly isPasswordProtected: boolean;

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

boolean

isPaused

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

readonly isPaused: boolean;

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

boolean

options

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

readonly options: Excel.WorksheetProtectionOptions;

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

Excel.WorksheetProtectionOptions

protected

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

readonly protected: boolean;

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

boolean

savedOptions

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

readonly savedOptions: Excel.WorksheetProtectionOptions;

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

Excel.WorksheetProtectionOptions

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

checkPassword(password)

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

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

Параметры

password: string

Пароль для проверка на защищенном листе.

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

OfficeExtension.ClientResult<boolean>

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

load(options)

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

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

Параметры

options: Excel.Interfaces.WorksheetProtectionLoadOptions

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

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

Excel.WorksheetProtection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.WorksheetProtection

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.WorksheetProtection

pauseProtection(password)

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

pauseProtection(password?: string): void;

Параметры

password: string

Пароль, связанный с защищенным листом.

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

void

protect(options, password)

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

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

Параметры

options: Excel.WorksheetProtectionOptions

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

password: string

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

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

void

Примеры

// 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()

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

resumeProtection(): void;

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

void

setPassword(password)

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

setPassword(password?: string): void;

Параметры

password: string

Пароль, связанный WorksheetProtection с объектом .

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

void

toJSON()

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

toJSON(): Excel.Interfaces.WorksheetProtectionData;

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

Excel.Interfaces.WorksheetProtectionData

unprotect(password)

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

unprotect(password?: string): void;

Параметры

password: string

Пароль защиты листа.

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

void

Примеры

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

updateOptions(options)

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

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Параметры

options: Excel.WorksheetProtectionOptions

Интерфейс параметров, связанный WorksheetProtection с объектом .

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

void

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

Excel.WorksheetProtection class

Комментарии

Свойства

Методы

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

allowEditRanges

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

Комментарии

canPauseProtection

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

Комментарии

context

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

isPasswordProtected

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

Комментарии

isPaused

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

Комментарии

options

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

Комментарии

protected

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

Комментарии

savedOptions

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

Комментарии

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

checkPassword(password)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

pauseProtection(password)

Параметры

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

Комментарии

protect(options, password)

Параметры

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

Комментарии

Примеры

resumeProtection()

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

Комментарии

setPassword(password)

Параметры

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

Комментарии

toJSON()

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

unprotect(password)

Параметры

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

Комментарии

Примеры

updateOptions(options)

Параметры

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

Комментарии

Дополнительные ресурсы