pixelFormat property

ImageSaveOptions.pixelFormat property

Gets or sets the pixel format for the generated images.

get pixelFormat(): Aspose.Words.Saving.ImagePixelFormat

Remarks

This property has effect only when saving to raster image formats.

The default value is ImagePixelFormat.Format32BppArgb.

Pixel format of the output image may differ from the set value because of work of GDI+.

Examples

Shows how to select a bit-per-pixel rate with which to render a document to an image.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

builder.paragraphFormat.style = doc.styles.at("Heading 1");
builder.writeln("Hello world!");
builder.insertImage(base.imageDir + "Logo.jpg");

// When we save the document as an image, we can pass a SaveOptions object to
// select a pixel format for the image that the saving operation will generate.
// Various bit per pixel rates will affect the quality and file size of the generated image.
let imageSaveOptions = new aw.Saving.ImageSaveOptions(aw.SaveFormat.Png);
imageSaveOptions.pixelFormat = imagePixelFormat;

// We can clone ImageSaveOptions instances.
expect(imageSaveOptions.clone()).not.toBe(imageSaveOptions);
expect(imageSaveOptions.clone()).toEqual(imageSaveOptions);

doc.save(base.artifactsDir + "ImageSaveOptions.pixelFormat.png", imageSaveOptions);

See Also

ImageSaveOptions.paperColor property ImageSaveOptions.saveFormat property