[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

ISheetTab

Interface ISheetTab

public interface ISheetTab
Represents a sheet tab.

A sheet tab provides information about a worksheet tab in a workbook, including its index, name, and SheetTabType. You can obtain an ISheetTab instance from the sheet tab collection returned by Workbook.getSheetTabs() when the workbook contains sheet tabs.


 String sjsJson = "{\"version\":\"18.0.0\",\"sheetCount\":0,\"sheetTabCount\":1,\"sheetTabs\":{\"TableSheet1\":{\"name\":\"TableSheet1\",\"addition\":{}}}}";
 workbook.fromSjsJson(sjsJson);
 ISheetTabs sheetTabs = workbook.getSheetTabs();
 if (sheetTabs.getCount() > 0) {
     ISheetTab sheetTab = sheetTabs.get(0);
     String name = sheetTab.getName();
     int index = sheetTab.getIndex();
     SheetTabType sheetType = sheetTab.getSheetType();
 }

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getIndex()
    Gets the index of this sheet tab within the workbook's sheet tab collection.
    String
    getName()
    Gets the name of the sheet tab.
    SheetTabType
    getSheetType()
    Gets the type of sheet tab.

  • Method Details

    • getIndex

      int getIndex()
      Gets the index of this sheet tab within the workbook's sheet tab collection. The index starts at 0. 
      
 String sjsJson = "{\"version\":\"18.0.0\",\"sheetCount\":0,\"sheetTabCount\":1,\"sheetTabs\":{\"TableSheet1\":{\"name\":\"TableSheet1\",\"addition\":{}}}}";
 workbook.fromSjsJson(sjsJson);
 ISheetTabs sheetTabs = workbook.getSheetTabs();
 if (sheetTabs.getCount() > 0) {
     ISheetTab sheetTab = sheetTabs.get(0);
     int index = sheetTab.getIndex();
 }
      Returns:
      The index of this sheet tab in the workbook's sheet tab collection. The index starts at 0.

    • getName

      String getName()
      Gets the name of the sheet tab. 
      
 String sjsJson = "{\"version\":\"18.0.0\",\"sheetCount\":0,\"sheetTabCount\":1,\"sheetTabs\":{\"TableSheet1\":{\"name\":\"TableSheet1\",\"addition\":{}}}}";
 workbook.fromSjsJson(sjsJson);
 ISheetTabs sheetTabs = workbook.getSheetTabs();
 if (sheetTabs.getCount() > 0) {
     ISheetTab sheetTab = sheetTabs.get(0);
     String name = sheetTab.getName();
 }
      Returns:
      The name of the sheet tab.

    • getSheetType

      SheetTabType getSheetType()
      Gets the type of sheet tab. 
      
 String sjsJson = "{\"version\":\"18.0.0\",\"sheetCount\":0,\"sheetTabCount\":1,\"sheetTabs\":{\"TableSheet1\":{\"name\":\"TableSheet1\",\"addition\":{}}}}";
 workbook.fromSjsJson(sjsJson);
 ISheetTabs sheetTabs = workbook.getSheetTabs();
 if (sheetTabs.getCount() > 0) {
     ISheetTab sheetTab = sheetTabs.get(0);
     SheetTabType sheetType = sheetTab.getSheetType();
 }
      Returns:
      The type of sheet tab.