GrapeCity.Documents.Pdf.IPdfImage

Interface IPdfImage

Namespace

GrapeCity.Documents.Pdf

Assembly

GcDocs.Pdf.dll

Provides access to an image in a PDF document.

[Obsolete("The PdfImageBase class replaces this interface.")]
public interface IPdfImage : IImage, IDisposable

Inherited Members

IImage.ToGcBitmap(out bool)

IImage.ToGcBitmap(bool, out bool)

IImage.ToGcBitmap(GcBitmap)

IImage.Disposed

IImage.Width

IImage.Height

IImage.HorizontalResolution

IImage.VerticalResolution

IImage.Rotation

IImage.ExifProfile

System.IDisposable.Dispose()

Properties

BitsPerPixel

Gets the resolution (bits-per-pixel, BPP) of this image.

Note that in some cases a PDF image may not contain any information about its resolution, in such cases this property returns 0.

int BitsPerPixel { get; }

Property Value

int

ImageMask

Gets a value indicating whether the image is defined as a stencil mask for painting in the current color.

bool ImageMask { get; }

Property Value

bool

InlineImage

Gets a value indicating whether the image is an inline image defined directly in a content stream.

bool InlineImage { get; }

Property Value

bool

Methods

GetCacheKey()

For internal use. Returns a key uniquely identifying the object in its GcPdfDocument, can return null if object can not be uniquely identified.

object GetCacheKey()

Returns

object

The key uniquely identifying the object.

GetNativeImage(Color, Color)

Gets the GcBitmap object associated with the current IPdfImage object. Important: this GcBitmap must be disposed after use.

In a PDF images can be specified as "image mask" (see ImageMask), in that case the image data is used as a stencil mask for painting in the current color specified by currentUnmaskedColor, maskedColor specifies the color of the area excluded from filling (it is transparent in most cases).

GcBitmap GetNativeImage(Color currentUnmaskedColor, Color maskedColor)

Parameters

currentUnmaskedColor System.Drawing.Color

The current color used to fill unmasked area.

maskedColor System.Drawing.Color

The masked color specifies the color of the area that is excluded from filling (typically transparent).

Returns

GcBitmap

The GcBitmap object (must be disposed after use!).