Excel.AllowEditRange class

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

address	Указывает диапазон, связанный с объектом. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена, но не приостановлена, этот метод выдает `AccessDenied` ошибку и не может задать диапазон.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
isPasswordProtected	Указывает, защищен ли объект паролем.
title	Задает название объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена, но не приостановлена, этот метод выдает `AccessDenied` ошибку и не может установить заголовок. Если уже существует строка `AllowEditRange` с такой же строкой, или если строка пустая `null` (""), то этот метод выдает `InvalidArgument` ошибку и не может установить заголовок.

Методы

delete()	Удаляет объект из `AllowEditRangeCollection`файла . Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена, но не приостановлена, этот метод выдает `AccessDenied` ошибку и не удается удалить лист.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
pauseProtection(password)	Приостанавливает защиту листа для объекта для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или уже приостановлена. Если невозможно приостановить защиту листа, этим методом возникает `UnsupportedOperation` ошибка и не удается приостановить защиту для объекта. Если пароль неправильный, то этот метод выдает `BadPassword` ошибку и не может приостановить защиту для объекта. Если пароль указан, но объект не требует пароля, введенный пароль будет проигнорирован и операция будет успешной.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setPassword(password)	Изменяет пароль, связанный с объектом. Установка пустой строки пароля ("") или `null` снятие защиты паролем с объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена, но не приостановлена, этот метод выдает `AccessDenied` ошибку, и операция set завершается сбоем.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.AllowEditRange` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.AllowEditRangeData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

address

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

address: string;

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

string

context

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

context: RequestContext;

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

Excel.RequestContext

isPasswordProtected

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

readonly isPasswordProtected: boolean;

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

boolean

title

Задает название объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена, но не приостановлена, этот метод выдает AccessDenied ошибку и не может установить заголовок. Если уже существует строка AllowEditRange с такой же строкой, или если строка пустая null (""), то этот метод выдает InvalidArgument ошибку и не может установить заголовок.

title: string;

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

string

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

delete()

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

delete(): void;

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

void

load(options)

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

load(options?: Excel.Interfaces.AllowEditRangeLoadOptions): Excel.AllowEditRange;

Параметры

options: Excel.Interfaces.AllowEditRangeLoadOptions

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

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

Excel.AllowEditRange

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.AllowEditRange

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.AllowEditRange

pauseProtection(password)

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

pauseProtection(password?: string): void;

Параметры

password: string

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

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

void

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.AllowEditRangeUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.AllowEditRange): void;

Параметры

properties: Excel.AllowEditRange

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

void

setPassword(password)

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

setPassword(password?: string): void;

Параметры

password: string

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

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

void

toJSON()

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

toJSON(): Excel.Interfaces.AllowEditRangeData;

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

Excel.Interfaces.AllowEditRangeData

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

Были ли сведения на этой странице полезными?

Excel.AllowEditRange class

Комментарии

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

Свойства

Методы

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

address

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

Комментарии

context

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

isPasswordProtected

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

Комментарии

title

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

Комментарии

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

delete()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

pauseProtection(password)

Параметры

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

Комментарии

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setPassword(password)

Параметры

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

Комментарии

toJSON()

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

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