Leadtools.Forms.Ocr Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
CreateThumbnail Method
See Also 
Leadtools.Forms.Ocr Namespace > IOcrPage Interface : CreateThumbnail Method



thumbnailWidth
The desired maximum width of the thumbnail image in pixels.
thumbnailHeight
The desired maximum height of the thumbnail image in pixels.
thumbnailWidth
The desired maximum width of the thumbnail image in pixels.
thumbnailHeight
The desired maximum height of the thumbnail image in pixels.
Creates a thumbnail image of this IOcrPage.

Syntax

Visual Basic (Declaration) 
Overridable Function CreateThumbnail( _
   ByVal thumbnailWidth As Integer, _
   ByVal thumbnailHeight As Integer _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As IOcrPage
Dim thumbnailWidth As Integer
Dim thumbnailHeight As Integer
Dim value As RasterImage
 
value = instance.CreateThumbnail(thumbnailWidth, thumbnailHeight)
C# 
virtual RasterImage CreateThumbnail( 
   int thumbnailWidth,
   int thumbnailHeight
)
C++/CLI 
virtual RasterImage CreateThumbnail( 
   int thumbnailWidth,
   int thumbnailHeight
) 

Parameters

thumbnailWidth
The desired maximum width of the thumbnail image in pixels.
thumbnailHeight
The desired maximum height of the thumbnail image in pixels.

Return Value

A RasterImage object that contains a thumbnail of this IOcrPage.

Example

For an example, refer to IOcrPage.

Remarks

The thumbnail image returned from this image always contain the correct aspect ratio. The width and height of the thumbnail is guaranteed to be at least thumbnailWidth by thumbnailHeight in size but never exceeding that. The only time you get a thumbnail that is exactly thumbnailWidth by thumbnailHeight pixels is when this IOcrPage is a perfect square.

The thumbnail image returned from this method will always contain 24 bits per pixel for best possible quality.

One use of the thumbnail image of a page is if your application is a Windows Forms-based application containing the RasterImageList control. You can use CreateThumbnail to obtain thumbnails of the pages in the engine and use them as items to the RasterImageList. For an example, refer to the C# or VB.NET Main OCR Demo that ships with LEADTOOLS.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

CreateThumbnail requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features