Excel.TableScopedCollection class

Пакет:

excel

Представляет коллекцию таблиц с заданной областью. Для каждой таблицы ее верхний левый угол считается ее расположением привязки, и таблицы сортируются сверху вниз, а затем слева направо.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

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

Методы

getCount()	Получает количество таблиц в коллекции.
getFirst()	Получает первую таблицу в коллекции. Таблицы в коллекции сортируются сверху вниз и слева направо таким образом, что верхняя левая таблица является первой таблицей в коллекции.
getItem(key)	Получает таблицу по имени или ИД.
getItemOrNullObject(key)	Получает таблицу по имени или ИД. Если объект таблицы не существует, то этот метод возвращает объект со свойством , для которых isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TableScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.Table[];

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

Excel.Table[]

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

getCount()

Получает количество таблиц в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.9 ]

getFirst()

Получает первую таблицу в коллекции. Таблицы в коллекции сортируются сверху вниз и слева направо таким образом, что верхняя левая таблица является первой таблицей в коллекции.

getFirst(): Excel.Table;

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

Excel.Table

Комментарии

[ Набор API: ExcelApi 1.9 ]

getItem(key)

Получает таблицу по имени или ИД.

getItem(key: string): Excel.Table;

Параметры

key

string

Имя или ИД получаемой таблицы.

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

Excel.Table

Комментарии

[ Набор API: ExcelApi 1.9 ]

getItemOrNullObject(key)

Получает таблицу по имени или ИД. Если объект таблицы не существует, то этот метод возвращает объект со свойством , для которых isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(key: string): Excel.Table;

Параметры

key

string

Имя или ИД получаемой таблицы.

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

Excel.Table

Комментарии

[ Набор API: ExcelApi 1.14 ]

load(options)

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

load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection;

Параметры

options

Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.TableScopedCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.TableScopedCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.TableScopedCollection

toJSON()

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

toJSON(): Excel.Interfaces.TableScopedCollectionData;

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

Excel.Interfaces.TableScopedCollectionData