Table of Contents

Class PdfImage

Namespace
BitMiracle.Docotic.Pdf
Assembly
BitMiracle.Docotic.Pdf.dll

Class for an image that is suitable for use with PDF document.

public sealed class PdfImage
Inheritance
PdfImage
Inherited Members

Remarks

The Images section contains code examples for popular operations with images.

Read the Sign a PDF document with a handwritten signature image section for an example of adding images to PDF documents.

The Docotic.Pdf Library Documentation page contains links to articles, guides, and sample code.

Properties

BitsPerComponent

Gets the number of bits used to describe each color component of this PdfImage.

ComponentCount

Gets the number of color components in this PdfImage.

Compression

Gets the compression scheme of this PdfImage.

DpiX

Gets the horizontal resolution, in pixels per inch, of this PdfImage.

DpiY

Gets the vertical resolution, in pixels per inch, of this PdfImage.

HasMask

Gets a value indicating whether this PdfImage has associated mask color, a stencil mask image or a soft mask.

Height

Gets the height, in pixels, of this PdfImage.

Id

Gets the identifier of this image in this PdfDocument.

InterpolateWhenDrawn

Gets or sets a value indicating whether an image interpolation algorithm should be applied during rendering of this image.

IsInline

Gets a value indicating whether this PdfImage is an inline image.

IsMask

Gets a value indicating whether this PdfImage is a stencil mask image.

Mask

Gets or sets the mask image for this PdfImage.

Stream

Gets the low-level stream object for this image object.

UseMaskInverted

Gets or sets a value indicating whether the bits of the mask image of this PdfImage should be inverted.

Width

Gets the width, in pixels, of this PdfImage.

Methods

ConvertToMask()

Converts this PdfImage into a mask image.

Equals(object?)

Determines whether the specified object is equal to the current PdfImage object.

GetHashCode()

Serves as a hash function for a PdfImage instance.

MakeTransparent(PdfColor)

Makes the specified color transparent for this PdfImage.

RecompressWithFlate()

Recompresses image data using zlib/deflate compression method.

RecompressWithFlate(int)

Recompresses image data using zlib/deflate compression method and specified compression quality.

RecompressWithGroup3Fax()

Recompresses image data using Group 3 CCITT facsimile (fax) encoding.

RecompressWithGroup3Fax(int)

Recompresses image data using Group 3 CCITT facsimile (fax) encoding and specified threshold level.

RecompressWithGroup4Fax()

Recompresses image data using Group 4 CCITT facsimile (fax) encoding.

RecompressWithGroup4Fax(int)

Recompresses image data using Group 4 CCITT facsimile (fax) encoding and specified threshold level.

RecompressWithJpeg()

Recompresses image data using JPEG baseline format.

RecompressWithJpeg(int)

Recompresses image data using JPEG baseline format and specified compression quality.

RecompressWithJpeg2000()

Recompresses image data using JPEG 2000 format.

RecompressWithJpeg2000(int)

Recompresses image data using JPEG 2000 format and specified compression ratio.

ReplaceWith(byte[])

Replaces image with the image bytes.

ReplaceWith(Stream)

Replaces image with the image in the stream.

ReplaceWith(string)

Replaces image with the image in the file.

ResizeTo(int, int, PdfImageCompression)

Resizes image to specified width and height and compresses it using specified compression scheme.

ResizeTo(int, int, PdfImageCompression, int)

Resizes image to specified width and height and compresses it using specified compression scheme.

Save(Stream)

Saves the image to the specified stream.

Save(string)

Saves the image to the file with specified name.

Scale(double, PdfImageCompression)

Scales image using specified scale factor and compresses it using specified compression scheme.

Scale(double, PdfImageCompression, int)

Scales image using specified scale factor and compresses it using specified compression scheme.

Uncompress()

Uncompresses image data.

Operators

operator ==(PdfImage, PdfImage)

Determines whether the two specified objects are equal to each other.

operator !=(PdfImage, PdfImage)

Determines whether the two specified objects are not equal to each other.