com.aspose.words

Class ImageSaveOptions

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ImageSaveOptions 
    extends FixedPageSaveOptions

Allows to specify additional options when rendering document pages or shapes to images.

Example:

Renders a page of a Word document into a PNG image at a specific resolution.
Document doc = new Document(getMyDir() + "Rendering.doc");

ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
options.setResolution(300);
options.setPageCount(1);

doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImageResolution.png", options);

Example:

Converts a page of a Word document into JPEG images of different qualities.
Document doc = new Document(getMyDir() + "Rendering.doc");

ImageSaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);

// Try worst quality.
options.setJpegQuality(0);
doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImageJpegQuality0.jpeg", options);

// Try best quality.
options.setJpegQuality(100);
doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImageJpegQuality100.jpeg", options);

Example:

Renders a page of a Word document into an image with transparent or coloured background.
Document doc = new Document(getMyDir() + "Rendering.doc");

ImageSaveOptions imgOptions = new ImageSaveOptions(SaveFormat.PNG);

imgOptions.setPaperColor(new Color(0, 0, 0, 0));
doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImagePaperColorTransparent.png", imgOptions);

imgOptions.setPaperColor(new Color(0x80, 0x80, 0x70));
doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImagePaperColorCoral.png", imgOptions);

Constructor Summary
ImageSaveOptions(intsaveFormat)
Initializes a new instance of this class that can be used to save rendered images in the SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.EMF, SaveFormat.JPEG or SaveFormat.SVG format. SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG format.
 
Property Getters/Setters Summary
intgetColorMode()
void
setColorMode(intvalue)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
java.lang.StringgetDefaultTemplate()
void
setDefaultTemplate(java.lang.Stringvalue)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
intgetDmlEffectsRenderingMode()
void
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
void
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
GraphicsQualityOptionsgetGraphicsQualityOptions()
void
           Allows to specify rendering mode and quality for the System.Drawing.Graphics object.
floatgetHorizontalResolution()
void
           Gets or sets the horizontal resolution for the generated images, in dots per inch.
floatgetImageBrightness()
void
setImageBrightness(floatvalue)
           Gets or sets the brightness for the generated images.
intgetImageColorMode()
void
           Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant.
floatgetImageContrast()
void
setImageContrast(floatvalue)
           Gets or sets the contrast for the generated images.
intgetJpegQuality()
void
setJpegQuality(intvalue)
           Gets or sets a value determining the quality of the generated JPEG images.
booleangetMemoryOptimization()
void
setMemoryOptimization(booleanvalue)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
MetafileRenderingOptionsgetMetafileRenderingOptions()
Allows to specify how metafiles are treated in the rendered output.
intgetNumeralFormat()
void
           Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.
booleangetOptimizeOutput()
void
setOptimizeOutput(booleanvalue)
           Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
intgetPageCount()
void
setPageCount(intvalue)
           Gets or sets the number of pages to render when saving to a multipage TIFF file. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.
intgetPageIndex()
void
setPageIndex(intvalue)
           Gets or sets the 0-based index of the first page to render. Default is 0.
IPageSavingCallbackgetPageSavingCallback()
void
           Allows to control how separate pages are saved when a document is exported to fixed page format.
java.awt.ColorgetPaperColor()
void
setPaperColor(java.awt.Colorvalue)
           Gets or sets the background (paper) color for the generated images.

The default value is java.awt.Color.WHITE.

intgetPixelFormat()
void
setPixelFormat(intvalue)
           Gets or sets the pixel format for the generated images. The value of the property is ImagePixelFormat integer constant.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
voidsetResolution(float value)
Sets both horizontal and vertical resolution for the generated images, in dots per inch.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used. Can be SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG. The value of the property is SaveFormat integer constant.
floatgetScale()
void
setScale(floatvalue)
           Gets or sets the zoom factor for the generated images.
java.lang.StringgetTempFolder()
void
setTempFolder(java.lang.Stringvalue)
           Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
intgetTiffBinarizationMethod()
void
           Gets or sets method used while converting images to 1 bpp format when SaveFormat is SaveFormat.Tiff and TiffCompression is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4. The value of the property is ImageBinarizationMethod integer constant.
intgetTiffCompression()
void
           Gets or sets the type of compression to apply when saving generated images to the TIFF format. The value of the property is TiffCompression integer constant.
booleangetUpdateFields()
void
setUpdateFields(booleanvalue)
           Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
booleangetUpdateLastSavedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
void
setUpdateSdtContent(booleanvalue)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
void
setUseAntiAliasing(booleanvalue)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseGdiEmfRenderer()
void
setUseGdiEmfRenderer(booleanvalue)
           Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
booleangetUseHighQualityRendering()
void
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
floatgetVerticalResolution()
void
           Gets or sets the vertical resolution for the generated images, in dots per inch.
 
Method Summary
ImageSaveOptionsdeepClone()
Creates a deep clone of this object.
booleanequals(java.lang.Object obj)
 

    • Constructor Detail

      • ImageSaveOptions

        public ImageSaveOptions(int saveFormat)
        Initializes a new instance of this class that can be used to save rendered images in the SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.EMF, SaveFormat.JPEG or SaveFormat.SVG format. SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG format.
        Parameters:
        saveFormat - A SaveFormat value. Can be SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.EMF, SaveFormat.JPEG or SaveFormat.SVG. SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG.

        Example:

        Shows how to save a document to the Jpeg format using the Save method and the ImageSaveOptions class.
        // Open the document
        Document doc = new Document(getMyDir() + "Rendering.doc");
        // Save as a Jpeg image file with default options
        doc.save(getMyDir() + "\\Artifacts\\Rendering.JpegDefaultOptions.jpg");
        
        // Save document to an ByteArrayOutputStream as a Jpeg with default options
        ByteArrayOutputStream docStream = new ByteArrayOutputStream();
        doc.save(docStream, SaveFormat.JPEG);
        
        // Save document to a Jpeg image with specified options.
        // Render the third page only and set the jpeg quality to 80%
        // In this case we need to pass the desired SaveFormat to the ImageSaveOptions constructor
        // to signal what type of image to save as.
        ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
        imageOptions.setPageIndex(2);
        imageOptions.setPageCount(1);
        imageOptions.setJpegQuality(80);
        doc.save(getMyDir() + "\\Artifacts\\Rendering.JpegCustomOptions.jpg", imageOptions);
    • Property Getters/Setters Detail

      • getColorMode/setColorMode

        public int getColorMode() / public void setColorMode(int value)
        
        Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how change image color with save options property
        // Open document with color image
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Set grayscale mode for document
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE);
        
        // Assert that color image in document was grey
        doc.save(getMyDir() + "\\Artifacts\\ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
      • getDefaultTemplate/setDefaultTemplate

        public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
        
        Gets or sets path to default template (including filename). Default value for this property is empty string. If specified, this path is used to load template when Document.AutomaticallyUpdateSyles is true, but Document.AttachedTemplate is empty.
      • getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

        public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

        This property is used when the document is exported to fixed page formats.

      • getDmlRenderingMode/setDmlRenderingMode

        public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how to define rendering for DML shapes
        Document doc = DocumentHelper.createDocumentFillWithDummyText();
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML);
        
        doc.save(getMyDir() + "\\Artifacts\\DrawingMl.pdf", pdfSaveOptions);
      • getGraphicsQualityOptions/setGraphicsQualityOptions

        public GraphicsQualityOptions getGraphicsQualityOptions() / public void setGraphicsQualityOptions(GraphicsQualityOptions value)
        
        Allows to specify rendering mode and quality for the System.Drawing.Graphics object.

        Use this property to override the Graphics settings provided by Aspose.Words engine by default.

        It will take effect only when a document is being saved to an image-like format.

      • getHorizontalResolution/setHorizontalResolution

        public float getHorizontalResolution() / public void setHorizontalResolution(float value)
        
        Gets or sets the horizontal resolution for the generated images, in dots per inch.

        This property has effect only when saving to raster image formats.

        The default value is 96.

      • getImageBrightness/setImageBrightness

        public float getImageBrightness() / public void setImageBrightness(float value)
        
        Gets or sets the brightness for the generated images.

        This property has effect only when saving to raster image formats.

        The default value is 0.5. The value must be in the range between 0 and 1.

      • getImageColorMode/setImageColorMode

        public int getImageColorMode() / public void setImageColorMode(int value)
        
        Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant.

        This property has effect only when saving to raster image formats.

        The default value is ImageColorMode.NONE.

        Example:

        Show how to convert document images to black and white with 1 bit per pixel
        Document doc = new Document(getMyDir() + "ImageSaveOptions.BlackAndWhite.docx");
        
        ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
        imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE);
        imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED);
        
        doc.save(getMyDir() + "\\Artifacts\\ImageSaveOptions.BlackAndWhite Out.png", imageSaveOptions);
      • getImageContrast/setImageContrast

        public float getImageContrast() / public void setImageContrast(float value)
        
        Gets or sets the contrast for the generated images.

        This property has effect only when saving to raster image formats.

        The default value is 0.5. The value must be in the range between 0 and 1.

      • getJpegQuality/setJpegQuality

        public int getJpegQuality() / public void setJpegQuality(int value)
        
        Gets or sets a value determining the quality of the generated JPEG images.

        Has effect only when saving to JPEG.

        Use this property to get or set the quality of generated images when saving in JPEG format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

        The default value is 95.

        Example:

        Converts a page of a Word document into JPEG images of different qualities.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        
        // Try worst quality.
        options.setJpegQuality(0);
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImageJpegQuality0.jpeg", options);
        
        // Try best quality.
        options.setJpegQuality(100);
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImageJpegQuality100.jpeg", options);
      • getMemoryOptimization/setMemoryOptimization

        public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
        
        Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

        Example:

        Shows an option to optimize memory consumption when you work with large documents.
        Document doc = new Document(getMyDir() + "SaveOptions.MemoryOptimization.doc");
        
        // When set to true it will improve document memory footprint but will add extra time to processing. 
        // This optimization is only applied during save operation.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        saveOptions.setMemoryOptimization(true);
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.MemoryOptimization Out.pdf", saveOptions);
      • getMetafileRenderingOptions

        public MetafileRenderingOptions getMetafileRenderingOptions()
        
        Allows to specify how metafiles are treated in the rendered output.

        When MetafileRenderingMode.VECTOR is specified, Aspose.Words renders metafile to vector graphics using its own metafile rendering engine first and then renders vector graphics to the image.

        When MetafileRenderingMode.BITMAP is specified, Aspose.Words renders metafile directly to the image using the GDI+ metafile rendering engine.

        GDI+ metafile rendering engine works faster, supports almost all metafile features but on low resolutions may produce inconsistent result when compared to the rest of vector graphics (especially for text) on the page. Aspose.Words metafile rendering engine will produce more consistent result even on low resolutions but works slower and may inaccurately render complex metafiles.

        The default value for MetafileRenderingMode is MetafileRenderingMode.BITMAP.

      • getNumeralFormat/setNumeralFormat

        public int getNumeralFormat() / public void setNumeralFormat(int value)
        
        Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant. If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.

        Example:

        Demonstrates how to set the numeral format used when saving to PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setNumeralFormat(NumeralFormat.CONTEXT);
      • getOptimizeOutput/setOptimizeOutput

        public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value)
        
        Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
      • getPageCount/setPageCount

        public int getPageCount() / public void setPageCount(int value)
        
        Gets or sets the number of pages to render when saving to a multipage TIFF file. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

        This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.

      • getPageIndex/setPageIndex

        public int getPageIndex() / public void setPageIndex(int value)
        
        Gets or sets the 0-based index of the first page to render. Default is 0.

        This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.

      • getPageSavingCallback/setPageSavingCallback

        public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)
        
        Allows to control how separate pages are saved when a document is exported to fixed page format.

        Example:

        Shows how separate pages are saved when a document is exported to fixed page format.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
            HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
            {
                htmlFixedSaveOptions.setPageIndex(0);
                htmlFixedSaveOptions.setPageCount(doc.getPageCount());
            }
            htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());
        
            doc.save(getMyDir() + "\\Artifacts\\Rendering.html", htmlFixedSaveOptions);
        
            String[] filePaths = GetFiles(getMyDir() + "\\Artifacts\\", "Page_*.html");
        
            for (int i = 0; i < doc.getPageCount(); i++)
            {
                String file = MessageFormat.format(getMyDir() + "\\Artifacts\\Page_{0}.html", i);
            }
        }
        
        private static String[] GetFiles(final String path, final String searchPattern)
        {
            final Pattern re = Pattern.compile(searchPattern.replace("*", ".*").replace("?", ".?"));
            String[] filenames = new File(path).list(new FilenameFilter()
            {
                @Override
                public boolean accept(File dir, String name)
                {
                    return new File(dir, name).isFile() && re.matcher(name).matches();
                }
            });
            for (int i = 0; i < filenames.length; i++)
            {
                filenames[i] = path + filenames[i];
            }
            return filenames;
        }
        
        /** 
         * Custom PageFileName is specified.
         */
        private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback
        {
            public void pageSaving(PageSavingArgs args) throws Exception
            {
                // Specify name of the output file for the current page.
                args.setPageFileName(MessageFormat.format(getMyDir() + "\\Artifacts\\Page_{0}.html", args.getPageIndex()));
            }
        }
      • getPaperColor/setPaperColor

        public java.awt.Color getPaperColor() / public void setPaperColor(java.awt.Color value)
        
        Gets or sets the background (paper) color for the generated images.

        The default value is java.awt.Color.WHITE.

        When rendering pages of a document that specifies its own background color, then the document background color will override the color specified by this property.

        Example:

        Renders a page of a Word document into an image with transparent or coloured background.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        ImageSaveOptions imgOptions = new ImageSaveOptions(SaveFormat.PNG);
        
        imgOptions.setPaperColor(new Color(0, 0, 0, 0));
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImagePaperColorTransparent.png", imgOptions);
        
        imgOptions.setPaperColor(new Color(0x80, 0x80, 0x70));
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImagePaperColorCoral.png", imgOptions);
      • getPixelFormat/setPixelFormat

        public int getPixelFormat() / public void setPixelFormat(int value)
        
        Gets or sets the pixel format for the generated images. The value of the property is ImagePixelFormat integer constant.

        The default value is ImagePixelFormat.FORMAT_32_BPP_ARGB.

        Pixel format of the output image may differ from the set value because of work of GDI+.

        Example:

        Show how to convert document images to black and white with 1 bit per pixel
        Document doc = new Document(getMyDir() + "ImageSaveOptions.BlackAndWhite.docx");
        
        ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
        imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE);
        imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED);
        
        doc.save(getMyDir() + "\\Artifacts\\ImageSaveOptions.BlackAndWhite Out.png", imageSaveOptions);
      • getPrettyFormat/setPrettyFormat

        public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
        
        When true, pretty formats output where applicable. Default value is false.

        Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.

        Example:

        Shows how to pass an option to export HTML tags in a well spaced, human readable format.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
        // Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read.
        // If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation.
        htmlOptions.setPrettyFormat(true);
        
        doc.save(getMyDir() + "\\Artifacts\\Document.PrettyFormat.html", htmlOptions);
      • setResolution

        public void setResolution(float value)
        
        Sets both horizontal and vertical resolution for the generated images, in dots per inch.

        This property has effect only when saving to raster image formats.

        Example:

        Renders a page of a Word document into a PNG image at a specific resolution.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        options.setResolution(300);
        options.setPageCount(1);
        
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToImageResolution.png", options);
      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / public void setSaveFormat(int value)
        
        Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used. Can be SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG. The value of the property is SaveFormat integer constant.
      • getScale/setScale

        public float getScale() / public void setScale(float value)
        
        Gets or sets the zoom factor for the generated images. The default value is 1.0. The value must be greater than 0.
      • getTempFolder/setTempFolder

        public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value)
        
        Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.

        When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

        If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

        The folder must exist and be writable, otherwise an exception will be thrown.

        Aspose.Words automatically deletes all temporary files when saving is complete.

      • getTiffBinarizationMethod/setTiffBinarizationMethod

        public int getTiffBinarizationMethod() / public void setTiffBinarizationMethod(int value)
        
        Gets or sets method used while converting images to 1 bpp format when SaveFormat is SaveFormat.Tiff and TiffCompression is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4. The value of the property is ImageBinarizationMethod integer constant.

        The default value is ImageBinarizationMethod.Threshold.

      • getTiffCompression/setTiffCompression

        public int getTiffCompression() / public void setTiffCompression(int value)
        
        Gets or sets the type of compression to apply when saving generated images to the TIFF format. The value of the property is TiffCompression integer constant.

        Has effect only when saving to TIFF.

        The default value is TiffCompression.CCITT_4.

      • getUpdateFields/setUpdateFields

        public boolean getUpdateFields() / public void setUpdateFields(boolean value)
        
        Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. Allows to specify whether to mimic or not MS Word behaviour.

        Example:

        Shows how to update fields before saving into a PDF document.
        Document doc = DocumentHelper.createDocumentFillWithDummyText();
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setUpdateFields(false);
        
        doc.save(getMyDir() + "\\Artifacts\\UpdateFields_False.pdf", pdfSaveOptions);
      • getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

        public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

        Example:

        Shows how to update a document time property when you want to save it
        Document doc = new Document(getMyDir() + "Document.doc");
        
        //Get last saved time
        Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime();
        
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setUpdateLastSavedTimeProperty(true);
      • getUpdateSdtContent/setUpdateSdtContent

        public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
        
        Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.
      • getUseAntiAliasing/setUseAntiAliasing

        public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
        
        Gets or sets a value determining whether or not to use anti-aliasing for rendering.

        The default value is false. When this value is set to true anti-aliasing is used for rendering.

        This property is used when the document is exported to the following formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.

      • getUseGdiEmfRenderer/setUseGdiEmfRenderer

        public boolean getUseGdiEmfRenderer() / public void setUseGdiEmfRenderer(boolean value)
        
        Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.

        If set to true GDI+ metafile renderer is used. I.e. content is written to GDI+ graphics object and saved to metafile.

        If set to false Aspose.Words metafile renderer is used. I.e. content is written directly to the metafile format with Aspose.Words.

        The default value is true.

        Has effect only when saving to EMF.

        Example:

        Shows how to save metafiles directly without using GDI+ to EMF.
        Document doc = new Document(getMyDir() + "SaveOptions.MyraidPro.docx");
        
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.EMF);
        saveOptions.setUseGdiEmfRenderer(false);

        Example:

        Shows how to save specific document page as image file.
        Document doc = new Document(getMyDir() + "SaveOptions.MyraidPro.docx");
        
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.GIF);
        //Define which page will save
        saveOptions.setPageIndex(0);
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.MyraidPro Out.gif", saveOptions);
      • getUseHighQualityRendering/setUseHighQualityRendering

        public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
        
        Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

        This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.

      • getVerticalResolution/setVerticalResolution

        public float getVerticalResolution() / public void setVerticalResolution(float value)
        
        Gets or sets the vertical resolution for the generated images, in dots per inch.

        This property has effect only when saving to raster image formats.

        The default value is 96.

    • Method Detail

      • deepClone

        public ImageSaveOptions deepClone()
        Creates a deep clone of this object.
      • equals

        public boolean equals(java.lang.Object obj)