Excel.TableColumn class

Ссылка

Пакет:: excel

Представляет столбец в таблице.

Extends: OfficeExtension.ClientObject

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
filter	Извлекает фильтр, примененный к столбцу.
id	Возвращает уникальный ключ, идентифицирующий столбец в таблице.
index	Возвращает номер индекса столбца в коллекции столбцов таблицы. Используется нулевой индекс.
name	Указывает имя столбца таблицы.
values	Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

Методы

delete()	Удаляет столбец из таблицы.
getDataBodyRange()	Получает объект диапазона, связанный с текстом данных столбца.
getHeaderRowRange()	Получает объект диапазона, связанный со строкой заголовков столбца.
getRange()	Получает объект диапазона, связанный со всем столбцом.
getTotalRowRange()	Получает объект диапазона, связанный со строкой итогов столбца.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.TableColumn является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.TableColumnData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

filter

Извлекает фильтр, примененный к столбцу.

readonly filter: Excel.Filter;

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

Excel.Filter

id

Возвращает уникальный ключ, идентифицирующий столбец в таблице.

readonly id: number;

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

number

index

Возвращает номер индекса столбца в коллекции столбцов таблицы. Используется нулевой индекс.

readonly index: number;

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

number

name

Указывает имя столбца таблицы.

name: string;

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

string

values

Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

values: any[][];

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

any[][]

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

delete()

Удаляет столбец из таблицы.

delete(): void;

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

void

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
    column.delete();
    await context.sync(); 
});

getDataBodyRange()

Получает объект диапазона, связанный с текстом данных столбца.

getDataBodyRange(): Excel.Range;

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

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const dataBodyRange = column.getDataBodyRange();
    dataBodyRange.load('address');
    await context.sync();
    
    console.log(dataBodyRange.address);
});

getHeaderRowRange()

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

getHeaderRowRange(): Excel.Range;

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

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const headerRowRange = columns.getHeaderRowRange();
    headerRowRange.load('address');
    await context.sync();
    
    console.log(headerRowRange.address);
});

getRange()

Получает объект диапазона, связанный со всем столбцом.

getRange(): Excel.Range;

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

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const columnRange = columns.getRange();
    columnRange.load('address');
    await context.sync();
    
    console.log(columnRange.address);
});

getTotalRowRange()

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

getTotalRowRange(): Excel.Range;

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

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const totalRowRange = columns.getTotalRowRange();
    totalRowRange.load('address');
    await context.sync();
    
    console.log(totalRowRange.address);
});

load(options)

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

load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn;

Параметры

options: Excel.Interfaces.TableColumnLoadOptions

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

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

Excel.TableColumn

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.TableColumn

Примеры

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

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TableColumn;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

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

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

Excel.TableColumn

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.TableColumnUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.TableColumn): void;

Параметры

properties: Excel.TableColumn

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

void

toJSON()

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

toJSON(): Excel.Interfaces.TableColumnData;

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

Excel.Interfaces.TableColumnData

Excel.TableColumn class

Комментарии

Свойства

Методы

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

context

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

filter

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

Комментарии

id

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

Комментарии

index

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

Комментарии

name

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

Комментарии

values

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

Комментарии

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

delete()

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

Комментарии

Примеры

getDataBodyRange()

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

Комментарии

Примеры

getHeaderRowRange()

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

Комментарии

Примеры

getRange()

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

Комментарии

Примеры

getTotalRowRange()

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

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

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