Excel.TableCollection class

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Add checkboxes to the table.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Change the boolean values to checkboxes.
  range.control = {
    type: Excel.CellControlType.checkbox
  };
  await context.sync();
});

Свойства

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

Методы

add(address, hasHeaders)	Создает таблицу. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке.
getCount()	Получает количество таблиц в коллекции.
getItem(key)	Получает таблицу по имени или ИД.
getItemAt(index)	Получает таблицу на основании ее позиции в коллекции.
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.TableCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.TableCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

События

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

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 этот параметр должен быть строкой. Начиная с Excel API 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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Remove checkboxes from the table.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Change the checkboxes back to boolean values.
  range.control = {
    type: Excel.CellControlType.empty
  };
  await context.sync();
});

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)

Получает таблицу по имени или ИД. Если таблица не существует, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *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)

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

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)

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

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>

onFiltered

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возникает при применении фильтра к любой таблице книги или листа.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>

Комментарии

Используется

Примеры

Свойства

Методы

События

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

context

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

count

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

Комментарии

items

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

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

add(address, hasHeaders)

Параметры

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

Комментарии

Примеры

getCount()

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

Комментарии

getItem(key)

Параметры

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

Комментарии

Примеры

getItemAt(index)

Параметры

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

Комментарии

Примеры

getItemOrNullObject(key)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

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

onAdded

Тип события

Комментарии

onChanged

Тип события

Комментарии

Примеры

onDeleted

Тип события

Комментарии

onFiltered

Тип события

Комментарии

Обратная связь