Excel.TableCollection class
Представляет коллекцию всех таблиц, входящих в состав книги или листа, в зависимости от способа доступа.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| count | Возвращает количество таблиц в книге. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(address, has |
Создает таблицу. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке. |
| get |
Получает количество таблиц в коллекции. |
| get |
Получает таблицу по имени или ИД. |
| get |
Получает таблицу на основании ее позиции в коллекции. |
| get |
Получает таблицу по имени или ИД. Если таблица не существует, этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
События
| on |
Происходит при добавлении новой таблицы в книгу. |
| on |
Происходит при изменении данных в любой таблице в книге или листе. |
| on |
Возникает, если указанная таблица удалена из книги. |
| on |
Происходит при применении фильтра к любой таблице в книге или листе. |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
count
Возвращает количество таблиц в книге.
readonly count: number;Значение свойства
number
Комментарии
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.Table[];Значение свойства
Сведения о методе
add(address, hasHeaders)
Создает таблицу. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке.
add(address: Range | string, hasHeaders: boolean): Excel.Table;Параметры
- address
-
Excel.Range | string
Объект Range или строковый адрес или имя диапазона, представляющего источник данных. Если адрес не содержит имя листа, используется текущий активный лист. [Набор API: ExcelApi 1.1 / 1.3. До версии ExcelApi 1.3 этот параметр должен быть строкой. Начиная с Api Excel 1.3, этот параметр может быть объектом Range или строкой.]
- hasHeaders
-
boolean
Логическое значение, указывающее, имеют ли импортируемые данные метки столбцов. Если источник не содержит заголовки (т. е. если для этого свойства задано значение false), Excel автоматически создаст заголовок и сместит данные вниз на одну строку.
Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const table = context.workbook.tables.add('Sheet1!A1:E7', true);
table.load('name');
await context.sync();
console.log(table.name);
});
getCount()
Получает количество таблиц в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(key)
Получает таблицу по имени или ИД.
getItem(key: string): Excel.Table;Параметры
- key
-
string
Имя или ИД получаемой таблицы.
Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.load('name');
await context.sync();
console.log(table.name);
});
getItemAt(index)
Получает таблицу на основании ее позиции в коллекции.
getItemAt(index: number): Excel.Table;Параметры
- index
-
number
Значение индекса получаемого объекта. Используется нулевой индекс.
Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const table = context.workbook.tables.getItemAt(0);
table.load('name');
await context.sync();
console.log(table.name);
});
getItemOrNullObject(key)
Получает таблицу по имени или ИД. Если таблица не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Excel.Table;Параметры
- key
-
string
Имя или ИД получаемой таблицы.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TableCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
// Get the number of tables.
await Excel.run(async (context) => {
const tables = context.workbook.tables;
tables.load('count');
await context.sync();
console.log(tables.count);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TableCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.TableCollectionData;Возвращаемое значение
Сведения о событии
onAdded
Происходит при добавлении новой таблицы в книгу.
readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;Тип события
Комментарии
onChanged
Происходит при изменении данных в любой таблице в книге или листе.
readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;Тип события
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml
await Excel.run(async (context) => {
let tables = context.workbook.tables;
tables.onChanged.add(onChange);
await context.sync();
console.log("A handler has been registered for the table collection onChanged event");
});
onDeleted
Возникает, если указанная таблица удалена из книги.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;Тип события
Комментарии
onFiltered
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Происходит при применении фильтра к любой таблице в книге или листе.
readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;Тип события
Комментарии
[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
Office Add-ins