DownsampleOptions
Contents
[
Hide
]DownsampleOptions class
Allows to specify downsample options.
To learn more, visit the Save a Document documentation article.
public class DownsampleOptions
Constructors
Name | Description |
---|---|
DownsampleOptions() | The default constructor. |
Properties
Name | Description |
---|---|
DownsampleImages { get; set; } | Specifies whether images should be downsampled. |
Resolution { get; set; } | Specifies the resolution in pixels per inch which the images should be downsampled to. |
ResolutionThreshold { get; set; } | 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. |
Examples
Shows how to change the resolution of images in the PDF document.
Document doc = new Document(MyDir + "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.True(options.DownsampleOptions.DownsampleImages);
Assert.AreEqual(220, options.DownsampleOptions.Resolution);
Assert.AreEqual(0, options.DownsampleOptions.ResolutionThreshold);
doc.Save(ArtifactsDir + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
// Set the "Resolution" property to "36" to downsample all images to 36 ppi.
options.DownsampleOptions.Resolution = 36;
// Set the "ResolutionThreshold" property to only apply the downsampling to
// images with a resolution that is above 128 ppi.
options.DownsampleOptions.ResolutionThreshold = 128;
// Only the first two images from the document will be downsampled at this stage.
doc.Save(ArtifactsDir + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
See Also
- namespace Aspose.Words.Saving
- assembly Aspose.Words