ITiffOptions

All Implemented Interfaces: com.aspose.slides.ISaveOptions

public interface ITiffOptions extends ISaveOptions

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

Methods

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

getImageSize()

public abstract 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 java.awt.Dimension.

Returns: java.awt.Dimension

setImageSize(Dimension value)

public abstract void setImageSize(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 java.awt.Dimension.

Parameters:

ParameterTypeDescription
valuejava.awt.Dimension

getDpiX()

public abstract long getDpiX()

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

Returns: long

setDpiX(long value)

public abstract void setDpiX(long value)

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

Parameters:

ParameterTypeDescription
valuelong

getDpiY()

public abstract long getDpiY()

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

Returns: long

setDpiY(long value)

public abstract void setDpiY(long value)

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

Parameters:

ParameterTypeDescription
valuelong

getShowHiddenSlides()

public abstract boolean getShowHiddenSlides()

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

Returns: boolean

setShowHiddenSlides(boolean value)

public abstract void setShowHiddenSlides(boolean value)

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

Parameters:

ParameterTypeDescription
valueboolean

getCompressionType()

public abstract int getCompressionType()

Specifies the compression type. Read/write TiffCompressionTypes.

Returns: int

setCompressionType(int value)

public abstract void setCompressionType(int value)

Specifies the compression type. Read/write TiffCompressionTypes.

Parameters:

ParameterTypeDescription
valueint

getPixelFormat()

public abstract int getPixelFormat()

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

Returns: int

setPixelFormat(int value)

public abstract void setPixelFormat(int value)

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

Parameters:

ParameterTypeDescription
valueint

getNotesCommentsLayouting()

public abstract INotesCommentsLayoutingOptions getNotesCommentsLayouting()

Provides options that control how notes and comments is placed in exported document.

Returns: INotesCommentsLayoutingOptions

getSlidesLayoutOptions()

public abstract 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();
 }

Returns: ISlidesLayoutOptions

setSlidesLayoutOptions(ISlidesLayoutOptions value)

public abstract 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();
 }

Parameters:

ParameterTypeDescription
valueISlidesLayoutOptions

getBwConversionMode()

public abstract int getBwConversionMode()

Specifies the algorithm for converting a color image into a black and white image. This option will applied only if CompressionType (#getCompressionType.getCompressionType/#setCompressionType(int).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();
 }

Returns: int

setBwConversionMode(int value)

public abstract 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.getCompressionType/#setCompressionType(int).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();
 }

Parameters:

ParameterTypeDescription
valueint

getInkOptions()

public abstract IInkOptions getInkOptions()

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

Returns: IInkOptions