getColumnName Method

In This Topic

Gets the table header text with the specified table index.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.Tables.Table(name,
                                                row,
                                                col,
                                                rowCount,
                                                colCount,
                                                style,
                                                options,
                                                options.showHeader,
                                                options.showFooter,
                                                options.useFooterDropDownList,
                                                options.showResizeHandle);
var value; // Type: string
value = instance.getColumnName(tableColumnIndex);

function getColumnName( 
   tableColumnIndex : number
) : string;

Parameters

tableColumnIndex: The column index of the table header. The index is zero-based.

Return Value

The header text of the specified column by index.

Example

This example creates a table.

Javascript

//Add data
for (var col = 1; col < 6; col++) {
    for (var row = 2; row < 11; row++) {
        activeSheet.setValue(row, col, row + col);
    }
}

var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
sTable.showFooter(true);
sTable.setColumnName(4, "SUM");
//set footer value
sTable.setColumnValue(0, "Total");
//set footer formula
sTable.setColumnFormula(4, "SUM(F3:F11)");
var value = sTable.getColumnName(4);
alert(value);

Reference

Table type

Product Support Forum | Print this page