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

GrapeCity.Documents.Pdf.Graphics.Images.PdfImageBase

PdfImageBase Class

Base abstract class for classes describing images in a PDF file, including inline PDF images defined in the PDF content stream using BI and EI operators.

Inheritance
object
PdfWrapperBase
PdfWrapper<IPdfDict>
PdfDictWrapper
PdfImageBase
PdfImageObjectBase
PdfInlineImage
Implements
Namespace: GrapeCity.Documents.Pdf.Graphics.Images
Assembly: DS.Documents.Pdf.dll
Syntax
public abstract class PdfImageBase : PdfDictWrapper, IPdfDict, IPdfImage, IImage, IDisposable
Public MustInherit Class PdfImageBase
    Inherits PdfDictWrapper
    Implements IPdfDict, IPdfImage, IImage, IDisposable

Properties

Name Description
BitsPerPixel

Gets the number of bits-per-pixel (BPP) for this image.
Height

Gets the height of the image in pixels.
HorizontalResolution

Gets the horizontal resolution of the image. If this property returns a value that is less or equal than 0, then the horizontal resolution is not specified for an image.
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 PDF content stream.
VerticalResolution

Gets the vertical resolution of the image. If this property returns a value that is less or equal than 0, then the vertical resolution is not specified for an image.
Width

Gets the width of the image in pixels.

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.
GetImageStreamInfo()

Returns the GrapeCity.Documents.Pdf.Spec.PdfStreamObject containing unparsed image data and information about the PDF filter and decode parameters.

Note that not all derived classes support this method (for example, PdfImageHandler).
GetNativeImage(Color, Color)

Creates and returns a GcBitmap object representing the current PdfImageBase object.

IMPORTANT NOTE: the returned bitmap must be disposed after use.

An image in a PDF can be specified as an "image mask" (see ImageMask), in which 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).

ToGcBitmap(out bool)

Retrieves the underlying GcBitmap object, or creates a new GcBitmap that contains the image data.

Note that you should dispose the returned GcBitmap if disposeAfterUse is true.

Extension Methods