Excel.WorksheetProtection class

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

Свойства

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)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод 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

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

Комментарии

Используется

Свойства

Методы

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

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)

Параметры

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

Комментарии

Обратная связь