PDFRawImage¶

Namespace: O2S.Components.PDF4NET.Graphics

Defines a RAW image.

public class PDFRawImage : PDFImage

Inheritance Object → PDFImage → PDFRawImage

Constructors¶

PDFRawImage(PDFCosStream)¶

Initializes a new PDFRawImage object with the specified COS stream.

public PDFRawImage(PDFCosStream cosImageStream)

Parameters

cosImageStream PDFCosStream
A COS stream that represents an image object.

Remarks

The COS stream representing the image is assumed to be valid. Creating an image from an invalid COS stream and drawing the image on a PDF page can lead to undefined results when the PDF file is displayed.

PDFRawImage(String)¶

Initializes a new PDFRawImage object.

public PDFRawImage(string fileName)

Parameters

fileName String
Path to RAW image.

PDFRawImage(String, Boolean)¶

Initializes a new PDFRawImage object.

public PDFRawImage(string fileName, bool compress)

Parameters

fileName String
Path to RAW image.

compress Boolean
Flag to indicate whether the raw image data should be compressed before writing it in the PDF file.

PDFRawImage(Stream)¶

Initializes a new PDFRawImage object.

public PDFRawImage(Stream stream)

Parameters

stream Stream
Raw image stream.

PDFRawImage(Stream, Boolean)¶

Initializes a new PDFRawImage object.

public PDFRawImage(Stream stream, bool compress)

Parameters

stream Stream
Raw image stream.

compress Boolean
Flag to indicate whether the raw image data should be compressed before writing it in the PDF file.

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.