Image Class

The Image class provides common methods for working with PDF images.

Inheritance Hierarchy

SystemObject
pdftron.PDFImage

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Image : IClosable

Public NotInheritable Class Image
	Implements IClosable

public ref class Image sealed : IClosable

pdftron.PDF.Image = function();

Type.createClass(
	'pdftron.PDF.Image',
	null,
	Windows.Foundation.IClosable);

The Image type exposes the following members.

Constructors

	Name	Description
	Image	Creates the soft mask.

Top

Methods

	Name	Description
	Close
	Create(SDFDoc, Byte)	Create and embed an Image from an array of bytes representing the image.
	Create(SDFDoc, String)	Create and embed an Image from an external file taking into account specified compression hints.
	Create(SDFDoc, Byte, Obj)	Create and embed an Image from an array of bytes representing the image.
	Create(SDFDoc, String, Obj)	Create and embed an Image from an external file taking into account specified compression hints.
	Create(SDFDoc, Byte, Int32, Int32, Int32, ColorSpace)	Creates the.
	Create(SDFDoc, FilterReader, Int32, Int32, Int32, ColorSpace, ImageInputFilter)	Embed the raw image data taking into account specified compression hints.
	Create(SDFDoc, FilterReader, Int32, Int32, Int32, ColorSpace, Obj)	Creates the.
	Create(SDFDoc, Byte, Int32, Int32, Int32, ColorSpace, ImageInputFilter)	Directly embed the image that is already compressed using the Image::InputFilter format. The function can be used to pass-through pre-compressed image data.
	Create(SDFDoc, Byte, Int32, Int32, Int32, ColorSpace, Obj)	Creates the.
	CreateAsync(SDFDoc, String)	Create and embed an Image from an external file taking into account specified compression hints.
	CreateAsync(SDFDoc, IRandomAccessStream)	Create and embed an Image from a random access stream representing the image.
	CreateAsync(SDFDoc, String, Obj)	Create and embed an Image from an external file taking into account specified compression hints.
	CreateAsync(SDFDoc, IRandomAccessStream, Obj)	Create and embed an Image from a random access stream representing the image.
	CreateImageMask(SDFDoc, FilterReader, Int32, Int32)	Create and embed an ImageMask.
	CreateImageMask(SDFDoc, Byte, Int32, Int32)	Create and embed an ImageMask. Embed the raw image data taking into account specified compression hints. The ImageMask can be used as a stencil mask for painting in the current color or as an explicit mask specifying which areas of the image to paint and which to mask out. One of the most important uses of stencil masking is for painting Character glyphs represented as bitmaps.
	CreateImageMask(SDFDoc, FilterReader, Int32, Int32, Obj)	Creates the image mask.
	CreateImageMask(SDFDoc, Byte, Int32, Int32, Obj)	Creates the image mask.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExportAsPng	Saves this image to a file as PNG format.
	ExportAsPngAsync	Saves this image to a file as PNG format.
	ExportAsTiff	Saves this image to a file as TIFF format.
	ExportAsTiffAsync	Saves this image to a file as TIFF format.
	GetBitsPerComponent	Gets the bits per component.
	GetComponentNum	Gets the component number.
	GetDecodeArray	Gets the decode Array.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetImageColorSpace	Gets the bitmap.
	GetImageDataSize	Gets the image data.
	GetImageHeight	Gets the image height.
	GetImageRenderingIntent	Gets the image rendering intent.
	GetImageWidth	Gets the image width.
	GetMask	Gets the mask.
	GetSDFObj	Gets the SDFObj.
	GetSoftMask	Gets the soft mask.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsImageInterpolate	Checks if is image interpolate.
	IsImageMask	Checks if is image mask.
	IsValid	Checks if is valid.
	Set	Sets value to the given image value
	SetMask(Image)	Set an Explicit Image Mask.
	SetMask(Obj)	Set a Color Key Mask.
	SetSoftMask	Set a Soft Mask.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The Element class contains a similar interface used to access image data. To create the Image object from an image Element, pass the Element's SDF/Cos dictionary to Image constructor (e.g. Image image = new Image(element->GetXObject())).

It is recommended to invoke synchronous methods in a worker thread.

Reference

pdftron.PDF Namespace