ImageSaveOptions
Inheritance: java.lang.Object, com.aspose.diagram.SaveOptions, com.aspose.diagram.RenderingSaveOptions
public class ImageSaveOptions extends RenderingSaveOptions
Allows to specify additional options when rendering diagram pages to images.
Constructors
| Constructor | Description |
|---|---|
| ImageSaveOptions(int saveFormat) | Initializes a new instance of this class that can be used to save rendered images in the Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat or Aspose.Diagram.SaveFileFormat format. |
Methods
| Method | Description |
|---|---|
| createSaveOptions(int saveFormat) | Creates a save options object of a class suitable for the specified save format. |
| equals(Object arg0) | |
| getClass() | |
| getCompositingQuality() | Specifies the quality level to use during compositing. |
| getContentZoom() | This parameter is similar with scale, but not effect the generated image size. |
| getDefaultFont() | When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. |
| getEmfRenderSetting() | Setting for rendering Emf metafile. |
| getEnlargePage() | Specifies whether enlarge page . |
| getExportGuideShapes() | Defines whether need exporting the guide shapes or not. |
| getExportHiddenPage() | Defines whether need exporting the hidden page or not. |
| getImageBrightness() | the brightness for the the generated images. |
| getImageColorMode() | the color mode for the generated images. |
| getImageContrast() | the contrast for the generated images. |
| getInterpolationMode() | Specifies the algorithm that is used when images are scaled or rotated. |
| getJpegQuality() | a value determining the quality of the generated JPEG images. |
| getPageCount() | the number of pages to render when saving to a multipage TIFF file. |
| getPageIndex() | the 0-based index of the first page to render. |
| getPageSize() | the page size for the generated images. |
| getPixelOffsetMode() | a value specifying how pixels are offset during rendering. |
| getResolution() | the resolution for the generated images, in dots per inch. |
| getSameAsPdfConversionArea() | Specifies whether saving area same as pdf . |
| getSaveForegroundPagesOnly() | Specifies whether all pages will be saved in image or only foreground. |
| getSaveFormat() | Specifies the format in which the rendered diagram pages will be saved if this save options object is used. |
| getScale() | the zoom factor for the generated images. |
| getShapes() | shapes to render. |
| getSmoothingMode() | Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. |
| getTiffCompression() | the type of compression to apply when saving generated images to the TIFF format. |
| getWarningCallback() | warning callback. |
| hashCode() | |
| isExportComments() | Defines whether need exporting the comments or not. |
| notify() | |
| notifyAll() | |
| setCompositingQuality(int value) | For the description of this property, please see getCompositingQuality() |
| setContentZoom(float value) | For the description of this property, please see getContentZoom() |
| setDefaultFont(String value) | For the description of this property, please see getDefaultFont() |
| setEmfRenderSetting(int value) | For the description of this property, please see getEmfRenderSetting() |
| setEnlargePage(boolean value) | For the description of this property, please see getEnlargePage() |
| setExportComments(boolean value) | For the description of this property, please see isExportComments() |
| setExportGuideShapes(boolean value) | For the description of this property, please see getExportGuideShapes() |
| setExportHiddenPage(boolean value) | For the description of this property, please see getExportHiddenPage() |
| setImageBrightness(float value) | For the description of this property, please see getImageBrightness() |
| setImageColorMode(int value) | For the description of this property, please see getImageColorMode() |
| setImageContrast(float value) | For the description of this property, please see getImageContrast() |
| setInterpolationMode(int value) | For the description of this property, please see getInterpolationMode() |
| setJpegQuality(int value) | For the description of this property, please see getJpegQuality() |
| setPageCount(int value) | For the description of this property, please see getPageCount() |
| setPageIndex(int value) | For the description of this property, please see getPageIndex() |
| setPageSize(PageSize value) | For the description of this property, please see getPageSize() |
| setPixelOffsetMode(int value) | For the description of this property, please see getPixelOffsetMode() |
| setResolution(float value) | For the description of this property, please see getResolution() |
| setSameAsPdfConversionArea(boolean value) | For the description of this property, please see getSameAsPdfConversionArea() |
| setSaveForegroundPagesOnly(boolean value) | For the description of this property, please see getSaveForegroundPagesOnly() |
| setSaveFormat(int value) | For the description of this property, please see getSaveFormat() |
| setScale(float value) | For the description of this property, please see getScale() |
| setShapes(ShapeCollection value) | For the description of this property, please see getShapes() |
| setSmoothingMode(int value) | For the description of this property, please see getSmoothingMode() |
| setTiffCompression(int value) | For the description of this property, please see getTiffCompression() |
| setWarningCallback(IWarningCallback value) | |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
ImageSaveOptions(int saveFormat)
public ImageSaveOptions(int saveFormat)
Initializes a new instance of this class that can be used to save rendered images in the Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat or Aspose.Diagram.SaveFileFormat format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | Can be Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat or Aspose.Diagram.SaveFileFormat. |
createSaveOptions(int saveFormat)
public static SaveOptions createSaveOptions(int saveFormat)
Creates a save options object of a class suitable for the specified save format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | The Aspose.Diagram.SaveFileFormat for which to create a save options object. |
Returns: SaveOptions - An object of a class that derives from SaveOptions.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCompositingQuality()
public int getCompositingQuality()
Specifies the quality level to use during compositing. This property has effect only when saving to raster image formats. The default value is Aspose.Diagram.Saving.CompositingQuality.
Returns: int
getContentZoom()
public float getContentZoom()
This parameter is similar with scale, but not effect the generated image size. The default value is 1.0. The value must be greater than 0.
Returns: float
getDefaultFont()
public String getDefaultFont()
When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
Returns: java.lang.String
getEmfRenderSetting()
public int getEmfRenderSetting()
Setting for rendering Emf metafile. EMF metafiles identified as “EMF+ Dual” can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
Returns: int
getEnlargePage()
public boolean getEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
Returns: boolean
getExportGuideShapes()
public boolean getExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
Returns: boolean
getExportHiddenPage()
public boolean getExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
Returns: boolean
getImageBrightness()
public float getImageBrightness()
the brightness for the 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.
Returns: float
getImageColorMode()
public int getImageColorMode()
the color mode for the generated images. This property has effect only when saving to raster image formats. The default value is Aspose.Diagram.Saving.ImageColorMode.
Returns: int
getImageContrast()
public float getImageContrast()
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.
Returns: float
getInterpolationMode()
public int getInterpolationMode()
Specifies the algorithm that is used when images are scaled or rotated. This property has effect only when saving to raster image formats. The default value is Aspose.Diagram.Saving.InterpolationMode.
Returns: int
getJpegQuality()
public int getJpegQuality()
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.
Returns: int
getPageCount()
public int getPageCount()
the number of pages to render when saving to a multipage TIFF file. Default is MaxValue which means all pages of the diagram will be rendered.
Returns: int
getPageIndex()
public int getPageIndex()
the 0-based index of the first page to render. Default is 0.
Returns: int
getPageSize()
public PageSize getPageSize()
the page size for the generated images. Can be PageSize or null. The default value is null. If PageSize is null then page size for generated image is obtained from source diagram.
Returns: PageSize
getPixelOffsetMode()
public int getPixelOffsetMode()
a value specifying how pixels are offset during rendering. This property has effect only when saving to raster image formats. The default value is Aspose.Diagram.Saving.PixelOffsetMode.
Returns: int
getResolution()
public float getResolution()
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.
Returns: float
getSameAsPdfConversionArea()
public boolean getSameAsPdfConversionArea()
Specifies whether saving area same as pdf . If true - rendered area same as pdf. If false - rendered area default. The default value is false.
Returns: boolean
getSaveForegroundPagesOnly()
public boolean getSaveForegroundPagesOnly()
Specifies whether all pages will be saved in image or only foreground. If true - rendered only foreground pages(with background if present). If false - rendered foreground pages(with background if present) after that empty background pages. Can return true only when PageCount > 1. The default value is false.
Returns: boolean
getSaveFormat()
public int getSaveFormat()
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat, Aspose.Diagram.SaveFileFormat or Aspose.Diagram.SaveFileFormat.
Returns: int
getScale()
public float getScale()
the zoom factor for the generated images. The default value is 1.0. The value must be greater than 0.
Returns: float
getShapes()
public ShapeCollection getShapes()
shapes to render. Default count is 0.
Returns: ShapeCollection
getSmoothingMode()
public int getSmoothingMode()
Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. This property has effect only when saving to raster image formats. The default value is Aspose.Diagram.Saving.SmoothingMode.
Returns: int
getTiffCompression()
public int getTiffCompression()
the type of compression to apply when saving generated images to the TIFF format. Has effect only when saving to TIFF. The default value is Aspose.Diagram.Saving.TiffCompression.
Returns: int
getWarningCallback()
public IWarningCallback getWarningCallback()
warning callback.
Returns: IWarningCallback
hashCode()
public native int hashCode()
Returns: int
isExportComments()
public boolean isExportComments()
Defines whether need exporting the comments or not. Default value is false.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCompositingQuality(int value)
public void setCompositingQuality(int value)
For the description of this property, please see getCompositingQuality()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setContentZoom(float value)
public void setContentZoom(float value)
For the description of this property, please see getContentZoom()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
setDefaultFont(String value)
public void setDefaultFont(String value)
For the description of this property, please see getDefaultFont()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setEmfRenderSetting(int value)
public void setEmfRenderSetting(int value)
For the description of this property, please see getEmfRenderSetting()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setEnlargePage(boolean value)
public void setEnlargePage(boolean value)
For the description of this property, please see getEnlargePage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportComments(boolean value)
public void setExportComments(boolean value)
For the description of this property, please see isExportComments()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportGuideShapes(boolean value)
public void setExportGuideShapes(boolean value)
For the description of this property, please see getExportGuideShapes()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportHiddenPage(boolean value)
public void setExportHiddenPage(boolean value)
For the description of this property, please see getExportHiddenPage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setImageBrightness(float value)
public void setImageBrightness(float value)
For the description of this property, please see getImageBrightness()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
setImageColorMode(int value)
public void setImageColorMode(int value)
For the description of this property, please see getImageColorMode()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setImageContrast(float value)
public void setImageContrast(float value)
For the description of this property, please see getImageContrast()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
setInterpolationMode(int value)
public void setInterpolationMode(int value)
For the description of this property, please see getInterpolationMode()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setJpegQuality(int value)
public void setJpegQuality(int value)
For the description of this property, please see getJpegQuality()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageCount(int value)
public void setPageCount(int value)
For the description of this property, please see getPageCount()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageIndex(int value)
public void setPageIndex(int value)
For the description of this property, please see getPageIndex()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageSize(PageSize value)
public void setPageSize(PageSize value)
For the description of this property, please see getPageSize()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PageSize |
setPixelOffsetMode(int value)
public void setPixelOffsetMode(int value)
For the description of this property, please see getPixelOffsetMode()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setResolution(float value)
public void setResolution(float value)
For the description of this property, please see getResolution()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
setSameAsPdfConversionArea(boolean value)
public void setSameAsPdfConversionArea(boolean value)
For the description of this property, please see getSameAsPdfConversionArea()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveForegroundPagesOnly(boolean value)
public void setSaveForegroundPagesOnly(boolean value)
For the description of this property, please see getSaveForegroundPagesOnly()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveFormat(int value)
public void setSaveFormat(int value)
For the description of this property, please see getSaveFormat()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setScale(float value)
public void setScale(float value)
For the description of this property, please see getScale()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
setShapes(ShapeCollection value)
public void setShapes(ShapeCollection value)
For the description of this property, please see getShapes()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ShapeCollection |
setSmoothingMode(int value)
public void setSmoothingMode(int value)
For the description of this property, please see getSmoothingMode()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setTiffCompression(int value)
public void setTiffCompression(int value)
For the description of this property, please see getTiffCompression()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |