Excel.AllowEditRangeCollection class
Представляет набор объектов, найденных AllowEditRange на листе.
AllowEditRange объекты работают со свойствами защиты листа. Если защита листа включена AllowEditRange , объект можно использовать, чтобы разрешить редактирование определенного диапазона, сохраняя при этом защиту на остальной части листа.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(title, range |
Добавление |
| get |
Возвращает количество |
| get |
Получает |
| get |
Возвращает |
| get |
Получает |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| pause |
Приостанавливает защиту листа для всех |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.AllowEditRange[];Значение свойства
Сведения о методе
add(title, rangeAddress, options)
Добавление AllowEditRange объекта на лист. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена, но не приостановлена, этот метод выдает AccessDenied ошибку, а операция добавления завершается сбоем.
add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;Параметры
- title
-
string
Строка заголовка добавляемого AllowEditRange объекта.
- rangeAddress
-
string
Адрес диапазона добавляемого AllowEditRange объекта.
- options
- Excel.AllowEditRangeOptions
Дополнительные параметры, которые следует добавить к объекту AllowEditRange , например пароль.
Возвращаемое значение
void
Комментарии
getCount()
Возвращает количество AllowEditRange объектов в семействе.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(key)
Получает AllowEditRange объект по его имени.
getItem(key: string): Excel.AllowEditRange;Параметры
- key
-
string
Название AllowEditRangeфайла .
Возвращаемое значение
С AllowEditRange названием. Если с указанным заголовком ничего нет AllowEditRange , то ItemNotFound выбрасывается ошибка.
Комментарии
getItemAt(index)
Возвращает AllowEditRange объект по его индексу в коллекции.
getItemAt(index: number): Excel.AllowEditRange;Параметры
- index
-
number
Индекс объекта в семействе AllowEditRange .
Возвращаемое значение
По AllowEditRange заданному индексу.
Комментарии
getItemOrNullObject(key)
Получает AllowEditRange объект по его имени.
getItemOrNullObject(key: string): Excel.AllowEditRange;Параметры
- key
-
string
Название AllowEditRangeфайла .
Возвращаемое значение
С AllowEditRange названием.
AllowEditRange Если нет заданного заголовка, то этот метод возвращает объект со свойствомisNullObject, установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;Параметры
- options
-
Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.AllowEditRangeCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
pauseProtection(password)
Приостанавливает защиту листа для всех AllowEditRange найденных на этом листе объектов с заданным паролем для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или приостановлена. Если не удается приостановить защиту листа, этим методом возникает UnsupportedOperation ошибка и не удается приостановить защиту для диапазона. Если пароль не совпадает ни с одним AllowEditRange объектом в коллекции, этот метод выдает BadPassword ошибку и не может приостановить защиту для любого диапазона в коллекции.
pauseProtection(password: string): void;Параметры
- password
-
string
Пароль для приостановки защиты AllowEditRange объектов.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.AllowEditRangeCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.AllowEditRangeCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;