com.groupdocs.editor.options

Class SpreadsheetToHtmlOptions

  • All Implemented Interfaces:
    IDocumentLoadOptions


    public class SpreadsheetToHtmlOptions
    extends Object
    implements IDocumentLoadOptions

    Allows to specify custom options for loading documents of all supportable Spreadsheet (Excel-compatible) formats

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  SpreadsheetToHtmlOptions.TextLoadOptions
      Subclass for loading text-based Spreadsheet documents (CSV, Tab-based etc.)
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean getExcludeHiddenWorksheets()
      Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored.
      boolean getOptimizeMemoryUsage()
      Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage.
      String getPassword()
      Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded.
      SpreadsheetToHtmlOptions.TextLoadOptions getTextOptions()
      Allows to specify options for loading text-based Spreadsheet documents
      int getWorksheetIndex()
      Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).
      void setExcludeHiddenWorksheets(boolean value)
      Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored.
      void setOptimizeMemoryUsage(boolean value)
      Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage.
      void setPassword(String value)
      Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded.
      void setTextOptions(SpreadsheetToHtmlOptions.TextLoadOptions value)
      Allows to specify options for loading text-based Spreadsheet documents
      void setWorksheetIndex(int value)
      Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).
    • Constructor Detail

      • SpreadsheetToHtmlOptions

        public SpreadsheetToHtmlOptions()
    • Method Detail

      • getExcludeHiddenWorksheets

        public final boolean getExcludeHiddenWorksheets()

        Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.


        Several binary Spreadsheet formats (like XLSX) support hidden worksheets (tabs) concept. Document of such format, if it has more then one worksheet, may contain additional hidden worksheets. By default such hidden worksheets are available for processing, but with this option it is able to ignore them, like these hidden worksheets are absent and don't exist. When this option is enabled, you cannot select hidden worksheet with the 'WorksheetIndex(getWorksheetIndex()/setWorksheetIndex(int))' property.

      • getOptimizeMemoryUsage

        public final boolean getOptimizeMemoryUsage()

        Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

      • getPassword

        public final String getPassword()

        Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded. Set to NULL or empty string in order to remove the password. Useless for text-based Spreadsheet documents like CSV.

      • getWorksheetIndex

        public final int getWorksheetIndex()

        Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).


        Most of Spreadsheet documents support a concept of tabs, i.e. they can be multi-tabbed. On the other hand, HTML format doesn't support such structure. Because of this GroupDocs.Editor can convert to the HTML only one specific tab of the input document, and this option allows to specify it. Tab index is 0-based, negative values are prohibited. If specified index exceeds the number of all tabs, the exception will be thrown. If input Spreadsheet document contains only one tab, this option will be ignored. Default value is 0 (first tab).

      • setExcludeHiddenWorksheets

        public final void setExcludeHiddenWorksheets(boolean value)

        Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.


        Several binary Spreadsheet formats (like XLSX) support hidden worksheets (tabs) concept. Document of such format, if it has more then one worksheet, may contain additional hidden worksheets. By default such hidden worksheets are available for processing, but with this option it is able to ignore them, like these hidden worksheets are absent and don't exist. When this option is enabled, you cannot select hidden worksheet with the 'WorksheetIndex(getWorksheetIndex()/setWorksheetIndex(int))' property.

      • setOptimizeMemoryUsage

        public final void setOptimizeMemoryUsage(boolean value)

        Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

      • setPassword

        public final void setPassword(String value)

        Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded. Set to NULL or empty string in order to remove the password. Useless for text-based Spreadsheet documents like CSV.

      • setWorksheetIndex

        public final void setWorksheetIndex(int value)

        Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).


        Most of Spreadsheet documents support a concept of tabs, i.e. they can be multi-tabbed. On the other hand, HTML format doesn't support such structure. Because of this GroupDocs.Editor can convert to the HTML only one specific tab of the input document, and this option allows to specify it. Tab index is 0-based, negative values are prohibited. If specified index exceeds the number of all tabs, the exception will be thrown. If input Spreadsheet document contains only one tab, this option will be ignored. Default value is 0 (first tab).