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:

Shows how to configure compression while saving a document as a JPEG.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.insertImage(getImageDir() + "Logo.jpg");

// Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
// to modify the way in which that method renders the document into an image.
ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);

// Set the "JpegQuality" property to "10" to use stronger compression when rendering the document.
// This will reduce the file size of the document, but the image will display more prominent compression artifacts.
imageOptions.setJpegQuality(10);

doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg", imageOptions);

// Set the "JpegQuality" property to "100" to use weaker compression when rending the document.
// This will improve the quality of the image at the cost of an increased file size.
imageOptions.setJpegQuality(100);

doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg", imageOptions);

Example:

Renders a page of a Word document into an image with transparent or colored background.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.getFont().setName("Times New Roman");
builder.getFont().setSize(24.0);
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");

builder.insertImage(getImageDir() + "Logo.jpg");

// Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
// to modify the way in which that method renders the document into an image.
ImageSaveOptions imgOptions = new ImageSaveOptions(SaveFormat.PNG);

// Set the "PaperColor" property to a transparent color to apply a transparent
// background to the document while rendering it to an image.
imgOptions.setPaperColor(Color.RED);

doc.save(getArtifactsDir() + "ImageSaveOptions.PaperColor.Transparent.png", imgOptions);

// Set the "PaperColor" property to an opaque color to apply that color
// as the background of the document as we render it to an image.
imgOptions.setPaperColor(Color.cyan);

doc.save(getArtifactsDir() + "ImageSaveOptions.PaperColor.LightCoral.png", imgOptions);

Example:

Shows how to specify a resolution while rendering a document to PNG.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.getFont().setName("Times New Roman");
builder.getFont().setSize(24.0);
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");

builder.insertImage(getImageDir() + "Logo.jpg");

// Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
// to modify the way in which that method renders the document into an image.
ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);

// Set the "Resolution" property to "72" to render the document in 72dpi.
options.setResolution(72f);

doc.save(getArtifactsDir() + "ImageSaveOptions.Resolution.72dpi.png", options);

BufferedImage image = ImageIO.read(new File(getArtifactsDir() + "ImageSaveOptions.Resolution.72dpi.png"));

Assert.assertEquals(612, image.getWidth());
Assert.assertEquals(792, image.getHeight());
// Set the "Resolution" property to "300" to render the document in 300dpi.
options.setResolution(300f);

doc.save(getArtifactsDir() + "ImageSaveOptions.Resolution.300dpi.png", options);

image = ImageIO.read(new File(getArtifactsDir() + "ImageSaveOptions.Resolution.300dpi.png"));

Assert.assertEquals(2550, image.getWidth());
Assert.assertEquals(3300, image.getHeight());

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
booleangetAllowEmbeddingPostScriptFonts()
void
           Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
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.
intgetDml3DEffectsRenderingMode()
void
           Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.
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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
IPageSavingCallbackgetPageSavingCallback()
void
           Allows to control how separate pages are saved when a document is exported to fixed page format.
PageSetgetPageSet()
void
           Gets or sets the pages to render. Default is all the pages in the document.
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 a raster SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or vector 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.
bytegetThresholdForFloydSteinbergDithering()
void
           Gets or sets the threshold that determines the value of the binarization error in the Floyd-Steinberg method. when ImageBinarizationMethod is ImageBinarizationMethod.FloydSteinbergDithering.
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.
booleangetUpdateCreatedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false;
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.
booleangetUpdateLastPrintedProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.
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)
Determines whether the specified object is equal in value to the current object.
 

    • 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 configure compression while saving a document as a JPEG.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
        
        // Set the "JpegQuality" property to "10" to use stronger compression when rendering the document.
        // This will reduce the file size of the document, but the image will display more prominent compression artifacts.
        imageOptions.setJpegQuality(10);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg", imageOptions);
        
        // Set the "JpegQuality" property to "100" to use weaker compression when rending the document.
        // This will improve the quality of the image at the cost of an increased file size.
        imageOptions.setJpegQuality(100);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg", imageOptions);
    • Property Getters/Setters Detail

      • getAllowEmbeddingPostScriptFonts/setAllowEmbeddingPostScriptFonts

        public boolean getAllowEmbeddingPostScriptFonts() / public void setAllowEmbeddingPostScriptFonts(boolean value)
        
        Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.

        Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.

        This option only works when FontInfoCollection.EmbedTrueTypeFonts of the DocumentBase.FontInfos property is set to true.

        Example:

        Shows how to save the document with PostScript font.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("PostScriptFont");
        builder.writeln("Some text with PostScript font.");
        
        // Load the font with PostScript to use in the document.
        MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf")));
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf});
        
        // Embed TrueType fonts.
        doc.getFontInfos().setEmbedTrueTypeFonts(true);
        
        // Allow embedding PostScript fonts while embedding TrueType fonts.
        // Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX);
        saveOptions.setAllowEmbeddingPostScriptFonts(true);
        
        doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions);
      • 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.

        Example:

        Shows how to change image color with saving options property.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        // Set the "ColorMode" property to "Grayscale" to render all images from the document in black and white.
        // The size of the output document may be larger with this setting.
        // Set the "ColorMode" property to "Normal" to render all images in color.
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        {
            pdfSaveOptions.setColorMode(colorMode);
        }
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.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.AutomaticallyUpdateStyles is true, but Document.AttachedTemplate is empty.

        Example:

        Shows how to set a default template for documents that do not have attached templates.
        Document doc = new Document();
        
        // Enable automatic style updating, but do not attach a template document.
        doc.setAutomaticallyUpdateStyles(true);
        
        Assert.assertEquals("", doc.getAttachedTemplate());
        
        // Since there is no template document, the document had nowhere to track style changes.
        // Use a SaveOptions object to automatically set a template
        // if a document that we are saving does not have one.
        SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
        options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
        
        doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
      • getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode

        public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value)
        
        Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. The default value is Dml3DEffectsRenderingMode.BASIC.
      • 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.

        Example:

        Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
        // to render a simplified version of DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
        // render DrawingML effects with more accuracy and also with more processing cost.
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • 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 render fallback shapes when saving to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback"
        // to substitute DML shapes with their fallback shapes.
        // Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML"
        // to render the DML shapes themselves.
        options.setDmlRenderingMode(dmlRenderingMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

        Example:

        Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
        // to render a simplified version of DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
        // render DrawingML effects with more accuracy and also with more processing cost.
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • 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.

        Example:

        Shows how to set render quality options while converting documents to image formats.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        GraphicsQualityOptions qualityOptions = new GraphicsQualityOptions();
        qualityOptions.getRenderingHints().put(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); // SmoothingMode
        qualityOptions.getRenderingHints().put(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON); // TextRenderingHint
        qualityOptions.getRenderingHints().put(RenderingHints.KEY_COLOR_RENDERING, RenderingHints.VALUE_COLOR_RENDER_QUALITY); // CompositingMode
        qualityOptions.getRenderingHints().put(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY); // CompositingQuality
        qualityOptions.getRenderingHints().put(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR); // InterpolationMode
        qualityOptions.getRenderingHints().put(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON); // StringFormat
        
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
        saveOptions.setGraphicsQualityOptions(qualityOptions);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.GraphicsQuality.jpg", saveOptions);
      • 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 and affects the output size in pixels.

        The default value is 96.

        Example:

        Shows how to edit the image while Aspose.Words converts a document to one.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // edit the image while the saving operation renders it.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        {
            // We can adjust these properties to change the image's brightness and contrast.
            // Both are on a 0-1 scale and are at 0.5 by default.
            options.setImageBrightness(0.3f);
            options.setImageContrast(0.7f);
        
            // We can adjust horizontal and vertical resolution with these properties.
            // This will affect the dimensions of the image.
            // The default value for these properties is 96.0, for a resolution of 96dpi.
            options.setHorizontalResolution(72f);
            options.setVerticalResolution(72f);
        
            // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
            // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
            options.setScale(96f / 72f);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);
      • 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.

        Example:

        Shows how to edit the image while Aspose.Words converts a document to one.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // edit the image while the saving operation renders it.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        {
            // We can adjust these properties to change the image's brightness and contrast.
            // Both are on a 0-1 scale and are at 0.5 by default.
            options.setImageBrightness(0.3f);
            options.setImageContrast(0.7f);
        
            // We can adjust horizontal and vertical resolution with these properties.
            // This will affect the dimensions of the image.
            // The default value for these properties is 96.0, for a resolution of 96dpi.
            options.setHorizontalResolution(72f);
            options.setVerticalResolution(72f);
        
            // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
            // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
            options.setScale(96f / 72f);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);
      • 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:

        Shows how to set a color mode when rendering documents.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // select a color mode for the image that the saving operation will generate.
        // If we set the "ImageColorMode" property to "ImageColorMode.BlackAndWhite",
        // the saving operation will apply grayscale color reduction while rendering the document.
        // If we set the "ImageColorMode" property to "ImageColorMode.Grayscale", 
        // the saving operation will render the document into a monochrome image.
        // If we set the "ImageColorMode" property to "None", the saving operation will apply the default method
        // and preserve all the document's colors in the output image.
        ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
        imageSaveOptions.setImageColorMode(imageColorMode);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.ColorMode.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.

        Example:

        Shows how to edit the image while Aspose.Words converts a document to one.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // edit the image while the saving operation renders it.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        {
            // We can adjust these properties to change the image's brightness and contrast.
            // Both are on a 0-1 scale and are at 0.5 by default.
            options.setImageBrightness(0.3f);
            options.setImageContrast(0.7f);
        
            // We can adjust horizontal and vertical resolution with these properties.
            // This will affect the dimensions of the image.
            // The default value for these properties is 96.0, for a resolution of 96dpi.
            options.setHorizontalResolution(72f);
            options.setVerticalResolution(72f);
        
            // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
            // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
            options.setScale(96f / 72f);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);
      • 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:

        Shows how to configure compression while saving a document as a JPEG.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
        
        // Set the "JpegQuality" property to "10" to use stronger compression when rendering the document.
        // This will reduce the file size of the document, but the image will display more prominent compression artifacts.
        imageOptions.setJpegQuality(10);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg", imageOptions);
        
        // Set the "JpegQuality" property to "100" to use weaker compression when rending the document.
        // This will improve the quality of the image at the cost of an increased file size.
        imageOptions.setJpegQuality(100);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg", imageOptions);
      • 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 rendering large documents to PDF.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        
        // Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations
        // at the cost of increasing the duration of the operation.
        // Set the "MemoryOptimization" property to "false" to save the document as a PDF normally.
        saveOptions.setMemoryOptimization(memoryOptimization);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.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.

        Example:

        Shows how to set the rendering mode when saving documents with Windows Metafile images to other image formats.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.insertImage(getImageDir() + "Windows MetaFile.wmf");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // determine how the saving operation will process Windows Metafiles in the document.
        // If we set the "RenderingMode" property to "MetafileRenderingMode.Vector",
        // or "MetafileRenderingMode.VectorWithFallback", we will render all metafiles as vector graphics.
        // If we set the "RenderingMode" property to "MetafileRenderingMode.Bitmap", we will render all metafiles as bitmaps.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        options.getMetafileRenderingOptions().setRenderingMode(metafileRenderingMode);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.WindowsMetaFile.png", options);
      • 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:

        Shows how to set the numeral format used when saving to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setLocaleId(1025);
        builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "NumeralFormat" property to "NumeralFormat.ArabicIndic" to
        // use glyphs from the U+0660 to U+0669 range as numbers.
        // Set the "NumeralFormat" property to "NumeralFormat.Context" to
        // look up the locale to determine what number of glyphs to use.
        // Set the "NumeralFormat" property to "NumeralFormat.EasternArabicIndic" to
        // use glyphs from the U+06F0 to U+06F9 range as numbers.
        // Set the "NumeralFormat" property to "NumeralFormat.European" to use european numerals.
        // Set the "NumeralFormat" property to "NumeralFormat.System" to determine the symbol set from regional settings.
        options.setNumeralFormat(numeralFormat);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.SetNumeralFormat.pdf", options);
      • 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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.

        Example:

        Shows how to simplify a document when saving it to HTML by removing various redundant objects.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
        {
            saveOptions.setOptimizeOutput(optimizeOutput);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html", saveOptions);

        Example:

        Shows how to optimize document objects while saving to xps.
        Document doc = new Document(getMyDir() + "Unoptimized document.docx");
        
        // Create an "XpsSaveOptions" object to pass to the document's "Save" method
        // to modify how that method converts the document to .XPS.
        XpsSaveOptions saveOptions = new XpsSaveOptions();
        
        // Set the "OptimizeOutput" property to "true" to take measures such as removing nested or empty canvases
        // and concatenating adjacent runs with identical formatting to optimize the output document's content.
        // This may affect the appearance of the document.
        // Set the "OptimizeOutput" property to "false" to save the document normally.
        saveOptions.setOptimizeOutput(optimizeOutput);
        
        doc.save(getArtifactsDir() + "XpsSaveOptions.OptimizeOutput.xps", saveOptions);
      • 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 to use a callback to save a document to HTML page by page.
        public void pageFileNames() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.writeln("Page 1.");
            builder.insertBreak(BreakType.PAGE_BREAK);
            builder.writeln("Page 2.");
            builder.insertImage(getImageDir() + "Logo.jpg");
            builder.insertBreak(BreakType.PAGE_BREAK);
            builder.writeln("Page 3.");
        
            // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we convert the document to HTML.
            HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        
            // We will save each page in this document to a separate HTML file in the local file system.
            // Set a callback that allows us to name each output HTML document.
            htmlFixedSaveOptions.setPageSavingCallback(new CustomFileNamePageSavingCallback());
        
            doc.save(getArtifactsDir() + "SavingCallback.PageFileNames.html", htmlFixedSaveOptions);
        }
        
        /// <summary>
        /// Saves all pages to a file and directory specified within.
        /// </summary>
        private static class CustomFileNamePageSavingCallback implements IPageSavingCallback {
            public void pageSaving(PageSavingArgs args) throws Exception {
                String outFileName = MessageFormat.format("{0}SavingCallback.PageFileNames.Page_{1}.html", getArtifactsDir(), args.getPageIndex());
        
                // Below are two ways of specifying where Aspose.Words will save each page of the document.
                // 1 -  Set a filename for the output page file:
                args.setPageFileName(outFileName);
        
                // 2 -  Create a custom stream for the output page file:
                args.setPageStream(new FileOutputStream(outFileName));
        
                Assert.assertFalse(args.getKeepPageStreamOpen());
            }
        }
      • getPageSet/setPageSet

        public PageSet getPageSet() / public void setPageSet(PageSet value)
        
        Gets or sets the pages to render. Default is all the pages in the document.

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

        Example:

        Shows how to extract pages based on exact page ranges.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.TIFF);
        PageSet pageSet = new PageSet(new PageRange(1, 1), new PageRange(2, 3), new PageRange(1, 3), new PageRange(2, 4), new PageRange(1, 1));
        
        imageOptions.setPageSet(pageSet);
        doc.save(getArtifactsDir() + "ImageSaveOptions.ExportVariousPageRanges.tiff", imageOptions);

        Example:

        Shows how to render every page of a document to a separate TIFF image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Page 1.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 2.");
        builder.insertImage(getImageDir() + "Logo.jpg");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 3.");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
        
        for (int i = 0; i < doc.getPageCount(); i++) {
            // Set the "PageSet" property to the number of the first page from
            // which to start rendering the document from.
            options.setPageSet(new PageSet(i));
        
            doc.save(getArtifactsDir() + MessageFormat.format("ImageSaveOptions.PageByPage.{0}.tiff", i + 1), options);
        }

        Example:

        Shows how to specify which page in a document to render as an image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world! This is page 1.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("This is page 2.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("This is page 3.");
        
        Assert.assertEquals(3, doc.getPageCount());
        
        // When we save the document as an image, Aspose.Words only renders the first page by default.
        // We can pass a SaveOptions object to specify a different page to render.
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.GIF);
        
        // Render every page of the document to a separate image file.
        for (int i = 1; i <= doc.getPageCount(); i++) {
            saveOptions.setPageSet(new PageSet(1));
        
            doc.save(getArtifactsDir() + MessageFormat.format("ImageSaveOptions.PageIndex.Page {0}.gif", i), saveOptions);
        }

        Example:

        Shows how to render one page from a document to a JPEG image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Page 1.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 2.");
        builder.insertImage(getImageDir() + "Logo.jpg");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 3.");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        
        // Set the "PageSet" to "1" to select the second page via
        // the zero-based index to start rendering the document from.
        options.setPageSet(new PageSet(1));
        
        // When we save the document to the JPEG format, Aspose.Words only renders one page.
        // This image will contain one page starting from page two,
        // which will just be the second page of the original document.
        doc.save(getArtifactsDir() + "ImageSaveOptions.OnePage.jpg", options);
      • 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 colored background.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("Times New Roman");
        builder.getFont().setSize(24.0);
        builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions imgOptions = new ImageSaveOptions(SaveFormat.PNG);
        
        // Set the "PaperColor" property to a transparent color to apply a transparent
        // background to the document while rendering it to an image.
        imgOptions.setPaperColor(Color.RED);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.PaperColor.Transparent.png", imgOptions);
        
        // Set the "PaperColor" property to an opaque color to apply that color
        // as the background of the document as we render it to an image.
        imgOptions.setPaperColor(Color.cyan);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.PaperColor.LightCoral.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.

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

        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:

        Shows how to select a bit-per-pixel rate with which to render a document to an image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // select a pixel format for the image that the saving operation will generate.
        // Various bit per pixel rates will affect the quality and file size of the generated image.
        ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
        imageSaveOptions.setPixelFormat(imagePixelFormat);
        
        // We can clone ImageSaveOptions instances.
        Assert.assertNotEquals(imageSaveOptions, imageSaveOptions.deepClone());
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.PixelFormat.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 enhance the readability of the raw code of a saved .html document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
        {
            htmlOptions.setPrettyFormat(usePrettyFormat);
        }
        
        doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions);
        
        // Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters.
        String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8);
        
        if (usePrettyFormat)
            Assert.assertEquals(
                    "<html>\r\n" +
                            "\t<head>\r\n" +
                            "\t\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\r\n" +
                            "\t\t<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />\r\n" +
                            MessageFormat.format("\t\t<meta name=\"generator\" content=\"{0} {1}\" />\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
                            "\t\t<title>\r\n" +
                            "\t\t</title>\r\n" +
                            "\t</head>\r\n" +
                            "\t<body style=\"font-family:'Times New Roman'; font-size:12pt\">\r\n" +
                            "\t\t<div>\r\n" +
                            "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" +
                            "\t\t\t\t<span>Hello world!</span>\r\n" +
                            "\t\t\t</p>\r\n" +
                            "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" +
                            "\t\t\t\t<span style=\"-aw-import:ignore\">&#xa0;</span>\r\n" +
                            "\t\t\t</p>\r\n" +
                            "\t\t</div>\r\n" +
                            "\t</body>\r\n</html>",
                    html);
        else
            Assert.assertEquals(
                    "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />" +
                            "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />" +
                            MessageFormat.format("<meta name=\"generator\" content=\"{0} {1}\" /><title></title></head>", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
                            "<body style=\"font-family:'Times New Roman'; font-size:12pt\">" +
                            "<div><p style=\"margin-top:0pt; margin-bottom:0pt\"><span>Hello world!</span></p>" +
                            "<p style=\"margin-top:0pt; margin-bottom:0pt\"><span style=\"-aw-import:ignore\">&#xa0;</span></p></div></body></html>",
                    html);
      • 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:

        Shows how to specify a resolution while rendering a document to PNG.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("Times New Roman");
        builder.getFont().setSize(24.0);
        builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        
        // Set the "Resolution" property to "72" to render the document in 72dpi.
        options.setResolution(72f);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.Resolution.72dpi.png", options);
        
        BufferedImage image = ImageIO.read(new File(getArtifactsDir() + "ImageSaveOptions.Resolution.72dpi.png"));
        
        Assert.assertEquals(612, image.getWidth());
        Assert.assertEquals(792, image.getHeight());
        // Set the "Resolution" property to "300" to render the document in 300dpi.
        options.setResolution(300f);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.Resolution.300dpi.png", options);
        
        image = ImageIO.read(new File(getArtifactsDir() + "ImageSaveOptions.Resolution.300dpi.png"));
        
        Assert.assertEquals(2550, image.getWidth());
        Assert.assertEquals(3300, image.getHeight());
      • 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 a raster SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or vector SaveFormat.SVG. The value of the property is SaveFormat integer constant.

        On different platforms, the supported formats may be different. The number of other options depends on the selected format.

        Also, it is possible to save to SVG both via ImageSaveOptions and via SvgSaveOptions.

        Example:

        Shows how to edit the image while Aspose.Words converts a document to one.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // edit the image while the saving operation renders it.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        {
            // We can adjust these properties to change the image's brightness and contrast.
            // Both are on a 0-1 scale and are at 0.5 by default.
            options.setImageBrightness(0.3f);
            options.setImageContrast(0.7f);
        
            // We can adjust horizontal and vertical resolution with these properties.
            // This will affect the dimensions of the image.
            // The default value for these properties is 96.0, for a resolution of 96dpi.
            options.setHorizontalResolution(72f);
            options.setVerticalResolution(72f);
        
            // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
            // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
            options.setScale(96f / 72f);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);
      • 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.

        Example:

        Shows how to render an Office Math object into an image file in the local file system.
        Document doc = new Document(getMyDir() + "Office math.docx");
        
        OfficeMath math = (OfficeMath) doc.getChild(NodeType.OFFICE_MATH, 0, true);
        
        // Create an "ImageSaveOptions" object to pass to the node renderer's "Save" method to modify
        // how it renders the OfficeMath node into an image.
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.PNG);
        
        // Set the "Scale" property to 5 to render the object to five times its original size.
        saveOptions.setScale(5f);
        
        math.getMathRenderer().save(getArtifactsDir() + "Shape.RenderOfficeMath.png", saveOptions);

        Example:

        Shows how to edit the image while Aspose.Words converts a document to one.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // edit the image while the saving operation renders it.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        {
            // We can adjust these properties to change the image's brightness and contrast.
            // Both are on a 0-1 scale and are at 0.5 by default.
            options.setImageBrightness(0.3f);
            options.setImageContrast(0.7f);
        
            // We can adjust horizontal and vertical resolution with these properties.
            // This will affect the dimensions of the image.
            // The default value for these properties is 96.0, for a resolution of 96dpi.
            options.setHorizontalResolution(72f);
            options.setVerticalResolution(72f);
        
            // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
            // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
            options.setScale(96f / 72f);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);
      • 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.

        Example:

        Shows how to use the hard drive instead of memory when saving a document.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // When we save a document, various elements are temporarily stored in memory as the save operation is taking place.
        // We can use this option to use a temporary folder in the local file system instead,
        // which will reduce our application's memory overhead.
        DocSaveOptions options = new DocSaveOptions();
        options.setTempFolder(getArtifactsDir() + "TempFiles");
        
        // The specified temporary folder must exist in the local file system before the save operation.
        new File(options.getTempFolder()).mkdir();
        
        doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
        
        // The folder will persist with no residual contents from the load operation.
        Assert.assertEquals(new File(options.getTempFolder()).listFiles().length, 0);
      • getThresholdForFloydSteinbergDithering/setThresholdForFloydSteinbergDithering

        public byte getThresholdForFloydSteinbergDithering() / public void setThresholdForFloydSteinbergDithering(byte value)
        
        Gets or sets the threshold that determines the value of the binarization error in the Floyd-Steinberg method. when ImageBinarizationMethod is ImageBinarizationMethod.FloydSteinbergDithering.

        The default value is 128.

        Example:

        Shows how to set the TIFF binarization error threshold when using the Floyd-Steinberg method to render a TIFF image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as a TIFF, we can pass a SaveOptions object to
        // adjust the dithering that Aspose.Words will apply when rendering this image.
        // The default value of the "ThresholdForFloydSteinbergDithering" property is 128.
        // Higher values tend to produce darker images.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
        options.setTiffCompression(TiffCompression.CCITT_3);
        options.setTiffBinarizationMethod(ImageBinarizationMethod.FLOYD_STEINBERG_DITHERING);
        options.setThresholdForFloydSteinbergDithering((byte) 240);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.FloydSteinbergDithering.tiff", options);
      • 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.

        Example:

        Shows how to set the TIFF binarization error threshold when using the Floyd-Steinberg method to render a TIFF image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as a TIFF, we can pass a SaveOptions object to
        // adjust the dithering that Aspose.Words will apply when rendering this image.
        // The default value of the "ThresholdForFloydSteinbergDithering" property is 128.
        // Higher values tend to produce darker images.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
        options.setTiffCompression(TiffCompression.CCITT_3);
        options.setTiffBinarizationMethod(ImageBinarizationMethod.FLOYD_STEINBERG_DITHERING);
        options.setThresholdForFloydSteinbergDithering((byte) 240);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.FloydSteinbergDithering.tiff", options);
      • 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.

        Example:

        Shows how to select the compression scheme to apply to a document that we convert into a TIFF image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
        
        // Set the "TiffCompression" property to "TiffCompression.None" to apply no compression while saving,
        // which may result in a very large output file.
        // Set the "TiffCompression" property to "TiffCompression.Rle" to apply RLE compression
        // Set the "TiffCompression" property to "TiffCompression.Lzw" to apply LZW compression.
        // Set the "TiffCompression" property to "TiffCompression.Ccitt3" to apply CCITT3 compression.
        // Set the "TiffCompression" property to "TiffCompression.Ccitt4" to apply CCITT4 compression.
        options.setTiffCompression(tiffCompression);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.TiffImageCompression.tiff", options);
      • getUpdateCreatedTimeProperty/setUpdateCreatedTimeProperty

        public boolean getUpdateCreatedTimeProperty() / public void setUpdateCreatedTimeProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false;
      • 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 behavior.

        Example:

        Shows how to update all the fields in a document immediately before saving it to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time.
        // We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()"
        // each time we need them to display accurate values.
        builder.write("Page ");
        builder.insertField("PAGE", "");
        builder.write(" of ");
        builder.insertField("NUMPAGES", "");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Hello World!");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "UpdateFields" property to "false" to not update all the fields in a document right before a save operation.
        // This is the preferable option if we know that all our fields will be up to date before saving.
        // Set the "UpdateFields" property to "true" to iterate through all the document
        // fields and update them before we save it as a PDF. This will make sure that all the fields will display
        // the most accurate values in the PDF.
        options.setUpdateFields(updateFields);
        
        // We can clone PdfSaveOptions objects.
        Assert.assertNotSame(options, options.deepClone());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
      • getUpdateLastPrintedProperty/setUpdateLastPrintedProperty

        public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.

        Example:

        Shows how to update a document's "Last printed" property when saving.
        Document doc = new Document();
        
        // This flag determines whether the last printed date, which is a built-in property, is updated.
        // If so, then the date of the document's most recent save operation
        // with this SaveOptions object passed as a parameter is used as the print date.
        DocSaveOptions saveOptions = new DocSaveOptions();
        saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);
        
        // In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed.
        // It can also be displayed in the document's body by using a PRINTDATE field.
        doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions);
        
        // Open the saved document, then verify the value of the property.
        doc = new Document(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc");
        
        Assert.assertNotEquals(Calendar.getInstance().getTime(), doc.getBuiltInDocumentProperties().getLastPrinted());
      • 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 determine whether to preserve the document's "Last saved time" property when saving.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object
        // and then pass it to the document's saving method to modify how we save the document.
        // Set the "UpdateLastSavedTimeProperty" property to "true" to
        // set the output document's "Last saved time" built-in property to the current date/time.
        // Set the "UpdateLastSavedTimeProperty" property to "false" to
        // preserve the original value of the input document's "Last saved time" built-in property.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty);
        
        doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.docx", saveOptions);
      • 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.

        Example:

        Shows how to update structured document tags while saving a document to PDF.
        Document doc = new Document();
        
        // Insert a drop-down list structured document tag.
        StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
        tag.getListItems().add(new SdtListItem("Value 1"));
        tag.getListItems().add(new SdtListItem("Value 2"));
        tag.getListItems().add(new SdtListItem("Value 3"));
        
        // The drop-down list currently displays "Choose an item" as the default text.
        // Set the "SelectedValue" property to one of the list items to get the tag to
        // display that list item's value instead of the default text.
        tag.getListItems().setSelectedValue(tag.getListItems().get(1));
        
        doc.getFirstSection().getBody().appendChild(tag);
        
        // Create a "PdfSaveOptions" object to pass to the document's "Save" method
        // to modify how that method saves the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "UpdateSdtContent" property to "false" not to update the structured document tags
        // while saving the document to PDF. They will display their default values as they were at the time of construction.
        // Set the "UpdateSdtContent" property to "true" to make sure the tags display updated values in the PDF.
        options.setUpdateSdtContent(updateSdtContent);
        
        doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
      • 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.

        Example:

        Shows how to improve the quality of a rendered document with SaveOptions.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setSize(60.0);
        builder.writeln("Some text.");
        
        SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
        
        options.setUseAntiAliasing(true);
        options.setUseHighQualityRendering(true);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
      • 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.

        Has effect only when saving to EMF.

        GDI+ saving works only on .NET.

        The default value is true.

        Example:

        Shows how to choose a renderer when converting a document to .emf.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an EMF image, we can pass a SaveOptions object to select a renderer for the image.
        // If we set the "UseGdiEmfRenderer" flag to "true", Aspose.Words will use the GDI+ renderer.
        // If we set the "UseGdiEmfRenderer" flag to "false", Aspose.Words will use its own metafile renderer.
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.EMF);
        saveOptions.setUseGdiEmfRenderer(useGdiEmfRenderer);
        
        // The GDI+ renderer usually creates larger files.
        doc.save(getArtifactsDir() + "ImageSaveOptions.Renderer.emf", 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.

        Example:

        Shows how to improve the quality of a rendered document with SaveOptions.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setSize(60.0);
        builder.writeln("Some text.");
        
        SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
        
        options.setUseAntiAliasing(true);
        options.setUseHighQualityRendering(true);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
      • 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 and affects the output size in pixels.

        The default value is 96.

        Example:

        Shows how to edit the image while Aspose.Words converts a document to one.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // edit the image while the saving operation renders it.
        ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
        {
            // We can adjust these properties to change the image's brightness and contrast.
            // Both are on a 0-1 scale and are at 0.5 by default.
            options.setImageBrightness(0.3f);
            options.setImageContrast(0.7f);
        
            // We can adjust horizontal and vertical resolution with these properties.
            // This will affect the dimensions of the image.
            // The default value for these properties is 96.0, for a resolution of 96dpi.
            options.setHorizontalResolution(72f);
            options.setVerticalResolution(72f);
        
            // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
            // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
            options.setScale(96f / 72f);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);
    • Method Detail

      • deepClone

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

        Example:

        Shows how to select a bit-per-pixel rate with which to render a document to an image.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // When we save the document as an image, we can pass a SaveOptions object to
        // select a pixel format for the image that the saving operation will generate.
        // Various bit per pixel rates will affect the quality and file size of the generated image.
        ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
        imageSaveOptions.setPixelFormat(imagePixelFormat);
        
        // We can clone ImageSaveOptions instances.
        Assert.assertNotEquals(imageSaveOptions, imageSaveOptions.deepClone());
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.PixelFormat.png", imageSaveOptions);
      • equals

        public boolean equals(java.lang.Object obj)
        Determines whether the specified object is equal in value to the current object.