java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.ImageSaveOptions
public class ImageSaveOptions
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 |
||
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. | ||
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() | |
Gets or sets the background (paper) color for the generated images.
The default value is |
||
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. | ||
Aspose.Words.SaveFormat | getSaveFormat() | |
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.
|
||
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 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) | |
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. | ||
Aspose.Words.IWarningCallback | getWarningCallback() | → inherited from SaveOptions |
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss. |
Method Summary | ||
---|---|---|
ImageSaveOptions | deepClone() | |
Creates a deep clone of this object. |
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.
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.
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
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.
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
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) |
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) |
getPaperColor | |
public java.awt.Color getPaperColor() |
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.
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.
setResolution | |
public void setResolution(float value) |
This property has effect only when saving to raster image formats.
getSaveFormat | |
public Aspose.Words.SaveFormat getSaveFormat() |
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.
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) |
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value) |
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.
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.
getWarningCallback | → inherited from SaveOptions |
public Aspose.Words.IWarningCallback getWarningCallback() |
This property is obsolete. Please use
Method Detail |
---|
deepClone | |
public ImageSaveOptions deepClone() |