Excel.AllowEditRangeCollection class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Свойства

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

Методы

add(title, rangeAddress, options)	AllowEditRange Добавляет объект на лист. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и операция добавления завершается ошибкой.
getCount()	Возвращает количество AllowEditRange объектов в коллекции.
getItem(key)	Возвращает объект по AllowEditRange его заголовку.
getItemAt(index)	AllowEditRange Возвращает объект по индексу в коллекции.
getItemOrNullObject(key)	Возвращает объект по AllowEditRange его заголовку.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
pauseProtection(password)	Приостанавливает защиту листа для всех AllowEditRange объектов, найденных на этом листе с заданным паролем для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или приостановлена. Если не удается приостановить защиту листа, этот метод выдает ошибку UnsupportedOperation и не может приостановить защиту для диапазона. Если пароль не соответствует ни одному AllowEditRange объекту в коллекции, этот метод выдает ошибку BadPassword и не может приостановить защиту для любого диапазона в коллекции.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.AllowEditRangeCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.AllowEditRangeCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.AllowEditRange[];

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

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

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

getCount()

Возвращает количество AllowEditRange объектов в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

getItem(key)

Возвращает объект по AllowEditRange его заголовку.

getItem(key: string): Excel.AllowEditRange;

Параметры

key

string

Заголовок AllowEditRangeобъекта .

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

Excel.AllowEditRange

Объект AllowEditRange с заголовком. Если с заданным заголовком нет AllowEditRange , ItemNotFound возникает ошибка.

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

getItemAt(index)

AllowEditRange Возвращает объект по индексу в коллекции.

getItemAt(index: number): Excel.AllowEditRange;

Параметры

index

number

Индекс AllowEditRange объекта в коллекции.

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

Excel.AllowEditRange

Объект AllowEditRange по заданному индексу.

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Возвращает объект по AllowEditRange его заголовку.

getItemOrNullObject(key: string): Excel.AllowEditRange;

Параметры

key

string

Заголовок AllowEditRangeобъекта .

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

Excel.AllowEditRange

Объект AllowEditRange с заголовком. Если с заданным заголовком нетAllowEditRange, то этот метод возвращает объект со свойством trueisNullObject. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;

Параметры

options

Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.AllowEditRangeCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.AllowEditRangeCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.AllowEditRangeCollection

pauseProtection(password)

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

pauseProtection(password: string): void;

Параметры

password

string

Пароль для приостановки защиты AllowEditRange объектов.

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

toJSON()

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

toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;

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

Excel.Interfaces.AllowEditRangeCollectionData