[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

GrapeCity.Documents.Pdf.IPdfImage

IPdfImage Interface

Provides access to an image in a PDF document.

Namespace: GrapeCity.Documents.Pdf
Assembly: DS.Documents.Pdf.dll
Syntax
[Obsolete("The PdfImageBase class replaces this interface.")]
public interface IPdfImage : IImage, IDisposable
<Obsolete("The PdfImageBase class replaces this interface.")>
Public Interface IPdfImage
    Inherits IImage, IDisposable

Properties

Name Description
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.

ImageMask

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

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

Methods

Name Description
GetCacheKey()

For internal use. Returns a key uniquely identifying the object in its GcPdfDocument, can return null if object can not be uniquely identified.
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).