com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class ImageSaveOptions



  • public final class ImageSaveOptions
    extends SaveOptions

    Allows to specify additional options when rendering project pages to images.

    • Constructor Detail

      • ImageSaveOptions

        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.

        Parameters:
        saveFormat - Can be TIFF, PNG, BMP or JPEGSaveFileFormat.
        Throws:
        com.aspose.ms.System.ArgumentException - Thrown of saveFormat is not a valid image format. The valid values are TIFF, PNG, BMP or JPEG.
    • Method Detail

      • getDefaultFontName

        public final String getDefaultFontName()
        Gets the default font for rendering.
        Returns:
        the default font name for rendering.
      • setDefaultFontName

        public void setDefaultFontName(String value)
        Sets the default font for rendering.
        Parameters:
        value - the default font name for rendering.
      • getHorizontalResolution

        public final float getHorizontalResolution()
        Gets the horizontal resolution in dpi.
        Returns:
        the horizontal resolution in dpi.
      • setHorizontalResolution

        public final void setHorizontalResolution(float value)
        Sets the horizontal resolution in dpi.
        Parameters:
        value - the horizontal resolution in dpi.
      • getJpegQuality

        public final int getJpegQuality()
        Gets a JPEG quality.
        Returns:
        a JPEG quality.
      • setJpegQuality

        public final void setJpegQuality(int value)
        Sets a JPEG quality.
        Parameters:
        value - a JPEG quality.
      • getPages

        public final List<Integer> getPages()

        Gets a list of page numbers to save when saving project layout to separate files.


        All pages will be saved if this list is empty.

        Returns:
        a list of page numbers to save when saving project layout to separate files.
      • setPages

        public final void setPages(List<Integer> value)

        Sets a list of page numbers to save when saving project layout to separate files.


        All pages will be saved if this list is empty.

        Parameters:
        value - a list of page numbers to save when saving project layout to separate files.
      • getPixelFormat

        public final int getPixelFormat()

        Gets the format of the color data for each pixel in the image.

        Returns:
        the format of the color data for each pixel in the image.
      • setPixelFormat

        public final void setPixelFormat(int value)
        Sets the format of the color data for each pixel in the image.
        Parameters:
        value - the format of the color data for each pixel in the image.
      • getReduceFooterGap

        public final boolean getReduceFooterGap()
        Gets a value indicating whether a gap between last task and the footer must be reduced.
        Returns:
        a value indicating whether a gap between last task and the footer must be reduced.
      • setReduceFooterGap

        public final void setReduceFooterGap(boolean value)
        Sets a value indicating whether a gap between last task and the footer must be reduced.
        Parameters:
        value - a value indicating whether a gap between last task and the footer must be reduced.
      • getSaveToSeparateFiles

        public final boolean getSaveToSeparateFiles()

        Gets a value indicating whether to save project pages to separate files.

        Returns:
        a value indicating whether to save project pages to separate files.
      • setSaveToSeparateFiles

        public final void setSaveToSeparateFiles(boolean value)

        Sets a value indicating whether to save project pages to separate files.

        Parameters:
        value - a value indicating whether to save project pages to separate files.
      • getTiffCompression

        public final int getTiffCompression()

        Gets 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 TiffCompressionLzw(getTiffCompression()/setTiffCompression(int)).

        Returns:
        the type of compression to apply when saving generated images to the TIFF format.
      • setTiffCompression

        public final void setTiffCompression(int value)

        Sets 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 TiffCompressionLzw(getTiffCompression()/setTiffCompression(int)).

        Parameters:
        value - the type of compression to apply when saving generated images to the TIFF format.
      • getUseProjectDefaultFont

        public final boolean getUseProjectDefaultFont()
        Gets a value indicating whether the default font must be used for rendering.
        Returns:
        a value indicating whether the default font must be used for rendering.
      • setUseProjectDefaultFont

        public final void setUseProjectDefaultFont(boolean value)
        Sets a value indicating whether the default font must be used for rendering.
        Parameters:
        value - a value indicating whether the default font must be used for rendering.
      • getVerticalResolution

        public final float getVerticalResolution()

        Gets the vertical resolution in dpi.

        Returns:
        the vertical resolution in dpi.
      • setVerticalResolution

        public final void setVerticalResolution(float value)
        Sets the vertical resolution in dpi.
        Parameters:
        value - the vertical resolution in dpi.