←Select platform

GetThumbnail Method

Summary

Gets a thumbnail of a page in the document.

Syntax

C++

public RasterImage GetThumbnail( 
   DocumentReaderPage page, 
   int thumbnailWidth, 
   int thumbnailHeight 
)

  
Public Function GetThumbnail( _ 
   ByVal page As Leadtools.Forms.Documentreaders.DocumentReaderPage, _ 
   ByVal thumbnailWidth As Integer, _ 
   ByVal thumbnailHeight As Integer _ 
) As Leadtools.RasterImage

public: 
Leadtools.RasterImage^ GetThumbnail(  
   Leadtools.Forms.Documentreaders.DocumentReaderPage^ page, 
   int thumbnailWidth, 
   int thumbnailHeight 
)

Parameters

page
The requested page. Must be an existing page in the DocumentReader.Pages list and cannot be a a null reference.

thumbnailWidth
The desired maximum width of the thumbnail image in pixels. Must be greater than or equal to 32.

thumbnailHeight
The desired maximum height of the thumbnail image in pixels. Must be greater than or equal to 32.

Return Value

A new Leadtools.RasterImage that is the thumbnail image.

Remarks

If the page width and height is less than thumbnailWidth and thumbnailHeight, then this method returns a Leadtools.RasterImage in the original size.

If the page width or height is greater than thumbnailWidth and thumbnailHeight, then this method will return the biggest thumbnail it can fit into the dimensions specified by thumbnailWidth and thumbnailHeight, keeping the original image aspect ratio.

The result image will always have 24 bits per pixel and a resolution of 96 by 96 regardless of the value of DpiX and DpiY and will never return a thumbnail bigger than the original page size in pixels.

To get a render of the full size of any page in a PDF document, use GetPageImage.

Example

Public Sub DocumentImageManagerGetThumbnailExample(ByVal reader As DocumentReader, ByVal _ 
                                                   imageList As RasterImageList) 
   ' Loop through all the pages 
   For Each page As DocumentReaderPage In reader.Pages 
      Dim thumbnailImage As RasterImage = reader.ImageManager.GetThumbnail(page, 128, 128) 
      Dim item As New RasterImageListItem(thumbnailImage, 1, "Page " + page.PageNumber.ToString()) 
      imageList.Items.Add(item) 
   Next 
End Sub

public void DocumentImageManagerGetThumbnailExample(DocumentReader reader, RasterImageList imageList) 
{ 
   // Loop through all the pages 
   foreach(DocumentReaderPage page in reader.Pages) 
   { 
      RasterImage thumbnailImage = reader.ImageManager.GetThumbnail(page, 128, 128); 
      RasterImageListItem item = new RasterImageListItem(thumbnailImage, 1, "Page " + page.PageNumber.ToString()); 
      imageList.Items.Add(item); 
   } 
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DocumentImageManager Class

DocumentImageManager Members

Help Version 19.0.2017.10.27

Leadtools.Forms.DocumentReaders Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.DocumentReaders Namespace

Assemblies