TableColumn Object (JavaScript API for Excel)

Represents a column in a table.

Properties

Property Type Description Req. Set
id int Returns a unique key that identifies the column within the table. Read-only. 1.1
index int Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only. 1.1
name string Represents the name of the table column. 1.1
values object[][] Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. 1.1

See property access examples.

Relationships

Relationship Type Description Req. Set
filter Filter Retrieve the filter applied to the column. Read-only. 1.2

Methods

Method Return Type Description Req. Set
delete() void Deletes the column from the table. 1.1
getDataBodyRange() Range Gets the range object associated with the data body of the column. 1.1
getHeaderRowRange() Range Gets the range object associated with the header row of the column. 1.1
getRange() Range Gets the range object associated with the entire column. 1.1
getTotalRowRange() Range Gets the range object associated with the totals row of the column. 1.1

Method Details

delete()

Deletes the column from the table.

Syntax

tableColumnObject.delete();

Parameters

None

Returns

void

Examples

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(2);
    column.delete();
    return ctx.sync(); 
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

getDataBodyRange()

Gets the range object associated with the data body of the column.

Syntax

tableColumnObject.getDataBodyRange();

Parameters

None

Returns

Range

Examples

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

getHeaderRowRange()

Gets the range object associated with the header row of the column.

Syntax

tableColumnObject.getHeaderRowRange();

Parameters

None

Returns

Range

Examples

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

getRange()

Gets the range object associated with the entire column.

Syntax

tableColumnObject.getRange();

Parameters

None

Returns

Range

Examples

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

getTotalRowRange()

Gets the range object associated with the totals row of the column.

Syntax

tableColumnObject.getTotalRowRange();

Parameters

None

Returns

Range

Examples

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

Property access examples

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

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

results matching ""

    No results matching ""