TableColumnCollection Object (JavaScript API for Excel)

Represents a collection of all the columns that are part of the table.

Properties

Property Type Description Req. Set
count int Returns the number of columns in the table. Read-only. 1.1
items TableColumn[] A collection of tableColumn objects. Read-only. 1.1

See property access examples.

Relationships

None

Methods

Method Return Type Description Req. Set
add(index: number, values: object, name: string) TableColumn Adds a new column to the table. 1.1
getCount() int Gets the number of columns in the table. 1.4
getItem(key: object) TableColumn Gets a column object by Name or ID. 1.1
getItemAt(index: number) TableColumn Gets a column based on its position in the collection. 1.1
getItemOrNullObject(key: object) TableColumn Gets a column object by Name or ID. If the column does not exist, will return a null object. 1.4

Method Details

add(index: number, values: object, name: string)

Adds a new column to the table.

Syntax

tableColumnCollectionObject.add(index, values, name);

Parameters

Parameter Type Description
index number Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed.
values object Optional. A 2-dimensional array of unformatted values of the table column.
name string Optional. Specifies the name of the new column. If null, the default name will be used.

Returns

TableColumn

Examples

Excel.run(function (ctx) { 
    var tables = ctx.workbook.tables;
    var values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    var column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    return ctx.sync().then(function() {
        console.log(column.name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

getCount()

Gets the number of columns in the table.

Syntax

tableColumnCollectionObject.getCount();

Parameters

None

Returns

int

getItem(key: object)

Gets a column object by Name or ID.

Syntax

tableColumnCollectionObject.getItem(key);

Parameters

Parameter Type Description
key object Column Name or ID.

Returns

TableColumn

Examples

Excel.run(function (ctx) { 
    var tablecolumn = ctx.workbook.tables.getItem('Table1').columns.getItem(0);
    tablecolumn.load('name');
    return ctx.sync().then(function() {
            console.log(tablecolumn.name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Examples

Excel.run(function (ctx) { 
    var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tablecolumn.load('name');
    return ctx.sync().then(function() {
            console.log(tablecolumn.name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

getItemAt(index: number)

Gets a column based on its position in the collection.

Syntax

tableColumnCollectionObject.getItemAt(index);

Parameters

Parameter Type Description
index number Index value of the object to be retrieved. Zero-indexed.

Returns

TableColumn

Examples

Excel.run(function (ctx) { 
    var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tablecolumn.load('name');
    return ctx.sync().then(function() {
            console.log(tablecolumn.name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

getItemOrNullObject(key: object)

Gets a column object by Name or ID. If the column does not exist, will return a null object.

Syntax

tableColumnCollectionObject.getItemOrNullObject(key);

Parameters

Parameter Type Description
key object Column Name or ID.

Returns

TableColumn

Property access examples

Excel.run(function (ctx) { 
    var tablecolumns = ctx.workbook.tables.getItem('Table1').columns;
    tablecolumns.load('items');
    return ctx.sync().then(function() {
        console.log("tablecolumns Count: " + tablecolumns.count);
        for (var i = 0; i < tablecolumns.items.length; i++)
        {
            console.log(tablecolumns.items[i].name);
        }
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});
Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });
g("Error: " + error); if (error instanceof OfficeExtension.Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });
lecolumns.items.length; i++) { console.log(tablecolumns.items[i].name); } }); }).catch(function(error) { console.log("Error: " + error); if (error instanceof OfficeExtension.Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });