com.groupdocs.editor.options

Class WordProcessingSaveOptions

  • All Implemented Interfaces:
    com.aspose.ms.System.ICloneable, ISaveOptions

    public final class WordProcessingSaveOptions
extends Object
implements ISaveOptions, com.aspose.ms.System.ICloneable

    Allows to specify custom options for generating and saving WordProcessing-compliant documents after they were edited

    WordProcessingSaveOptions is applied in situations when there is an instance of EditableDocument class, that contains an edited document content, and it is required to save this content to the new document of WordProcessing format.

    • Constructor Summary

      Constructors 
      Constructor and Description
      WordProcessingSaveOptions(WordProcessingFormats outputFormat)
      Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      WordProcessingSaveOptions deepClone()
      Creates and returns a full copy of this instance of WordProcessingSaveOptions class
      boolean getEnablePagination()
      Allows to enable or disable pagination which will be used for saving the document.
      Locale getLocale()
      Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation.
      Locale getLocaleBi()
      Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation.
      com.aspose.ms.System.Globalization.CultureInfo getLocaleBiInternal() 
      Locale getLocaleFarEast()
      Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation.
      com.aspose.ms.System.Globalization.CultureInfo getLocaleFarEastInternal() 
      com.aspose.ms.System.Globalization.CultureInfo getLocaleInternal() 
      boolean getOptimizeMemoryUsage()
      Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
      WordProcessingFormats getOutputFormat()
      Allows to specify a WordProcessing 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 WordProcessing document.
      WordProcessingProtection getProtection()
      Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection.
      void setEnablePagination(boolean value)
      Allows to enable or disable pagination which will be used for saving the document.
      void setLocale(Locale value)
      Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation.
      void setLocaleBi(Locale value)
      Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation.
      void setLocaleBiInternal(com.aspose.ms.System.Globalization.CultureInfo value) 
      void setLocaleFarEast(Locale value)
      Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation.
      void setLocaleFarEastInternal(com.aspose.ms.System.Globalization.CultureInfo value) 
      void setLocaleInternal(com.aspose.ms.System.Globalization.CultureInfo value) 
      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(WordProcessingFormats value)
      Allows to specify a WordProcessing 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 WordProcessing document.
      void setProtection(WordProcessingProtection value)
      Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection.

    • Constructor Detail

      • WordProcessingSaveOptions

        public WordProcessingSaveOptions(WordProcessingFormats outputFormat)

        Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default

        Parameters:
        outputFormat - Mandatory output format, in which the WordProcessing document should be saved

    • Method Detail

      • deepClone

        public final WordProcessingSaveOptions deepClone()

        Creates and returns a full copy of this instance of WordProcessingSaveOptions class

        Specified by:
        deepClone in interface com.aspose.ms.System.ICloneable
        Returns:
        New WordProcessingSaveOptions instance

      • getEnablePagination

        public final boolean getEnablePagination()

        Allows to enable or disable pagination which will be used for saving the document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled.

      • getLocale

        public final Locale getLocale()

        Allows to set override default locale (language) for the WordProcessing 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 final Locale getLocaleBi()

        Allows to set override locale (language) for the WordProcessing 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.

      • getLocaleBiInternal

        public com.aspose.ms.System.Globalization.CultureInfo getLocaleBiInternal()

      • getLocaleFarEast

        public final Locale getLocaleFarEast()

        Allows to override the locale (language) for the WordProcessing 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.

      • getLocaleFarEastInternal

        public com.aspose.ms.System.Globalization.CultureInfo getLocaleFarEastInternal()

      • getLocaleInternal

        public com.aspose.ms.System.Globalization.CultureInfo getLocaleInternal()

      • getOptimizeMemoryUsage

        public final 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 final WordProcessingFormats getOutputFormat()

        Allows to specify a WordProcessing format, which will be used for saving the document

      • getPassword

        public final String getPassword()

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

      • getProtection

        public final WordProcessingProtection getProtection()

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

      • setEnablePagination

        public final void setEnablePagination(boolean value)

        Allows to enable or disable pagination which will be used for saving the document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled.

      • setLocale

        public final void setLocale(Locale value)

        Allows to set override default locale (language) for the WordProcessing 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 final void setLocaleBi(Locale value)

        Allows to set override locale (language) for the WordProcessing 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.

      • setLocaleBiInternal

        public void setLocaleBiInternal(com.aspose.ms.System.Globalization.CultureInfo value)

      • setLocaleFarEast

        public final void setLocaleFarEast(Locale value)

        Allows to override the locale (language) for the WordProcessing 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.

      • setLocaleFarEastInternal

        public void setLocaleFarEastInternal(com.aspose.ms.System.Globalization.CultureInfo value)

      • setLocaleInternal

        public void setLocaleInternal(com.aspose.ms.System.Globalization.CultureInfo value)

      • setOptimizeMemoryUsage

        public final 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 final void setOutputFormat(WordProcessingFormats value)

        Allows to specify a WordProcessing format, which will be used for saving the document

      • setPassword

        public final void setPassword(String value)

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

      • setProtection

        public final void setProtection(WordProcessingProtection value)

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