Skip to main content

Sheet

This chapter introduces how to configure Sheets to read data.

Reading Multiple Sheets​

Overview​

You can read multiple Sheets from an Excel file, but the same Sheet cannot be read repeatedly.

Code Example​

Reading All Sheets​

@Test
public void readAllSheet() {
    String fileName = "path/to/demo.xlsx";

    FastExcel.read(fileName, DemoData.class, new DemoDataListener()).doReadAll();
}

Reading Specific Sheets​

Overview​

You can read a specific Sheet from an Excel file, supporting specification by Sheet index or name.

Code Example​

@Test
public void readSingleSheet() {
    String fileName = "path/to/demo.xlsx";

    try (ExcelReader excelReader = FastExcel.read(fileName).build()) {
        // Sheet index
        ReadSheet sheet1 = FastExcel.readSheet(0).head(DemoData.class).registerReadListener(new DemoDataListener()).build();
        // Sheet name
        ReadSheet sheet2 = FastExcel.readSheet("Sheet2").head(DemoData.class).registerReadListener(new DemoDataListener()).build();
        excelReader.read(sheet1, sheet2);
    }
}

Ignoring Hidden Sheets​

Overview​

By setting the ignoreHiddenSheet parameter to true, data from Sheets in "hidden" state will not be read. This supports both "normal hidden" and "very hidden" states.

Code Example​

@Test
public void exceptionRead() {
    String fileName = "path/to/demo.xlsx";

    FastExcel.read(fileName, DemoData.class, new DemoDataListener())
            .ignoreHiddenSheet(Boolean.TRUE)
            .sheet()
            .doRead();
}

In Microsoft Excel, Sheets have two hidden states: "normal hidden (xlSheetHidden)" and "very hidden (xlSheetVeryHidden)". Very hidden can be set through VBA, and in this case, the hidden Sheet cannot be unhidden through the "Unhide" operation.