com.aspose.words
Class ImageSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by com.aspose.words.ImageSaveOptions
All Implemented Interfaces:
java.lang.Cloneable

public class ImageSaveOptions 
extends SaveOptions

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() + "Rendering.SaveToImageResolution Out.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() + "Rendering.SaveToImageJpegQuality0 Out.jpeg", options);

// Try best quality.
options.setJpegQuality(100);
doc.save(getMyDir() + "Rendering.SaveToImageJpegQuality100 Out.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() + "Rendering.SaveToImagePaperColorTransparent Out.png", imgOptions);

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

Constructor Summary
ImageSaveOptions(int saveFormat)
           Initializes a new instance of this class that can be used to save rendered images in the SaveFormat.PNG, SaveFormat.BMP or SaveFormat.JPEG format.
 
Property Getters/Setters Summary
intgetColorMode()→ inherited from SaveOptions
voidsetColorMode(int value)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
intgetDmlEffectsRenderingMode()→ inherited from SaveOptions
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()→ inherited from SaveOptions
voidsetDmlRenderingMode(int value)
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
floatgetImageBrightness()
voidsetImageBrightness(float value)
           Gets or sets the brightness for the generated images.
intgetImageColorMode()
voidsetImageColorMode(int value)
           Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant.
floatgetImageContrast()
voidsetImageContrast(float value)
           Gets or sets the contrast for the generated images.
intgetJpegQuality()
voidsetJpegQuality(int value)
           Gets or sets a value determining the quality of the generated JPEG images.
MetafileRenderingOptionsgetMetafileRenderingOptions()
           Allows to specify how metafiles are treated in the rendered output.
intgetNumeralFormat()
voidsetNumeralFormat(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.
intgetPageCount()
voidsetPageCount(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.
intgetPageIndex()
voidsetPageIndex(int value)
           Gets or sets the 0-based index of the first page to render. Default is 0.
java.awt.ColorgetPaperColor()
voidsetPaperColor(java.awt.Color value)
           Gets or sets the background (paper) color for the generated images.

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

booleangetPrettyFormat()→ inherited from SaveOptions
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
floatgetResolution()
voidsetResolution(float value)
           Gets or sets the resolution for the generated images, in dots per inch.
intgetSaveFormat()
voidsetSaveFormat(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 or SaveFormat.JPEG. The value of the property is SaveFormat integer constant.
floatgetScale()
voidsetScale(float value)
           Gets or sets the zoom factor for the generated images.
java.lang.StringgetTempFolder()→ inherited from SaveOptions
voidsetTempFolder(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.
intgetTiffBinarizationMethod()
voidsetTiffBinarizationMethod(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.
intgetTiffCompression()
voidsetTiffCompression(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.
booleangetUpdateSdtContent()→ inherited from SaveOptions
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()→ inherited from SaveOptions
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()→ inherited from SaveOptions
voidsetUseHighQualityRendering(boolean value)
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
voidsetWarningCallback(IWarningCallback value)
           Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.
 
Method Summary
ImageSaveOptionsdeepClone()
           Creates a deep clone of this 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.PNG, SaveFormat.BMP or SaveFormat.JPEG format.
Parameters:
saveFormat - A SaveFormat value. Can be SaveFormat.PNG, SaveFormat.BMP or SaveFormat.JPEG.

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() + "Rendering.JpegDefaultOptions Out.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() + "Rendering.JpegCustomOptions Out.jpg", imageOptions);

Property Getters/Setters Detail

getColorMode/setColorMode

→ inherited from SaveOptions
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.


getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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.


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.


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() + "Rendering.SaveToImageJpegQuality0 Out.jpeg", options);

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

getMetafileRenderingOptions

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

When #Error Cref: F:Aspose.Words.Saving.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 #Error Cref: F:Aspose.Words.Saving.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 Aspose.Words.Saving.MetafileRenderingMode is #Error Cref: F:Aspose.Words.Saving.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.

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.

Example:

Converts a page of a Word document into a TIFF image and uses the CCITT compression.
Document doc = new Document(getMyDir() + "Rendering.doc");

ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
options.setTiffCompression(TiffCompression.CCITT_3);
options.setPageIndex(0);
options.setPageCount(1);

doc.save(getMyDir() + "Rendering.SaveToTiffCompression Out.tiff", options);

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.

Example:

Converts a page of a Word document into a TIFF image and uses the CCITT compression.
Document doc = new Document(getMyDir() + "Rendering.doc");

ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
options.setTiffCompression(TiffCompression.CCITT_3);
options.setPageIndex(0);
options.setPageCount(1);

doc.save(getMyDir() + "Rendering.SaveToTiffCompression Out.tiff", 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 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() + "Rendering.SaveToImagePaperColorTransparent Out.png", imgOptions);

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

getPrettyFormat/setPrettyFormat

→ inherited from SaveOptions
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() + "Document.PrettyFormat Out.html", htmlOptions);

getResolution/setResolution

public float getResolution() / public void setResolution(float value)
Gets or sets the 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.

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() + "Rendering.SaveToImageResolution Out.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 or SaveFormat.JPEG. 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

→ inherited from SaveOptions
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.

Example:

Converts a page of a Word document into a TIFF image and uses the CCITT compression.
Document doc = new Document(getMyDir() + "Rendering.doc");

ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
options.setTiffCompression(TiffCompression.CCITT_3);
options.setPageIndex(0);
options.setPageCount(1);

doc.save(getMyDir() + "Rendering.SaveToTiffCompression Out.tiff", options);

getUpdateSdtContent/setUpdateSdtContent

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.


getUseHighQualityRendering/setUseHighQualityRendering

→ inherited from SaveOptions
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.


getWarningCallback/setWarningCallback

→ inherited from SaveOptions
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.

This property is obsolete. Please use DocumentBase.WarningCallback instead.

Example:

Demonstrates how to implement the IWarningCallback to be notified of any font substitution during document save.
public class HandleDocumentWarnings implements IWarningCallback
{
    /**
     * Our callback only needs to implement the "Warning" method. This method is called whenever there is a
     * potential issue during document procssing. The callback can be set to listen for warnings generated during document
     * load and/or document save.
     */
    public void warning(WarningInfo info)
    {
        // We are only interested in fonts being substituted.
        if (info.getWarningType() == WarningType.FONT_SUBSTITUTION)
        {
            System.out.println("Font substitution: " + info.getDescription());
        }
    }

}

Example:

Demonstrates how to recieve notifications of font substitutions by using IWarningCallback.
// Load the document to render.
Document doc = new Document(getMyDir() + "Document.doc");

// We can choose the default font to use in the case of any missing fonts.
FontSettings.setDefaultFontName("Arial");

// For testing we will set Aspose.Words to look for fonts only in a folder which doesn't exist. Since Aspose.Words won't
// find any fonts in the specified directory, then during rendering the fonts in the document will be subsuited with the default
// font specified under FontSettings.DefaultFontName. We can pick up on this subsuition using our callback.
FontSettings.setFontsFolder("", false);

// Create a new class implementing IWarningCallback which collect any warnings produced during document save.
HandleDocumentWarnings callback = new HandleDocumentWarnings();

// We assign the callback to the appropriate save options class. In this case, we are going to save to PDF
// so we create a PdfSaveOptions class and assign the callback there.
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setWarningCallback(callback);

// Pass the save options along with the save path to the save method.
doc.save(getMyDir() + "Rendering.MissingFontNotification Out.pdf", saveOptions);

Method Detail

deepClone

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

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.