DownsampleOptions
Inheritance: java.lang.Object
public class DownsampleOptions
Allows to specify downsample options.
To learn more, visit the Save a Document documentation article.
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Methods
| Method | Description |
|---|---|
| getDownsampleImages() | Specifies whether images should be downsampled. |
| getResolution() | Specifies the resolution in pixels per inch which the images should be downsampled to. |
| getResolutionThreshold() | Specifies the threshold resolution in pixels per inch. |
| setDownsampleImages(boolean value) | Specifies whether images should be downsampled. |
| setResolution(int value) | Specifies the resolution in pixels per inch which the images should be downsampled to. |
| setResolutionThreshold(int value) | Specifies the threshold resolution in pixels per inch. |
getDownsampleImages()
public boolean getDownsampleImages()
Specifies whether images should be downsampled.
Remarks:
The default value is true .
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Returns: boolean - The corresponding boolean value.
getResolution()
public int getResolution()
Specifies the resolution in pixels per inch which the images should be downsampled to.
Remarks:
The default value is 220 ppi.
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Returns: int - The corresponding int value.
getResolutionThreshold()
public int getResolutionThreshold()
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.
Remarks:
The default value is 0.
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Returns: int - The corresponding int value.
setDownsampleImages(boolean value)
public void setDownsampleImages(boolean value)
Specifies whether images should be downsampled.
Remarks:
The default value is true .
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setResolution(int value)
public void setResolution(int value)
Specifies the resolution in pixels per inch which the images should be downsampled to.
Remarks:
The default value is 220 ppi.
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
setResolutionThreshold(int value)
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.
Remarks:
The default value is 0.
Examples:
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(getMyDir() + "Images.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.getDownsampleOptions().setResolution(36);
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.getDownsampleOptions().setResolutionThreshold(128);
// Only the first two images from the document will be downsampled at this stage.
doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
