GetThumbnailsGrid Method

public RasterImage GetThumbnailsGrid( 
   int firstPageNumber,
   int lastPageNumber,
   int maximumGridWidth
)

'Declaration
 

Public Function GetThumbnailsGrid( _
   ByVal firstPageNumber As Integer, _
   ByVal lastPageNumber As Integer, _
   ByVal maximumGridWidth As Integer _
) As RasterImage

'Usage
 

Dim instance As DocumentImages
Dim firstPageNumber As Integer
Dim lastPageNumber As Integer
Dim maximumGridWidth As Integer
Dim value As RasterImage
 
value = instance.GetThumbnailsGrid(firstPageNumber, lastPageNumber, maximumGridWidth)

public RasterImage getThumbnailsGrid(int firstPageNumber, int lastPageNumber, int maximumGridWidth)
            

public:
RasterImage^ GetThumbnailsGrid( 
   int firstPageNumber,
   int lastPageNumber,
   int maximumGridWidth
) 

Parameters

firstPageNumber

1-based number of the first page number in the document.

lastPageNumber

1-based number of the last page number in the document.

maximumGridWidth

The maximum width of the grid in pixels.

Return Value

GetThumbnailsGrid can be used to obtain the thumbnails of one or more pages in a single call. The result image will contain the images in a grid layout. The grid with will be less than or equal to maximumGridWidth in pixels and the height is determined automatically from the number of images to obtain.

The LEADTOOLS Document Viewer can use GetThumbnailsGrid to speed up obtaining the thumbnails of the pages in the document instead of iterating each page and calling DocumentPage.GetThumbnailImage.

Note that this method does not update the cache.

Target Platforms

Reference

DocumentImages Class
DocumentImages Members