How to convert hidden worksheets alone to image?

25 May 20233 minutes to read

Worksheet hiding and unhiding can be achieved easily through Visibility property of IWorksheet interface. Essential XlsIO also supports strong hidden, which makes the worksheet very hidden and cannot be unhidden easily. To know more about strong hidden, please see documentation.

Conversion of only hidden worksheets to image can be achieved using condition check for worksheet visibility. The following complete code example illustrates how to convert hidden worksheets alone to image.

C# [Cross-platform]

using (ExcelEngine excelEngine = new ExcelEngine())
{
  IApplication application = excelEngine.Excel;
  application.DefaultVersion = ExcelVersion.Excel2013;
  application.XlsIORenderer = new XlsIORenderer();

  //Opening workbook with hidden worksheets
  FileStream inputStream = new FileStream("Sample.xlsx", FileMode.Open, FileAccess.Read);
  IWorkbook workbook = application.Workbooks.Open(inputStream);

  //Converting only hidden worksheets to image
  foreach (IWorksheet worksheet in workbook.Worksheets)
  {
    if (worksheet.Visibility == WorksheetVisibility.Hidden)
    {
	  MemoryStream stream = new MemoryStream();
      worksheet.ConvertToImage(1, 1, 5, 5, stream);
    }
  }
}

C# [Windows-specific]

using (ExcelEngine excelEngine = new ExcelEngine())
{
  IApplication application = excelEngine.Excel;
  application.DefaultVersion = ExcelVersion.Excel2013;

  //Opening workbook with hidden worksheets
  IWorkbook workbook = application.Workbooks.Open("Sample.xlsx");

  //Converting only hidden worksheets to image
  foreach (IWorksheet worksheet in workbook.Worksheets)
  {
    if (worksheet.Visibility == WorksheetVisibility.Hidden)
    {
      Image image = worksheet.ConvertToImage(1, 1, 5, 5);
      image.Save(worksheet.Name + ".png", ImageFormat.Png);
    }
  }
}

VB.NET [Windows-specific]

Using excelEngine As ExcelEngine = New ExcelEngine()
  Dim application As IApplication = excelEngine.Excel
  application.DefaultVersion = ExcelVersion.Excel2013

  'Opening workbook with hidden worksheets
  Dim workbook As IWorkbook = application.Workbooks.Open("Sample.xlsx")

  'Converting only hidden worksheets to image
  For Each worksheet As IWorksheet In workbook.Worksheets
    If (worksheet.Visibility = WorksheetVisibility.Hidden) Then
      Dim image As Image = worksheet.ConvertToImage(1, 1, 5, 5)
      image.Save((worksheet.Name + ".png"), ImageFormat.Png)
    End If
  Next
End Using