ImageCollection Class

class ImageCollection : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

An image collection can hold multiple images, created from an image file.

The full set of images in the collection can be saved to a single image file, but only as a .tif image file. For any other file type (JPG, PNG, and so on), the collection can only be saved as one image object per file.

Referenced by

Page

Uses types

Document Image ImageSaveParams ImageType

Constructor & Destructor Documentation

ImageCollection()

Create an empty image collection, which can have Image objects added to it.

ImageCollection(Image image)

Parameters

image: Image: the Image object to be inserted upon creation.

Create a new image collection containing the supplied Image object.

ImageCollection(string fileName)

Parameters

fileName: string: The physical image file from which an image collection will be created.

Create from an image file. If the file is a TIFF, then an Image object will be created for each "page" of the TIFF. For all other types, only 1 Image object will be created.

ImageCollection(string fileName, Document document)

Parameters

fileName: string: The physical image file from which an image collection will be created.
document: Document: the document in which the image is intended to be used.

Create from an image file. If the file is a TIFF, then an Image object will be created for each "page" of the TIFF.

For all other types, only 1 Image object will be created.

Specifying the document optimizes data usage for this image within that document.

ImageCollection(System.IO.Stream stream)

Parameters

stream: System.IO.Stream: The Stream from which to read the ImageCollection.

Create an ImageCollection from a Stream.

This allows an ImageCollection to be read from a Stream object. The Stream must be seekable. Suitable examples are FileStream and MemoryStream. The Stream must contain image data in the TIFF Format.

ImageCollection(System.IO.Stream stream, Document document)

Parameters

stream: System.IO.Stream: The Stream from which to read the ImageCollection.
document: Document: The Document in which the ImageCollection is intended to be used.

Create an ImageCollection from a Stream.

This allows an ImageCollection to be read from a Stream object. The Stream must be seekable. Suitable examples are FileStream and MemoryStream. The Stream must contain image data in the TIFF format.

Property Documentation

int Count[get]

Gets the number of Image objects in this collection.

Member Function Documentation

void Append(Image image)

Parameters

image: Image: the Image object to be inserted.

Returns:

void

Insert the given Image object at the end of the ImageCollection.

void Dispose()

Returns:

void

Image GetImage(int index)

Parameters

index: int: the index of the Image to be retrieved.

Returns:

Image

the Image object at the specified index.

Retrieve the Image object at the specified index. Note that an exception will be generated if an index is given which is out of range.

void Save(string filename, ImageType type)

Parameters

filename: string: the file which to save the image.
type: ImageType: the image type to which to be saved. NOTE: The resolution of the first Image in the collection is used as the target Resolution for saving. (Support for saving multiple, different resolutions isn't available)

Returns:

void

Save the images in the collection to the specified file and image type. Multiple images can only be save to an image type of TIFF, otherwise an exception will be thrown.

void Save(string filename, ImageType type, ImageSaveParams saveparams)

Parameters

filename: string: the file which to save the image.
type: ImageType: the image type to which to be saved.
saveparams: ImageSaveParams: the ImageSaveParams parameters for customizing the image saving. NOTE: The resolution of the first Image in the collection is used as the target Resolution for saving. (Support for saving multiple, different resolutions isn't available)

Returns:

void

Save the images in the collection to the specified file and image type. Multiple images can only be save to an image type of TIFF, otherwise an exception will be thrown.