Excel.TableColumnCollection class

Ссылка

Пакет:: excel

Представляет коллекцию всех столбцов, включенных в таблицу.

Extends: OfficeExtension.ClientObject

Свойства

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

Методы

add(index, values, name)	Добавляет новый столбец в таблицу.
addAsJson(index, values, name)	Добавляет новый столбец в таблицу. В отличие от `add()`принимает `addAsJson()` любой тип значения ячейки, например изображения или типы данных сущности.
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.TableColumnCollection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.TableColumnCollectionData`), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

count

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

readonly count: number;

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

number

items

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

readonly items: Excel.TableColumn[];

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

Excel.TableColumn[]

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

add(index, values, name)

Добавляет новый столбец в таблицу.

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;

Параметры

index: number

Необязательный параметр. Определяет относительную позицию нового столбца. Если задано значение null или -1, столбец добавляется в конце. Столбцы с более высокими значениями индекса смещаются в сторону. Используется нулевой индекс.

values: Array<Array<boolean | string | number>> | boolean | string | number

Необязательный параметр. Двухразовой массив неформатированных значений столбца таблицы.

name: string

Необязательный параметр. Задает имя нового столбца. Если nullзадано значение , будет использоваться имя по умолчанию.

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

Excel.TableColumn

[ Набор API. Для ExcelApi 1.1 требуется индекс меньше общего числа столбцов; 1.4 позволяет индексу быть необязательным (null или -1) и добавлять столбец в конце; 1.4 разрешает параметр name во время создания. ]

Примеры

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    const column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    await context.sync();
    
    console.log(column.name);
});

addAsJson(index, values, name)

Добавляет новый столбец в таблицу. В отличие от add()принимает addAsJson() любой тип значения ячейки, например изображения или типы данных сущности.

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;

Параметры

index: number

values: Excel.CellValue[][]

Необязательный параметр. Двухмерный массив значений ячеек столбца таблицы.

name: string

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

Excel.TableColumn

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

getItem(key)

Возвращает объект столбца по имени или идентификатору.

getItem(key: number | string): Excel.TableColumn;

Параметры

key: number | string

Имя или идентификатор столбца.

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

Excel.TableColumn

Примеры

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem('Table1').columns.getItem(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

getItemAt(index)

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

getItemAt(index: number): Excel.TableColumn;

Параметры

index: number

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

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

Excel.TableColumn

Примеры

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

getItemOrNullObject(key)

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

getItemOrNullObject(key: number | string): Excel.TableColumn;

Параметры

key: number | string

Имя или идентификатор столбца.

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

Excel.TableColumn

load(options)

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

load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;

Параметры

options: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.TableColumnCollection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.TableColumnCollection

Примеры

await Excel.run(async (context) => { 
    const tableColumns = context.workbook.tables.getItem('Table1').columns;
    tableColumns.load('items');
    await context.sync();
    
    console.log("tableColumns Count: " + tableColumns.count);
    for (let i = 0; i < tableColumns.items.length; i++) {
        console.log(tableColumns.items[i].name);
    }
});

load(propertyNamesAndPaths)

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

Excel.TableColumnCollection

toJSON()

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

toJSON(): Excel.Interfaces.TableColumnCollectionData;

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

Excel.Interfaces.TableColumnCollectionData

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

Excel.TableColumnCollection class

Комментарии

Свойства

Методы

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

context

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

count

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

Комментарии

items

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

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

add(index, values, name)

Параметры

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

Комментарии

Примеры

addAsJson(index, values, name)

Параметры

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

Комментарии

getCount()

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

Комментарии

getItem(key)

Параметры

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

Комментарии

Примеры

getItemAt(index)

Параметры

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

Комментарии

Примеры

getItemOrNullObject(key)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

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