Excel.TableColumnCollection interface

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

Свойства

count

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

Методы

add(index, values, name)

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

getCount()

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

getItem(key)

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

getItemAt(index)

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

getItemOrNullObject(key)

Возвращает объект столбца по имени или ИД. Если столбец не существует, возвращает пустой объект.

load(propertyNames)

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

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

count

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

readonly count: number;

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

number

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

add(index, values, name)

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

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

Параметры

index
number

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

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

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

name
string

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

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

getCount()

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

getCount(): ClientResult<number>;

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

ClientResult<number>

getItem(key)

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

getItem(key: number | string): TableColumn;

Параметры

key
number | string

Имя или ИД столбца.

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

getItemAt(index)

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

getItemAt(index: number): TableColumn;

Параметры

index
number

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

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

getItemOrNullObject(key)

Возвращает объект столбца по имени или ИД. Если столбец не существует, возвращает пустой объект.

getItemOrNullObject(key: number | string): TableColumn;

Параметры

key
number | string

Имя или ИД столбца.

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

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void