com.groupdocs.editor.words.htmltowords

Class WordsSaveOptions

    • Constructor Summary

      Constructors 
      Constructor and Description
      WordsSaveOptions()
      Creates a new instance of WordsSaveOptions with default Word format and absence password
      WordsSaveOptions(byte outputFormat)
      Creates a new instance of WordsSaveOptions with specified Word format and absence password
      WordsSaveOptions(byte outputFormat, String password)
      Creates a new instance of WordsSaveOptions with specified Word format and encryption password
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      Locale getLocale()
      Allows to set override default locale (language) for the Word document, which will be applied during its creation.
      Locale getLocaleBi()
      Allows to set override locale (language) for the Word document for the RTL (right-to-left) text, which will be applied during its creation.
      Locale getLocaleFarEast()
      Allows to override the locale (language) for the Word document for the East-Asian text, which will be applied during its creation.
      boolean getOptimizeMemoryUsage()
      Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
      byte getOutputFormat()
      Allows to specify a Word format, which will be used for saving the document.
      String getPassword()
      Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document.
      com.groupdocs.editor.words.htmltowords.DocumentProtection getProtection()
      Allows to control and apply the document protection options for the Words document of any format, which supports document protection.
      void setLocale(Locale value)
      Allows to set override default locale (language) for the Word document, which will be applied during its creation.
      void setLocaleBi(Locale value)
      Allows to set override locale (language) for the Word document for the RTL (right-to-left) text, which will be applied during its creation.
      void setLocaleFarEast(Locale value)
      Allows to override the locale (language) for the Word document for the East-Asian text, which will be applied during its creation.
      void setOptimizeMemoryUsage(boolean value)
      Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
      void setOutputFormat(byte value)
      Allows to specify a Word format, which will be used for saving the document.
      void setPassword(String value)
      Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document.
      void setProtection(com.groupdocs.editor.words.htmltowords.DocumentProtection value)
      Allows to control and apply the document protection options for the Words document of any format, which supports document protection.
    • Constructor Detail

      • WordsSaveOptions

        public WordsSaveOptions()

        Creates a new instance of WordsSaveOptions with default Word format and absence password

      • WordsSaveOptions

        public WordsSaveOptions(byte outputFormat)

        Creates a new instance of WordsSaveOptions with specified Word format and absence password

        Parameters:
        outputFormat -
      • WordsSaveOptions

        public WordsSaveOptions(byte outputFormat,
                        String password)

        Creates a new instance of WordsSaveOptions with specified Word format and encryption password

        Parameters:
        outputFormat - Output format of the Word document
        password -
    • Method Detail

      • getLocale

        public Locale getLocale()

        Allows to set override default locale (language) for the Word document, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document locale according to its own settings or other factors.


        This option forcibly applies the specified locale to overall text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

      • getLocaleBi

        public Locale getLocaleBi()

        Allows to set override locale (language) for the Word document for the RTL (right-to-left) text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document RTL locale according to its own settings or other factors.


        This option forcibly applies the specified locale to overall RTL text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

      • getLocaleFarEast

        public Locale getLocaleFarEast()

        Allows to override the locale (language) for the Word document for the East-Asian text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document East-Asian locale according to its own settings or other factors.


        This option forcibly applies the specified locale to overall East-Asian text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

      • getOptimizeMemoryUsage

        public boolean getOptimizeMemoryUsage()

        Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

      • getOutputFormat

        public byte getOutputFormat()

        Allows to specify a Word format, which will be used for saving the document. The default 'Auto' value implies DOCX.

      • getPassword

        public String getPassword()

        Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document. Specify NULL or empty string for removing (cleaning) the password.

        Specified by:
        getPassword in interface IDocumentSaveOptions
      • getProtection

        public com.groupdocs.editor.words.htmltowords.DocumentProtection getProtection()

        Allows to control and apply the document protection options for the Words document of any format, which supports document protection. By default is NULL - document protection will not be used.

      • setLocale

        public void setLocale(Locale value)

        Allows to set override default locale (language) for the Word document, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document locale according to its own settings or other factors.


        This option forcibly applies the specified locale to overall text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

      • setLocaleBi

        public void setLocaleBi(Locale value)

        Allows to set override locale (language) for the Word document for the RTL (right-to-left) text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document RTL locale according to its own settings or other factors.


        This option forcibly applies the specified locale to overall RTL text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

      • setLocaleFarEast

        public void setLocaleFarEast(Locale value)

        Allows to override the locale (language) for the Word document for the East-Asian text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document East-Asian locale according to its own settings or other factors.


        This option forcibly applies the specified locale to overall East-Asian text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

      • setOptimizeMemoryUsage

        public void setOptimizeMemoryUsage(boolean value)

        Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

      • setOutputFormat

        public void setOutputFormat(byte value)

        Allows to specify a Word format, which will be used for saving the document. The default 'Auto' value implies DOCX.

      • setPassword

        public void setPassword(String value)

        Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document. Specify NULL or empty string for removing (cleaning) the password.

        Specified by:
        setPassword in interface IDocumentSaveOptions
      • setProtection

        public void setProtection(com.groupdocs.editor.words.htmltowords.DocumentProtection value)

        Allows to control and apply the document protection options for the Words document of any format, which supports document protection. By default is NULL - document protection will not be used.