com.aspose.words
Class DownsampleOptions

java.lang.Object
    extended by com.aspose.words.DownsampleOptions

public class DownsampleOptions 
extends java.lang.Object

Allows to specify downsample options.

Example:

Shows how to change the resolution of images in output pdf documents.
// Open a document that contains images
Document doc = new Document(getMyDir() + "Rendering.doc");

// If we want to convert the document to .pdf, we can use a SaveOptions implementation to customize the saving process
PdfSaveOptions options = new PdfSaveOptions();

// This conversion will downsample images by default
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(options.getDownsampleOptions().getResolution(), 220);

// We can set the output resolution to a different value
// The first two images in the input document will be affected by this
options.getDownsampleOptions().setResolution(36);

// We can set a minimum threshold for downsampling
// This value will prevent the second image in the input document from being downsampled
options.getDownsampleOptions().setResolutionThreshold(128);

doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.pdf", options);

Constructor Summary
DownsampleOptions()
          
 
Property Getters/Setters Summary
booleangetDownsampleImages()
voidsetDownsampleImages(boolean value)
           Specifies whether images should be downsampled.
intgetResolution()
voidsetResolution(int value)
           Specifies the resolution in pixels per inch which the images should be downsampled to.
intgetResolutionThreshold()
voidsetResolutionThreshold(int value)
           Specifies the threshold resolution in pixels per inch. If resolution of an image in the document is less than threshold value, the downsampling algorithm will not be applied. A value of 0 means the threshold check is not used and all images that can be reduced in size are downsampled.
 

Constructor Detail

DownsampleOptions

public DownsampleOptions()

Property Getters/Setters Detail

getDownsampleImages/setDownsampleImages

public boolean getDownsampleImages() / public void setDownsampleImages(boolean value)
Specifies whether images should be downsampled. The default value is true.

Example:

Shows how to change the resolution of images in output pdf documents.
// Open a document that contains images
Document doc = new Document(getMyDir() + "Rendering.doc");

// If we want to convert the document to .pdf, we can use a SaveOptions implementation to customize the saving process
PdfSaveOptions options = new PdfSaveOptions();

// This conversion will downsample images by default
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(options.getDownsampleOptions().getResolution(), 220);

// We can set the output resolution to a different value
// The first two images in the input document will be affected by this
options.getDownsampleOptions().setResolution(36);

// We can set a minimum threshold for downsampling
// This value will prevent the second image in the input document from being downsampled
options.getDownsampleOptions().setResolutionThreshold(128);

doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.pdf", options);

getResolution/setResolution

public int getResolution() / public void setResolution(int value)
Specifies the resolution in pixels per inch which the images should be downsampled to. The default value is 220 ppi.

Example:

Shows how to change the resolution of images in output pdf documents.
// Open a document that contains images
Document doc = new Document(getMyDir() + "Rendering.doc");

// If we want to convert the document to .pdf, we can use a SaveOptions implementation to customize the saving process
PdfSaveOptions options = new PdfSaveOptions();

// This conversion will downsample images by default
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(options.getDownsampleOptions().getResolution(), 220);

// We can set the output resolution to a different value
// The first two images in the input document will be affected by this
options.getDownsampleOptions().setResolution(36);

// We can set a minimum threshold for downsampling
// This value will prevent the second image in the input document from being downsampled
options.getDownsampleOptions().setResolutionThreshold(128);

doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.pdf", options);

getResolutionThreshold/setResolutionThreshold

public int getResolutionThreshold() / public void setResolutionThreshold(int value)
Specifies the threshold resolution in pixels per inch. If resolution of an image in the document is less than threshold value, the downsampling algorithm will not be applied. A value of 0 means the threshold check is not used and all images that can be reduced in size are downsampled. The default value is 0.

Example:

Shows how to change the resolution of images in output pdf documents.
// Open a document that contains images
Document doc = new Document(getMyDir() + "Rendering.doc");

// If we want to convert the document to .pdf, we can use a SaveOptions implementation to customize the saving process
PdfSaveOptions options = new PdfSaveOptions();

// This conversion will downsample images by default
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(options.getDownsampleOptions().getResolution(), 220);

// We can set the output resolution to a different value
// The first two images in the input document will be affected by this
options.getDownsampleOptions().setResolution(36);

// We can set a minimum threshold for downsampling
// This value will prevent the second image in the input document from being downsampled
options.getDownsampleOptions().setResolutionThreshold(128);

doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.pdf", options);

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.