CreateThumbnailHQ(Stream,Int32,Int32,Color) Method

In This Topic

Creates a High Quality thumbnail of custom size from a stream. This method tries to extract the embedded thumbnail from file metadata, if it is available. It is particularly recommended to use this method to generate thumbnail from RAW image file. The thumbnail can be fitted within a rectangle of specific dimensions having a specific background color.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function CreateThumbnailHQ( _
   ByVal Stream As Stream, _
   ByVal Width As Integer, _
   ByVal Height As Integer, _
   ByVal BackColor As Color _
) As Integer

public int CreateThumbnailHQ( 
   Stream Stream,
   int Width,
   int Height,
   Color BackColor
)

public function CreateThumbnailHQ( 
    Stream: Stream;
    Width: Integer;
    Height: Integer;
    BackColor: Color
): Integer;

public function CreateThumbnailHQ( 
   Stream : Stream,
   Width : int,
   Height : int,
   BackColor : Color
) : int;

public: int CreateThumbnailHQ( 
   Stream* Stream,
   int Width,
   int Height,
   Color BackColor
)

public:
int CreateThumbnailHQ( 
   Stream^ Stream,
   int Width,
   int Height,
   Color BackColor
)

Parameters

Stream: System.IO.Stream object storing the image data.
Width: The width of the thumbnail to create. Use 0 to keep the embedded thumbnail width, if available, otherwise uses the initial bitmap width.
Height: The height of the thumbnail to create. Use 0 to keep the embedded thumbnail height, if available, otherwise uses the initial bitmap height.
BackColor: A suitable color value can be obtained by using the ARGB() method. The background color of the thumbnail if width and height parameters are provided.

Return Value

GdPicture image identifier. The thumbnail Image. The ReleaseGdPictureImage() method must be subsequently used to release the image from the memory.

Remarks

This method requires the Image Documents component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members
Overload List
ARGB(Byte,Byte,Byte,Byte) Method