JpegOptions

JpegOptions class

The jpeg file format create options.

public class JpegOptions : ImageOptionsBase

Constructors

Name Description
JpegOptions() Initializes a new instance of the JpegOptions class.
JpegOptions(JpegOptions) Initializes a new instance of the JpegOptions class.

Properties

Name Description
BitsPerChannel { get; set; } Gets or sets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel.
BufferSizeHint { get; set; } Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
CmykColorProfile { get; set; } The destination CMYK color profile for CMYK jpeg images. Use for saving images. Must be in pair with RGBColorProfile for correct color conversion.
ColorType { get; set; } Gets or sets the color type for jpeg image.
Comment { get; set; } Gets or sets the jpeg file comment.
CompressionType { get; set; } Gets or sets the compression type.
Disposed { get; } Gets a value indicating whether this instance is disposed.
ExifData { get; set; } Get or set exif data container
FullFrame { get; set; } Gets or sets a value indicating whether [full frame].
HorizontalSampling { get; set; } Gets or sets the horizontal subsamplings for each component.
Jfif { get; set; } Gets or sets the jfif.
JpegLsAllowedLossyError { get; set; } Gets or sets the JPEG-LS difference bound for near-lossless coding (NEAR parameter from the JPEG-LS specification).
JpegLsInterleaveMode { get; set; } Gets or sets the JPEG-LS interleave mode.
JpegLsPreset { get; set; } Gets or sets the JPEG-LS preset parameters.
MultiPageOptions { get; set; } The multipage options
virtual Palette { get; set; } Gets or sets the color palette.
PreblendAlphaIfPresent { get; set; } Gets or sets a value indicating whether red, green and blue components should be mixed with a background color, if alpha channel is present.
ProgressEventHandler { get; set; } Gets or sets the progress event handler.
Quality { get; set; } Gets or sets image quality.
RdOptSettings { get; set; } Gets or sets the RD optimizer settings.
virtual ResolutionSettings { get; set; } Gets or sets the resolution settings.
ResolutionUnit { get; set; } Gets or sets the resolution unit.
RgbColorProfile { get; set; } The destination RGB color profile for CMYK jpeg images. Use for saving images. Must be in pair with CMYKColorProfile for correct color conversion.
SampleRoundingMode { get; set; } Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value. BitsPerChannel
ScaledQuality { get; } The scaled quality.
Source { get; set; } Gets or sets the source to create image in.
VectorRasterizationOptions { get; set; } Gets or sets the vector rasterization options.
VerticalSampling { get; set; } Gets or sets the vertical subsamplings for each component.
override XmpData { get; set; } Gets or sets the XMP metadata container.

Methods

Name Description
virtual Clone() Clones this instance.
Dispose() Disposes the current instance.

Examples

This example demonstrates the use of System.IO.Stream to Create a new Image file (a JPEG type)

[C#]

//Creates an instance of JpegOptions and set its various properties
Aspose.Imaging.ImageOptions.JpegOptions jpegOptions = new Aspose.Imaging.ImageOptions.JpegOptions();

//Create an instance of System.IO.Stream
System.IO.Stream stream = new System.IO.FileStream(@"C:\temp\sample.jpeg", System.IO.FileMode.Create);

//Define the source property for the instance of JpegOptions
//Second boolean parameter determins if the Stream is disposed once get out of scope
jpegOptions.Source = new Aspose.Imaging.Sources.StreamSource(stream, true);

//Creates an instance of Image and call Create method with JpegOptions as parameter to initialize the Image object   
using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Create(jpegOptions, 500, 500))
{
    //do some image processing
}

This example demonstrates the use of different classes from SaveOptions Namespace for export purposes. An image of type Gif is loaded into an instance of Image and then exported out to several formats.

[C#]

string dir = "c:\\temp\\";

//Load an existing image (of type Gif) in an instance of Image class
using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(dir + "sample.gif"))
{
    //Export to BMP file format using the default options
    image.Save(dir + "output.bmp", new Aspose.Imaging.ImageOptions.BmpOptions());

    //Export to JPEG file format using the default options
    image.Save(dir + "output.jpg", new Aspose.Imaging.ImageOptions.JpegOptions());

    //Export to PNG file format using the default options
    image.Save(dir + "output.png", new Aspose.Imaging.ImageOptions.PngOptions());

    //Export to TIFF file format using the default options
    image.Save(dir + "output.tif", new Aspose.Imaging.ImageOptions.TiffOptions(Aspose.Imaging.FileFormats.Tiff.Enums.TiffExpectedFormat.Default));
}

The following example shows how to convert a multipage vector image to JPEG format in general way without referencing to a particular image type.

[C#]

string dir = "C:\\aspose.imaging\\net\\misc\\ImagingReleaseQATester\\Tests\\testdata\\2548";
string inputFilePath = System.IO.Path.Combine(dir, "Multipage.cdr");
string outputFilePath = System.IO.Path.Combine(dir, "Multipage.cdr.jpeg");

Aspose.Imaging.ImageOptionsBase exportOptions = new Aspose.Imaging.ImageOptions.JpegOptions();

using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(inputFilePath))
{
    exportOptions.MultiPageOptions = null;

    // Export only first two pages. In fact, only one page will be rasterized because JPEG is not a multi-page format.
    Aspose.Imaging.IMultipageImage multipageImage = image as Aspose.Imaging.IMultipageImage;
    if (multipageImage != null && (multipageImage.Pages != null && multipageImage.PageCount > 2))
    {
        exportOptions.MultiPageOptions = new Aspose.Imaging.ImageOptions.MultiPageOptions(new Aspose.Imaging.IntRange(0, 2));
    }

    if (image is Aspose.Imaging.VectorImage)
    {
        exportOptions.VectorRasterizationOptions = (Aspose.Imaging.ImageOptions.VectorRasterizationOptions)image.GetDefaultOptions(new object[] { Aspose.Imaging.Color.White, image.Width, image.Height });
        exportOptions.VectorRasterizationOptions.TextRenderingHint = Aspose.Imaging.TextRenderingHint.SingleBitPerPixel;
        exportOptions.VectorRasterizationOptions.SmoothingMode = Aspose.Imaging.SmoothingMode.None;
    }

    image.Save(outputFilePath, exportOptions);
}

See Also