getColumnHeaderAutoTextIndex Method

Gets which column header row displays the automatic text when there are multiple column header rows.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Sheet(name);
var value; // Type: number
value = instance.getColumnHeaderAutoTextIndex();

function getColumnHeaderAutoTextIndex() : number;

Return Value

The row index of the column header that displays the automatic text.

Example

This example returns the settings for the column and row headers.

Javascript

activeSheet.setRowCount(2,GcSpread.Sheets.SheetArea.colHeader);
activeSheet.setColumnCount(2,GcSpread.Sheets.SheetArea.rowHeader);
activeSheet.setValue(0, 2,"Column",GcSpread.Sheets.SheetArea.colHeader);
activeSheet.setRowHeaderAutoTextIndex(1);
activeSheet.setRowHeaderAutoText( GcSpread.Sheets.HeaderAutoText.letters);
activeSheet.setColHeaderAutoTextIndex(1);
activeSheet.setColHeaderAutoText(GcSpread.Sheets.HeaderAutoText.numbers);
var htext = activeSheet.getColumnHeaderAutoText();
var hindex = activeSheet.getColumnHeaderAutoTextIndex();
var hvisible = activeSheet.getColumnHeaderVisible();
alert(htext);
alert(hindex);
alert(hvisible);

Remarks

The default value is the bottom-most row, specified by -1.

Reference

Sheet type