Excel.TableScopedCollection class
Представляет коллекцию таблиц, ограниченную областью действия. Для каждой таблицы используется ее левый верхний угол, и таблицы сортируются сверху вниз, а затем слева направо.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| get |
Получает количество таблиц в коллекции. |
| get |
Получает первую таблицу в коллекции. Таблицы в коллекции сортируются сверху вниз и слева направо, таким образом, таблица, расположенная слева, является первой таблицей в наборе. |
| get |
Получает таблицу по имени или ИД. |
| get |
Получает таблицу по имени или ИД. Если объект таблицы не существует, этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.Table[];Значение свойства
Сведения о методе
getCount()
Получает количество таблиц в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getFirst()
Получает первую таблицу в коллекции. Таблицы в коллекции сортируются сверху вниз и слева направо, таким образом, таблица, расположенная слева, является первой таблицей в наборе.
getFirst(): Excel.Table;Возвращаемое значение
Комментарии
getItem(key)
Получает таблицу по имени или ИД.
getItem(key: string): Excel.Table;Параметры
- key
-
string
Имя или ИД получаемой таблицы.
Возвращаемое значение
Комментарии
getItemOrNullObject(key)
Получает таблицу по имени или ИД. Если объект таблицы не существует, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Excel.Table;Параметры
- key
-
string
Имя или ИД получаемой таблицы.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TableScopedCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableScopedCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableScopedCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.TableScopedCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.TableScopedCollectionData;