LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
ReadThumbnail(Stream,CodecsThumbnailOptions,Int32) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > ReadThumbnail Method : ReadThumbnail(Stream,CodecsThumbnailOptions,Int32) Method



stream
A System.IO.Stream containing the image data from which the thumbnail image will be created.
options
Options for creating the thumbnail image.
pageNumber
1-based index of the page from which the thumbnail image should be created.
stream
A System.IO.Stream containing the image data from which the thumbnail image will be created.
options
Options for creating the thumbnail image.
pageNumber
1-based index of the page from which the thumbnail image should be created.
Creates a thumbnail from the specified image stream.

Syntax

Visual Basic (Declaration) 
Overloads Public Function ReadThumbnail( _
   ByVal stream As Stream, _
   ByVal options As CodecsThumbnailOptions, _
   ByVal pageNumber As Integer _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim stream As Stream
Dim options As CodecsThumbnailOptions
Dim pageNumber As Integer
Dim value As RasterImage
 
value = instance.ReadThumbnail(stream, options, pageNumber)
C# 
public RasterImage ReadThumbnail( 
   Stream stream,
   CodecsThumbnailOptions options,
   int pageNumber
)
C++/CLI 
public:
RasterImage^ ReadThumbnail( 
   Stream^ stream,
   CodecsThumbnailOptions options,
   int pageNumber
)

Parameters

stream
A System.IO.Stream containing the image data from which the thumbnail image will be created.
options
Options for creating the thumbnail image.
pageNumber
1-based index of the page from which the thumbnail image should be created.

Return Value

The Leadtools.RasterImage object that this method creates.

Example

For an example, refer to ReadThumbnail.

Remarks

This method will always return a thumbnail image. Depending on the options passed, this method might read the stamp stored inside EXIF, CMP, JFIF and FlashPix files and return that. To read the file stamp only, use ReadStamp(String,Int32).

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also