startSheetIndex Method

Gets or sets the index of the first sheet to display in the spreadsheet.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.Workbook(host);
var returnValue; // Type: any
returnValue = instance.startSheetIndex(value);

function startSheetIndex( 
   value : number
) : any;

Parameters

value: The index of the first sheet to display in the spreadsheet.

Return Value

If no value is set, returns the index of the first sheet displayed in the spreadsheet; otherwise, returns the spreadsheet.

Example

This example puts three sheets in a spreadsheet, specifies the first sheet to display, and sets the tab color for the sheets.

Javascript

spread.setSheetCount(3);
spread.startSheetIndex(0);
spread.getSheet(0).options.sheetTabColor = "red";
spread.getSheet(1).options.sheetTabColor = "#FFFF00";
spread.getSheet(2).options.sheetTabColor = "Accent 4";

Remarks

The default value is 0.

Reference

Workbook type