com.aspose.slides

Class TiffOptions

java.lang.Object

com.aspose.slides.SaveOptions

com.aspose.slides.TiffOptions

All Implemented Interfaces:

ISaveOptions, ITiffOptions

public class TiffOptions
extends SaveOptions
implements ITiffOptions

Provides options that control how a presentation is saved in TIFF format.

 The following example shows how to convert PowerPoint to TIFF with default size.
 
 // Instantiate a Presentation object that represents a presentation file
 Presentation pres = new Presentation("DemoFile.pptx");
 try {
     // Saving the presentation to TIFF document
     pres.save("Tiffoutput_out.tiff", SaveFormat.Tiff);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to convert PowerPoint to TIFF with custom size.
 
 // Instantiate a Presentation object that represents a Presentation file
 Presentation pres = new Presentation("Convert_Tiff_Custom.pptx");
 try {
     // Instantiate the TiffOptions class
     TiffOptions opts = new TiffOptions();
     // Setting compression type
     opts.setCompressionType(TiffCompressionTypes.Default);
     NotesCommentsLayoutingOptions notesOptions = new NotesCommentsLayoutingOptions();
     notesOptions.setNotesPosition(NotesPositions.BottomFull);
     opts.setSlidesLayoutOptions(notesOptions);
     // Compression Types
     // Default - Specifies the default compression scheme (LZW).
     // None - Specifies no compression.
     // CCITT3
     // CCITT4
     // LZW
     // RLE
     // Depth depends on the compression type and cannot be set manually.
     // Resolution unit  is always equal to 2 (dots per inch)
     // Setting image DPI
     opts.setDpiX(200);
     opts.setDpiY(100);
     // Set Image Size
     opts.setImageSize(new Dimension(1728, 1078));
     // Save the presentation to TIFF with specified image size
     pres.save("TiffWithCustomSize_out.tiff", SaveFormat.Tiff, opts);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to convert PowerPoint to TIFF with custom image pixel format.
 
 // Instantiate a Presentation object that represents a Presentation file
 Presentation pres = new Presentation("DemoFile.pptx");
 try {
     TiffOptions options = new TiffOptions();
     options.setPixelFormat(ImagePixelFormat.Format8bppIndexed);

     //ImagePixelFormat contains the following values (as could be seen from documentation):
     //Format1bppIndexed; // 1 bits per pixel, indexed.
     //Format4bppIndexed; // 4 bits per pixel, indexed.
     //Format8bppIndexed; // 8 bits per pixel, indexed.
     //Format24bppRgb; // 24 bits per pixel, RGB.
     //Format32bppArgb; // 32 bits per pixel, ARGB.

     // Save the presentation to TIFF with specified image size
     pres.save("Tiff_With_Custom_Image_Pixel_Format_out.tiff", SaveFormat.Tiff, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Constructor Summary

Constructors

Constructor and Description
TiffOptions() Default constructor.

Method Summary

Modifier and Type	Method and Description
int	getBwConversionMode() Specifies the algorithm for converting a color image into a black and white image.
int	getCompressionType() Specifies the compression type.
long	getDpiX() Specifies the horizontal resolution in dots per inch.
long	getDpiY() Specifies the vertical resolution in dots per inch.
java.awt.Dimension	getImageSize() Specifies size of a generated TIFF image.
IInkOptions	getInkOptions() Provides options that control the look of Ink objects in exported document.
int	getPixelFormat() Specifies the pixel format for the generated images.
boolean	getShowHiddenSlides() Specifies whether the generated document should include hidden slides or not.
ISlidesLayoutOptions	getSlidesLayoutOptions() Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
void	setBwConversionMode(int value) Specifies the algorithm for converting a color image into a black and white image.
void	setCompressionType(int value) Specifies the compression type.
void	setDpiX(long value) Specifies the horizontal resolution in dots per inch.
void	setDpiY(long value) Specifies the vertical resolution in dots per inch.
void	setImageSize(java.awt.Dimension value) Specifies size of a generated TIFF image.
void	setPixelFormat(int value) Specifies the pixel format for the generated images.
void	setShowHiddenSlides(boolean value) Specifies whether the generated document should include hidden slides or not.
void	setSlidesLayoutOptions(ISlidesLayoutOptions value) Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.

Methods inherited from class com.aspose.slides.SaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.ISaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Constructor Detail

TiffOptions

public TiffOptions()

Default constructor.

Method Detail

getInkOptions

public final IInkOptions getInkOptions()

Provides options that control the look of Ink objects in exported document. Read-only IInkOptions

Specified by:

getInkOptions in interface ITiffOptions

getShowHiddenSlides

public final boolean getShowHiddenSlides()

Specifies whether the generated document should include hidden slides or not. Default is false.

Specified by:

getShowHiddenSlides in interface ITiffOptions

setShowHiddenSlides

public final void setShowHiddenSlides(boolean value)

Specifies whether the generated document should include hidden slides or not. Default is false.

Specified by:

setShowHiddenSlides in interface ITiffOptions

getImageSize

public final java.awt.Dimension getImageSize()

Specifies size of a generated TIFF image. Default value is 0x0, what means that generated image sizes will be calculated based on presentation slide size value. Read/write Dimension.

Specified by:

getImageSize in interface ITiffOptions

setImageSize

public final void setImageSize(java.awt.Dimension value)

Specifies size of a generated TIFF image. Default value is 0x0, what means that generated image sizes will be calculated based on presentation slide size value. Read/write Dimension.

Specified by:

setImageSize in interface ITiffOptions

getDpiX

public final long getDpiX()

Specifies the horizontal resolution in dots per inch. Read/write long.

Specified by:

getDpiX in interface ITiffOptions

setDpiX

public final void setDpiX(long value)

Specifies the horizontal resolution in dots per inch. Read/write long.

Specified by:

setDpiX in interface ITiffOptions

getDpiY

public final long getDpiY()

Specifies the vertical resolution in dots per inch. Read/write long.

Specified by:

getDpiY in interface ITiffOptions

setDpiY

public final void setDpiY(long value)

Specifies the vertical resolution in dots per inch. Read/write long.

Specified by:

setDpiY in interface ITiffOptions

getCompressionType

public final int getCompressionType()

Specifies the compression type. Read/write TiffCompressionTypes.

Specified by:

getCompressionType in interface ITiffOptions

setCompressionType

public final void setCompressionType(int value)

Specifies the compression type. Read/write TiffCompressionTypes.

Specified by:

setCompressionType in interface ITiffOptions

getPixelFormat

public final int getPixelFormat()

Specifies the pixel format for the generated images. Read/write ImagePixelFormat.

Specified by:

getPixelFormat in interface ITiffOptions

setPixelFormat

public final void setPixelFormat(int value)

Specifies the pixel format for the generated images. Read/write ImagePixelFormat.

Specified by:

setPixelFormat in interface ITiffOptions

getSlidesLayoutOptions

public final ISlidesLayoutOptions getSlidesLayoutOptions()

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     TiffOptions options = new TiffOptions();
     HandoutLayoutingOptions slidesLayoutOptions = new HandoutLayoutingOptions();
     slidesLayoutOptions.setHandout(HandoutType.Handouts4Horizontal);
     options.setSlidesLayoutOptions(slidesLayoutOptions);

     pres.save("pres.tiff", SaveFormat.Tiff, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getSlidesLayoutOptions in interface ITiffOptions

setSlidesLayoutOptions

public final void setSlidesLayoutOptions(ISlidesLayoutOptions value)

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     TiffOptions options = new TiffOptions();
     HandoutLayoutingOptions slidesLayoutOptions = new HandoutLayoutingOptions();
     slidesLayoutOptions.setHandout(HandoutType.Handouts4Horizontal);
     options.setSlidesLayoutOptions(slidesLayoutOptions);

     pres.save("pres.tiff", SaveFormat.Tiff, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setSlidesLayoutOptions in interface ITiffOptions

getBwConversionMode

public final int getBwConversionMode()

Specifies the algorithm for converting a color image into a black and white image. This option will applied only if CompressionType(getCompressionType()/setCompressionType(int)) is set to TiffCompressionTypes.CCITT4 or TiffCompressionTypes.CCITT3 Read/write BlackWhiteConversionMode. Default is BlackWhiteConversionMode.Default.

 
 TiffOptions tiffOptions = new TiffOptions();
 tiffOptions.setCompressionType(TiffCompressionTypes.CCITT4);
 tiffOptions.setBwConversionMode(BlackWhiteConversionMode.Dithering);
 Presentation presentation = new Presentation();
 try {
     presentation.save(tiffFilePath, SaveFormat.Tiff, tiffOptions);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getBwConversionMode in interface ITiffOptions

setBwConversionMode

public final void setBwConversionMode(int value)

Specifies the algorithm for converting a color image into a black and white image. This option will applied only if CompressionType(getCompressionType()/setCompressionType(int)) is set to TiffCompressionTypes.CCITT4 or TiffCompressionTypes.CCITT3 Read/write BlackWhiteConversionMode. Default is BlackWhiteConversionMode.Default.

 
 TiffOptions tiffOptions = new TiffOptions();
 tiffOptions.setCompressionType(TiffCompressionTypes.CCITT4);
 tiffOptions.setBwConversionMode(BlackWhiteConversionMode.Dithering);
 Presentation presentation = new Presentation();
 try {
     presentation.save(tiffFilePath, SaveFormat.Tiff, tiffOptions);
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setBwConversionMode in interface ITiffOptions