GetThumbnailImage Method

Summary

Gets a thumbnail representation of this page.

Syntax

C++

Java

public RasterImage GetThumbnailImage()

Public Function GetThumbnailImage() As RasterImage

public:  
   RasterImage^ GetThumbnailImage()

public RasterImage getThumbnailImage()

Return Value

The thumbnail representation of this page.

Remarks

This method uses the value set in DocumentImages.ThumbnailPixelSize to determine the size of the thumbnail image. The returned image data will have 24 bits per pixel.

This method works as follows (the "item" is a thumbnail image with the specified size):

If an item was found in the cache, it is returned right away. This is available if the document was created using the cache system. and LEADDocument.CacheOptions contains DocumentCacheOptions.PageThumbnailImage.
GetImage is used to create the thumbnail image.
If this document uses the cache system (LEADDocument.HasCache is true), then the RasterImage object is saved to the cache before it is returned. Next time this method is called, the image will be returned from the cache directly without loading it from the file or creating a new instance.

The returned RasterImage object is not used by this LEADDocument, the user is responsible for deleting it using RasterImage.Dispose after it has been used.

DocumentImages.GetThumbnailsGrid can be used to return the thumbnails of more than one page using a single call.

The LEADTOOLS Document Viewer uses DocumentPage.GetThumbnailImage and DocumentImages.GetThumbnailsGrid for generating the thumbnails list of a document.

Refer to Loading Using LEADTOOLS Document Library for more information.

Requirements

Target Platforms