PDFImage¶

Namespace: O2S.Components.PDF4NET.Graphics

Defines a PDF image.

public class PDFImage

Inheritance Object → PDFImage

Properties¶

AlternateImages¶

Gets or sets the alternate images.

public PDFAlternateImageCollection AlternateImages { get; set; }

Property Value

PDFAlternateImageCollection
A collection of alternate images to be used instead of this image.

BitsPerComponent¶

Gets or sets the bits per component.

public int BitsPerComponent { get; set; }

Property Value

Int32
The number of bits used to represent each color component.

Remarks

Valid values are 1, 2, 4, 8, and (in PDF 1.5) 16

ColorSpace¶

Gets or sets the color space.

public PDFColorSpace ColorSpace { get; set; }

Property Value

PDFColorSpace
The color space in which image samples are specified.

CosDictionary¶

Gets the COS dictionary asssociated with this object.

public PDFCosDictionary CosDictionary { get; }

Property Value

PDFCosDictionary
The internal COS dictionary.

Remarks

Incorrect manipulation of the information in the COS dictionary can lead to invalid PDF files.

Height¶

Gets the image height.

public int Height { get; set; }

Property Value

Int32
The image height in pixels.

Interpolate¶

Gets or sets a value indicating whether image interpolation is to be performed.

public bool Interpolate { get; set; }

Property Value

Boolean
If true, the image is interpolated when displayed on the output device.

LogicalHeight¶

Gets the logical image height.

public int LogicalHeight { get; }

Property Value

Int32
The image height in pixels depending on image orientation.

LogicalWidth¶

Gets the logical image width.

public int LogicalWidth { get; }

Property Value

Int32
The image width in pixels depending on image orientation.

Mask¶

Gets or sets the image mask.

public PDFImageMask Mask { get; set; }

Property Value

PDFImageMask
An image mask to be applied to this image.

Measure¶

Gets or sets the image measure.

public PDFMeasure Measure { get; set; }

Property Value

PDFMeasure
A PDFMeasure descendant object that specifies the scale and units which shall apply to the image.

Orientation¶

Gets or sets the image orientation.

public PDFImageOrientation Orientation { get; internal set; }

Property Value

PDFImageOrientation

PointData¶

Gets or sets the point data.

public PDFPointData PointData { get; set; }

Property Value

PDFPointData
A PDFPointData object that specifies the extended geospatial data that shall apply to the image.

StructureElement¶

Gets or sets the structure element that represents this image.

public PDFStructureElement StructureElement { get; set; }

Property Value

PDFStructureElement
A PDFStructureElement object representing this image.

Width¶

Gets the image width.

public int Width { get; set; }

Property Value

Int32
The image width in pixels.

Methods¶

ApplyFilter(PDFFilterType)¶

Applies the specified PDF compression filter to image data.

public void ApplyFilter(PDFFilterType pdfFilter)

Parameters

pdfFilter PDFFilterType
Type of compression to apply

Remarks

The image data is already compressed so calling this method will compress it again and this might cause an increase in final size.
This method can be called multiple times to chain multiple PDF filters.

Load(Stream)¶

Loads an image from the given stream.

public static PDFImage Load(Stream stream)

Parameters

stream Stream
Stream that contains the image.

Returns

PDFImage
A specific PDFImage object.

Remarks

Supported image types are JPEG, PNG, GIF, TIFF, JPEG2000

Load(String)¶

Loads an image from the given file.

public static PDFImage Load(string fileName)

Parameters

fileName String
Path to image file.

Returns

PDFImage
A specific PDFImage object.

Remarks

Supported image types are JPEG, PNG, GIF, TIFF, JPEG2000