Excel.TableCollection class

Ссылка

Пакет:: excel

Представляет коллекцию всех таблиц, входящих в состав книги или листа, в зависимости от способа доступа.

Extends: OfficeExtension.ClientObject

Свойства

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

Методы

add(address, hasHeaders)	Создает таблицу. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке.
getCount()	Получает количество таблиц в коллекции.
getItem(key)	Получает таблицу по имени или ИД.
getItemAt(index)	Получает таблицу на основании ее позиции в коллекции.
getItemOrNullObject(key)	Получает таблицу по имени или ИД. Если таблица не существует, этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.TableCollection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.TableCollectionData`), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

События

onAdded	Происходит при добавлении новой таблицы в книгу.
onChanged	Происходит при изменении данных в любой таблице в книге или листе.
onDeleted	Возникает, если указанная таблица удалена из книги.

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

context

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

context: RequestContext;

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

Excel.RequestContext

count

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

readonly count: number;

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

number

items

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

readonly items: Excel.Table[];

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

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 автоматически создаст заголовок и сместит данные вниз на одну строку.

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

Excel.Table

Примеры

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

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

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

Excel.Table

Примеры

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

Значение индекса получаемого объекта. Используется нулевой индекс.

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

Excel.Table

Примеры

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

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

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

Excel.Table

load(options)

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

load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;

Параметры

options: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.TableCollection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.TableCollection

Примеры

// 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)

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

Excel.TableCollection

toJSON()

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

toJSON(): Excel.Interfaces.TableCollectionData;

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

Excel.Interfaces.TableCollectionData

Сведения о событии

onAdded

Происходит при добавлении новой таблицы в книгу.

readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>

onChanged

Происходит при изменении данных в любой таблице в книге или листе.

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

Тип события

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>;

Тип события

OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>

Поделиться через

Excel.TableCollection class

Комментарии

Свойства

Методы

События

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

context

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

count

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

Комментарии

items

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

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

add(address, hasHeaders)

Параметры

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

Комментарии

Примеры

getCount()

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

Комментарии

getItem(key)

Параметры

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

Комментарии

Примеры

getItemAt(index)

Параметры

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

Комментарии

Примеры

getItemOrNullObject(key)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

Сведения о событии

onAdded

Тип события

Комментарии

onChanged

Тип события

Комментарии

Примеры

onDeleted

Тип события

Комментарии

Дополнительные ресурсы