com.groupdocs.editor.options

Class SpreadsheetLoadOptions

  • All Implemented Interfaces:
    ILoadOptions

    public final class SpreadsheetLoadOptions
extends Object
implements ILoadOptions

    Contains options for loading binary Spreadsheet (Cells, Excel-compatible) documents like XLS(X), ODS etc. into Editor class

    • Constructor Summary

      Constructors 
      Constructor and Description
      SpreadsheetLoadOptions()
      Default parameterless constructor - all parameters have default values

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      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.
      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.

    • Constructor Detail

      • SpreadsheetLoadOptions

        public SpreadsheetLoadOptions()

        Default parameterless constructor - all parameters have default values

    • Method Detail

      • 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 not use the password (default value).

        Specified by:
        getPassword in interface ILoadOptions
        Returns:

      • 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 not use the password (default value).

        Specified by:
        setPassword in interface ILoadOptions