public class ImageSaveOptions extends SaveOptions
Allows to specify additional options when rendering project pages to images.
Constructor and Description |
---|
ImageSaveOptions(int saveFormat)
Initializes a new instance of the
ImageSaveOptions class which can be used to save rendered images in
TIFF, PNG, BMP or JPEG formats. |
Modifier and Type | Method and Description |
---|---|
void |
copyOutputPropertiesFrom(SaveOptions source)
Reserved for internal usage.
|
SaveOptions |
deepClone()
Reserved for internal usage.
|
String |
getDefaultFontName()
Gets the default font for rendering.
|
float |
getHorizontalResolution()
Gets the horizontal resolution in dpi.
|
int |
getJpegQuality()
Gets a JPEG quality.
|
List<Integer> |
getPages()
Gets a list of page numbers to save when saving project layout to separate files.
|
IPageSavingCallback |
getPageSavingCallback()
Gets a user-defined callback which is used to get an output stream for each rendered page.
|
int |
getPixelFormat()
Gets the format of the color data for each pixel in the image.
|
boolean |
getReduceFooterGap()
Gets a value indicating whether a gap between last task and the footer must be reduced.
|
boolean |
getSaveToSeparateFiles()
Gets a value indicating whether to save project pages to separate files.
|
int |
getTiffCompression()
Gets the type of compression to apply when saving generated images to the TIFF format.
|
boolean |
getUseProjectDefaultFont()
Gets a value indicating whether the default font must be used for rendering.
|
float |
getVerticalResolution()
Gets the vertical resolution in dpi.
|
void |
setDefaultFontName(String value)
Sets the default font for rendering.
|
void |
setHorizontalResolution(float value)
Sets the horizontal resolution in dpi.
|
void |
setJpegQuality(int value)
Sets a JPEG quality.
|
void |
setPages(List<Integer> value)
Sets a list of page numbers to save when saving project layout to separate files.
|
void |
setPageSavingCallback(IPageSavingCallback value)
Sets a user-defined callback which is used to get an output stream for each rendered page.
|
void |
setPixelFormat(int value)
Sets the format of the color data for each pixel in the image.
|
void |
setReduceFooterGap(boolean value)
Sets a value indicating whether a gap between last task and the footer must be reduced.
|
void |
setSaveToSeparateFiles(boolean value)
Sets a value indicating whether to save project pages to separate files.
|
void |
setTiffCompression(int value)
Sets the type of compression to apply when saving generated images to the TIFF format.
|
void |
setUseProjectDefaultFont(boolean value)
Sets a value indicating whether the default font must be used for rendering.
|
void |
setVerticalResolution(float value)
Sets the vertical resolution in dpi.
|
getBarStyles, getDrawNonWorkingTime, getEndDate, getFitContent, getGridlines, getLegendOnEachPage, getMarkCriticalTasks, getNonWorkingTimeColor, getPageCount, getPageSize, getPresentationFormat, getRollUpGanttBars, getSaveFormat, getStartDate, getTasksComparer, getTasksFilter, getTextStyles, getTimescale, getTimescaleTier, getUseGradientBrush, getView, setBarStyles, setDrawNonWorkingTime, setEndDate, setFitContent, setGridlines, setLegendOnEachPage, setMarkCriticalTasks, setNonWorkingTimeColor, setPageSize, setPresentationFormat, setRollUpGanttBars, setStartDate, setTasksComparer, setTasksFilter, setTextStyles, setTimescale, setTimescaleTier, setUseGradientBrush, setView
public ImageSaveOptions(int saveFormat)
Initializes a new instance of the ImageSaveOptions
class which can be used to save rendered images in
TIFF, PNG, BMP or JPEG formats.
saveFormat
- Can be TIFF, PNG, BMP or JPEGSaveFileFormat
.com.aspose.ms.System.ArgumentException
- Thrown of saveFormat
is not a valid image format. The valid values are
TIFF, PNG, BMP or JPEG.public final void copyOutputPropertiesFrom(SaveOptions source)
source
- Reserved for internal usage.public SaveOptions deepClone()
public final String getDefaultFontName()
Gets the default font for rendering.
public final void setDefaultFontName(String value)
Sets the default font for rendering.
value
- the default font for rendering.public final float getHorizontalResolution()
Gets the horizontal resolution in dpi.
public final void setHorizontalResolution(float value)
Sets the horizontal resolution in dpi.
value
- the horizontal resolution in dpi.public final int getJpegQuality()
Gets a JPEG quality.
public final void setJpegQuality(int value)
Sets a JPEG quality.
value
- a JPEG quality.public final IPageSavingCallback getPageSavingCallback()
Gets a user-defined callback which is used to get an output stream for each rendered page.
Is applicable when SaveToSeparateFiles
(getSaveToSeparateFiles()
/setSaveToSeparateFiles(boolean)
) option is used.
public final void setPageSavingCallback(IPageSavingCallback value)
Sets a user-defined callback which is used to get an output stream for each rendered page.
Is applicable when SaveToSeparateFiles
(getSaveToSeparateFiles()
/setSaveToSeparateFiles(boolean)
) option is used.
value
- a user-defined callback which is used to get an output stream for each rendered page.public final List<Integer> getPages()
Gets a list of page numbers to save when saving project layout to separate files.
public final void setPages(List<Integer> value)
Sets a list of page numbers to save when saving project layout to separate files.
value
- a list of page numbers to save when saving project layout to separate files.public final int getPixelFormat()
Gets the format of the color data for each pixel in the image.
public final void setPixelFormat(int value)
Sets the format of the color data for each pixel in the image.
value
- the format of the color data for each pixel in the image.public final boolean getReduceFooterGap()
Gets a value indicating whether a gap between last task and the footer must be reduced.
public final void setReduceFooterGap(boolean value)
Sets a value indicating whether a gap between last task and the footer must be reduced.
value
- a value indicating whether a gap between last task and the footer must be reduced.public final boolean getSaveToSeparateFiles()
Gets a value indicating whether to save project pages to separate files.
public final void setSaveToSeparateFiles(boolean value)
Sets a value indicating whether to save project pages to separate files.
value
- a value indicating whether to save project pages to separate files.public final int getTiffCompression()
Gets the type of compression to apply when saving generated images to the TIFF format.
TiffCompressionLZW
(getTiffCompression()
/setTiffCompression(int)
).
public final void setTiffCompression(int value)
Sets the type of compression to apply when saving generated images to the TIFF format.
TiffCompressionLZW
(getTiffCompression()
/setTiffCompression(int)
).
value
- the type of compression to apply when saving generated images to the TIFF format.public final boolean getUseProjectDefaultFont()
Gets a value indicating whether the default font must be used for rendering.
public final void setUseProjectDefaultFont(boolean value)
Sets a value indicating whether the default font must be used for rendering.
value
- a value indicating whether the default font must be used for rendering.public final float getVerticalResolution()
Gets the vertical resolution in dpi.
public final void setVerticalResolution(float value)
Sets the vertical resolution in dpi.
value
- the vertical resolution in dpi.