java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.ImageSaveOptions
public class ImageSaveOptions
Example: Example: Example:
Document doc = new Document(getMyDir() + "Rendering.doc");
ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
options.setResolution(300);
options.setPageCount(1);
doc.save(getArtifactsDir() + "Rendering.SaveToImageResolution.png", options);
Document doc = new Document(getMyDir() + "Rendering.doc");
ImageSaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
// Try worst quality.
options.setJpegQuality(0);
doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality0.jpeg", options);
// Try best quality.
options.setJpegQuality(100);
doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality100.jpeg", options);
Document doc = new Document(getMyDir() + "Rendering.doc");
ImageSaveOptions imgOptions = new ImageSaveOptions(SaveFormat.PNG);
imgOptions.setPaperColor(new Color(0, 0, 0, 0));
doc.save(getArtifactsDir() + "Rendering.SaveToImagePaperColorTransparent.png", imgOptions);
imgOptions.setPaperColor(new Color(0x80, 0x80, 0x70));
doc.save(getArtifactsDir() + "Rendering.SaveToImagePaperColorCoral.png", imgOptions);
Constructor Summary |
---|
ImageSaveOptions(int saveFormat)
Initializes a new instance of this class that can be used to save rendered images in the |
Property Getters/Setters Summary | ||
---|---|---|
int | getColorMode() | → inherited from SaveOptions |
void | setColorMode(int value) | |
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant. | ||
java.lang.String | getDefaultTemplate() | → inherited from SaveOptions |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename). Default value for this property is empty string. | ||
int | getDmlEffectsRenderingMode() | → inherited from SaveOptions |
void | setDmlEffectsRenderingMode(int value) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | → inherited from SaveOptions |
void | setDmlRenderingMode(int value) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
GraphicsQualityOptions | getGraphicsQualityOptions() | |
void | setGraphicsQualityOptions(GraphicsQualityOptions value) | |
Allows to specify rendering mode and quality for the |
||
float | getHorizontalResolution() | |
void | setHorizontalResolution(float value) | |
Gets or sets the horizontal resolution for the generated images, in dots per inch. | ||
float | getImageBrightness() | |
void | setImageBrightness(float value) | |
Gets or sets the brightness for the generated images. | ||
int | getImageColorMode() | |
void | setImageColorMode(int value) | |
Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant. | ||
float | getImageContrast() | |
void | setImageContrast(float value) | |
Gets or sets the contrast for the generated images. | ||
int | getJpegQuality() | |
void | setJpegQuality(int value) | |
Gets or sets a value determining the quality of the generated JPEG images. | ||
boolean | getMemoryOptimization() | → inherited from SaveOptions |
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. | ||
MetafileRenderingOptions | getMetafileRenderingOptions() | |
Allows to specify how metafiles are treated in the rendered output. | ||
int | getNumeralFormat() | → inherited from FixedPageSaveOptions |
void | setNumeralFormat(int value) | |
Gets or sets |
||
boolean | getOptimizeOutput() | → inherited from FixedPageSaveOptions |
void | setOptimizeOutput(boolean value) | |
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false. | ||
int | getPageCount() | |
void | setPageCount(int value) | |
Gets or sets the number of pages to render when saving to a multipage TIFF file.
Default is |
||
int | getPageIndex() | |
void | setPageIndex(int value) | |
Gets or sets the 0-based index of the first page to render. Default is 0. | ||
IPageSavingCallback | getPageSavingCallback() | → inherited from FixedPageSaveOptions |
void | setPageSavingCallback(IPageSavingCallback value) | |
Allows to control how separate pages are saved when a document is exported to fixed page format. | ||
java.awt.Color | getPaperColor() | |
void | setPaperColor(java.awt.Color value) | |
Gets or sets the background (paper) color for the generated images.
The default value is |
||
int | getPixelFormat() | |
void | setPixelFormat(int value) | |
Gets or sets the pixel format for the generated images. The value of the property is ImagePixelFormat integer constant. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
void | setResolution(float value) | |
Sets both horizontal and vertical resolution for the generated images, in dots per inch. | ||
int | getSaveFormat() | |
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
|
||
float | getScale() | |
void | setScale(float value) | |
Gets or sets the zoom factor for the generated images. | ||
java.lang.String | getTempFolder() | → inherited from SaveOptions |
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.
|
||
byte | getThresholdForFloydSteinbergDithering() | |
void | setThresholdForFloydSteinbergDithering(byte value) | |
Gets or sets the threshold that determines the value
of the binarization error in the Floyd-Steinberg method.
when |
||
int | getTiffBinarizationMethod() | |
void | setTiffBinarizationMethod(int value) | |
Gets or sets method used while converting images to 1 bpp format
when |
||
int | getTiffCompression() | |
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. | ||
boolean | getUpdateFields() | → inherited from SaveOptions |
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. | ||
boolean | getUpdateLastSavedTimeProperty() | → inherited from SaveOptions |
void | setUpdateLastSavedTimeProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateSdtContent() | → inherited from SaveOptions |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | → inherited from SaveOptions |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseGdiEmfRenderer() | |
void | setUseGdiEmfRenderer(boolean value) | |
Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF. | ||
boolean | getUseHighQualityRendering() | → inherited from SaveOptions |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. | ||
float | getVerticalResolution() | |
void | setVerticalResolution(float value) | |
Gets or sets the vertical resolution for the generated images, in dots per inch. |
Method Summary | ||
---|---|---|
ImageSaveOptions | deepClone() | |
Creates a deep clone of this object. | ||
boolean | equals(java.lang.Object obj) | → inherited from FixedPageSaveOptions |
Constructor Detail |
---|
public ImageSaveOptions(int saveFormat)
saveFormat
- A 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(getArtifactsDir() + "Rendering.JpegDefaultOptions.jpg"); // Save document to an ByteArrayOutputStream as a Jpeg with default options ByteArrayOutputStream docStream = new ByteArrayOutputStream(); doc.save(docStream, SaveFormat.JPEG); // Save document to a Jpeg image with specified options. // Render the third page only and set the jpeg quality to 80% // In this case we need to pass the desired SaveFormat to the ImageSaveOptions constructor // to signal what type of image to save as. ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG); imageOptions.setPageIndex(2); imageOptions.setPageCount(1); imageOptions.setJpegQuality(80); doc.save(getArtifactsDir() + "Rendering.JpegCustomOptions.jpg", imageOptions);
Property Getters/Setters Detail |
---|
getColorMode/setColorMode | → inherited from SaveOptions |
public int getColorMode() / public void setColorMode(int value) |
This property is used when the document is exported to fixed page formats.
Example:
Shows how change image color with save options property// Open document with color image Document doc = new Document(getMyDir() + "Rendering.doc"); // Set grayscale mode for document PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE); // Assert that color image in document was grey doc.save(getArtifactsDir() + "ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | → inherited from SaveOptions |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
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) |
This property is used when the document is exported to fixed page formats.
Example:
Shows how to define rendering for DML shapesDocument doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML); doc.save(getArtifactsDir() + "DrawingMl.pdf", pdfSaveOptions);
getGraphicsQualityOptions/setGraphicsQualityOptions | |
public GraphicsQualityOptions getGraphicsQualityOptions() / public void setGraphicsQualityOptions(GraphicsQualityOptions value) |
Use this property to override the Graphics settings provided by Aspose.Words engine by default.
It will take effect only when a document is being saved to an image-like format.
getHorizontalResolution/setHorizontalResolution | |
public float getHorizontalResolution() / public void setHorizontalResolution(float value) |
This property has effect only when saving to raster image formats.
The default value is 96.
getImageBrightness/setImageBrightness | |
public float getImageBrightness() / public void setImageBrightness(float value) |
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) |
This property has effect only when saving to raster image formats.
The default value is
Example:
Show how to convert document images to black and white with 1 bit per pixelDocument doc = new Document(getMyDir() + "ImageSaveOptions.BlackAndWhite.docx"); ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG); imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE); imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED); doc.save(getArtifactsDir() + "ImageSaveOptions.BlackAndWhite Out.png", imageSaveOptions);
getImageContrast/setImageContrast | |
public float getImageContrast() / public void setImageContrast(float value) |
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) |
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(getArtifactsDir() + "Rendering.SaveToImageJpegQuality0.jpeg", options); // Try best quality. options.setJpegQuality(100); doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality100.jpeg", options);
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
Example:
Shows an option to optimize memory consumption when you work with large documents.Document doc = new Document(getMyDir() + "SaveOptions.MemoryOptimization.doc"); // When set to true it will improve document memory footprint but will add extra time to processing. // This optimization is only applied during save operation. SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); saveOptions.setMemoryOptimization(true); doc.save(getArtifactsDir() + "SaveOptions.MemoryOptimization Out.pdf", saveOptions);
getMetafileRenderingOptions | |
public MetafileRenderingOptions getMetafileRenderingOptions() |
When
When
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
getNumeralFormat/setNumeralFormat | → inherited from FixedPageSaveOptions |
public int getNumeralFormat() / public void setNumeralFormat(int value) |
Example:
Demonstrates how to set the numeral format used when saving to PDF.PdfSaveOptions options = new PdfSaveOptions(); options.setNumeralFormat(NumeralFormat.CONTEXT);
getOptimizeOutput/setOptimizeOutput | → inherited from FixedPageSaveOptions |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
getPageCount/setPageCount | |
public int getPageCount() / public void setPageCount(int value) |
This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.
getPageIndex/setPageIndex | |
public int getPageIndex() / public void setPageIndex(int value) |
This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.
getPageSavingCallback/setPageSavingCallback | → inherited from FixedPageSaveOptions |
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value) |
Example:
Shows how separate pages are saved when a document is exported to fixed page format.Document doc = new Document(getMyDir() + "Rendering.doc"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); { htmlFixedSaveOptions.setPageIndex(0); htmlFixedSaveOptions.setPageCount(doc.getPageCount()); } htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback()); doc.save(getArtifactsDir() + "Rendering.html", htmlFixedSaveOptions); String[] filePaths = GetFiles(getArtifactsDir() + "", "Page_*.html"); for (int i = 0; i < doc.getPageCount(); i++) { String file = MessageFormat.format(getArtifactsDir() + "Page_{0}.html", i); } } private static String[] GetFiles(final String path, final String searchPattern) { final Pattern re = Pattern.compile(searchPattern.replace("*", ".*").replace("?", ".?")); String[] filenames = new File(path).list(new FilenameFilter() { @Override public boolean accept(File dir, String name) { return new File(dir, name).isFile() && re.matcher(name).matches(); } }); for (int i = 0; i < filenames.length; i++) { filenames[i] = path + filenames[i]; } return filenames; } /** * Custom PageFileName is specified. */ private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback { public void pageSaving(PageSavingArgs args) throws Exception { // Specify name of the output file for the current page. args.setPageFileName(MessageFormat.format(getArtifactsDir() + "Page_{0}.html", args.getPageIndex())); } }
getPaperColor/setPaperColor | |
public java.awt.Color getPaperColor() / public void setPaperColor(java.awt.Color value) |
The default value is
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(getArtifactsDir() + "Rendering.SaveToImagePaperColorTransparent.png", imgOptions); imgOptions.setPaperColor(new Color(0x80, 0x80, 0x70)); doc.save(getArtifactsDir() + "Rendering.SaveToImagePaperColorCoral.png", imgOptions);
getPixelFormat/setPixelFormat | |
public int getPixelFormat() / public void setPixelFormat(int value) |
The default value is
Pixel format of the output image may differ from the set value because of work of GDI+.
Example:
Show how to convert document images to black and white with 1 bit per pixelDocument doc = new Document(getMyDir() + "ImageSaveOptions.BlackAndWhite.docx"); ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG); imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE); imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED); doc.save(getArtifactsDir() + "ImageSaveOptions.BlackAndWhite Out.png", imageSaveOptions);
getPrettyFormat/setPrettyFormat | → inherited from SaveOptions |
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value) |
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(getArtifactsDir() + "Document.PrettyFormat.html", htmlOptions);
setResolution | |
public void setResolution(float value) |
This property has effect only when saving to raster image formats.
Example:
Renders a page of a Word document into a PNG image at a specific resolution.Document doc = new Document(getMyDir() + "Rendering.doc"); ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG); options.setResolution(300); options.setPageCount(1); doc.save(getArtifactsDir() + "Rendering.SaveToImageResolution.png", options);
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
getScale/setScale | |
public float getScale() / public void setScale(float value) |
getTempFolder/setTempFolder | → inherited from SaveOptions |
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value) |
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
The folder must exist and be writable, otherwise an exception will be thrown.
Aspose.Words automatically deletes all temporary files when saving is complete.
getThresholdForFloydSteinbergDithering/setThresholdForFloydSteinbergDithering | |
public byte getThresholdForFloydSteinbergDithering() / public void setThresholdForFloydSteinbergDithering(byte value) |
The default value is 128.
getTiffBinarizationMethod/setTiffBinarizationMethod | |
public int getTiffBinarizationMethod() / public void setTiffBinarizationMethod(int value) |
The default value is ImageBinarizationMethod.Threshold.
getTiffCompression/setTiffCompression | |
public int getTiffCompression() / public void setTiffCompression(int value) |
Has effect only when saving to TIFF.
The default value is
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
Example:
Shows how to update fields before saving into a PDF document.Document doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setUpdateFields(false); doc.save(getArtifactsDir() + "UpdateFields_False.pdf", pdfSaveOptions);
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value) |
Example:
Shows how to update a document time property when you want to save itDocument doc = new Document(getMyDir() + "Document.doc"); //Get last saved time Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime(); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(true);
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
getUseAntiAliasing/setUseAntiAliasing | → inherited from SaveOptions |
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value) |
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:
getUseGdiEmfRenderer/setUseGdiEmfRenderer | |
public boolean getUseGdiEmfRenderer() / public void setUseGdiEmfRenderer(boolean value) |
If set to true
GDI+ metafile renderer is used. I.e. content is written to GDI+ graphics
object and saved to metafile.
If set to false
Aspose.Words metafile renderer is used. I.e. content is written directly
to the metafile format with Aspose.Words.
The default value is true
.
Has effect only when saving to EMF.
Example:
Shows how to save metafiles directly without using GDI+ to EMF.Document doc = new Document(getMyDir() + "SaveOptions.MyraidPro.docx"); ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.EMF); saveOptions.setUseGdiEmfRenderer(false);
Example:
Shows how to save specific document page as image file.Document doc = new Document(getMyDir() + "SaveOptions.MyraidPro.docx"); ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.GIF); //Define which page will save saveOptions.setPageIndex(0); doc.save(getArtifactsDir() + "SaveOptions.MyraidPro Out.gif", saveOptions);
getUseHighQualityRendering/setUseHighQualityRendering | → inherited from SaveOptions |
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value) |
false
.
This property is used when the document is exported to image formats:
getVerticalResolution/setVerticalResolution | |
public float getVerticalResolution() / public void setVerticalResolution(float value) |
This property has effect only when saving to raster image formats.
The default value is 96.
Method Detail |
---|
deepClone | |
public ImageSaveOptions deepClone() |
equals | → inherited from FixedPageSaveOptions |
public boolean equals(java.lang.Object obj) |