PdfBitmap Class

Encapsulates a Device-Independent bitmap, which consists of the pixel data for a graphics image and its attributes. A PdfBitmap is an object used to work with images defined by pixel data.

Inheritance Hierarchy

SystemObject
Patagames.Pdf.NetPdfBitmap

Namespace: Patagames.Pdf.Net
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.111.2704

Syntax

C++

JavaScript

Copy

public class PdfBitmap : IDisposable

Public Class PdfBitmap
	Implements IDisposable

public ref class PdfBitmap : IDisposable

type PdfBitmap = 
    class
        interface IDisposable
    end

public class PdfBitmap implements IDisposable

Patagames.Pdf.Net.PdfBitmap = function();

Type.createClass(
	'Patagames.Pdf.Net.PdfBitmap',
	null,
	IDisposable);

The PdfBitmap type exposes the following members.

Constructors

	Name	Description
	PdfBitmap(IntPtr)	Initializes a new instance of the PdfBitmap class with the specified bitmap descriptor.
	PdfBitmap(Int32, Int32, BitmapFormats)	Initializes a new instance of the PdfBitmap class with the specified width, height and pixel format.
	PdfBitmap(Int32, Int32, FXDIBFormats)	Initializes a new instance of the PdfBitmap class with the specified width, height and pixel format.
	PdfBitmap(Int32, Int32, Boolean, Boolean)	Initializes a new instance of the PdfBitmap class with the specified width, height and isUseAlpha flag.
	PdfBitmap(Int32, Int32, BitmapFormats, IntPtr, Int32)	Initializes a new instance of the PdfBitmap class with the specified width, height, pixel format, and external buffer.
	PdfBitmap(Int32, Int32, FXDIBFormats, IntPtr, Int32)	Initializes a new instance of the PdfBitmap class with the specified width, height, pixel format, and external buffer.

Top

Properties

	Name	Description
	BPP	Gets the color depth, in number of bits per pixel, of this PdfBitmap.
	Buffer	Gets pointer to an array of bytes that contains the pixel data.
	Format	Gets the pixel format for this PdfBitmap.
	Handle	Gets the Pdfium.Net SDK handle that the PdfBitmap is bound to.
	HasAlpha	Gets a flag indicating whether this PdfBitmap contains an alpha channel.
	Height	Gets the height, in pixels, of this PdfBitmap.
	IsAlphaMask	Gets a flag indicating whether this PdfBitmap is a transparency mask.
	IsCmyk	Gets a flag indicating whether this PdfBitmap is a CMYK image or not.
	IsDisposed	Gets a value indicating whether the object has been disposed of. Field Value true if the control has been disposed of; otherwise, false.
	IsOpaque	Gets a flag indicating whether this PdfBitmap is opaque or not.
	Palette	Gets or sets the color palette used for this PdfBitmap.
	PaletteSize	Gets the number of elements in color palette used for this PdfBitmap.
	Pitch	Obsolete. Gets number of bytes for each scan line in the bitmap Buffer.
	Stride	Gets number of bytes for each scan line in the PdfBitmapBuffer.
	Width	Gets the width, in pixels, of this PdfBitmap.

Top

Methods

	Name	Description
	Clear	Clears the entire bitmap and fills it with the specified color.
	Clone	Clone this PdfBitmap.
	Convert	Clone and convert this PdfBitmap to specified format.
	Dispose	Releases all resources used by this PdfBitmap.
	Dispose(Boolean)	Releases all resources used by this PdfBitmap.
	FillRect(FX_RECT, FS_COLOR)	Fills the rectangular area in the PdfBitmap specified by a FX_RECT structure.
	FillRect(Int32, Int32, Int32, Int32, FS_COLOR)	Fills the rectangular area in the PdfBitmap specified by a pair of coordinates, width and height.
	FillRect(Int32, Int32, Int32, Int32, FS_COLOR, BlendTypes)	Fills the rectangular area in the PdfBitmap specified by a pair of coordinates, width and height.
	FillRectEx(Int32, Int32, Int32, Int32, Int32)	Fills the rectangular area in the PdfBitmap specified by a pair of coordinates, width and height.
	FillRectEx(Int32, Int32, Int32, Int32, Int32, BlendTypes)	Fills the rectangular area in the PdfBitmap specified by a pair of coordinates, width and height.
	Finalize	Finalize object (Overrides ObjectFinalize)
	FlipXY	Clone and flip this PdfBitmap.
	FromBitmap	Obsolete. The method has been moved to the PdfBitmapExtension class (Patagames.Pdf.Gdi.dll).
	FromFile	Obsolete. The method has been moved to the PdfBitmapExtension class (Patagames.Pdf.Gdi.dll).
	GetPaletteColorByIndex	Returns the FS_COLOR in the color palette for a certain position.
	SetPaletteEntryByIndex	Set given FS_COLOR to a certain position in the color palette of this PdfBitmap.
	StretchTo(Int32, Int32, ImageInterpolation, FX_RECT)	Clone and stretch this PdfBitmap.
	StretchTo(Int32, Int32, Int32, FX_RECT)	Obsolete. Clone and stretch this PdfBitmap.
	SwapXY	Clone and swap this PdfBitmap.

Top

Events

	Name	Description
	_disposeBitmap	Obsolete. For internal use only. Will be removed in the future release.

Top

Fields

	Name	Description
	_forceAlphaChannel	Obsolete. For internal use only. Will be removed in the future release.
	_gdiBitmap	Obsolete. For internal use only. Will be removed in the future release.

Top

Extension Methods

	Name	Description
	FillRect	Fill a rectangle area in an PdfBitmap specified by a Rectangle structure. (Defined by PdfBitmapExtension)
	GetImage	Gets the image that represents the PdfBitmap (Defined by PdfBitmapExtension)

Top

Reference

Patagames.Pdf.Net Namespace

PdfBitmap Class

Field Value

Reference