CreateThumbnailHQ(String,Int32,Int32,Color) Method

In This Topic

Creates a High Quality thumbnail of custom size from a file. 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 FilePath As String, _
   ByVal Width As Integer, _
   ByVal Height As Integer, _
   ByVal BackColor As Color _
) As Integer

public int CreateThumbnailHQ( 
   string FilePath,
   int Width,
   int Height,
   Color BackColor
)

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

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

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

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

Parameters

FilePath: The path of the file to open. Can be an empty string. If empty, prompts the user to select a file. You can subsequently use the GetLastPath() method to retrieve the path of the selected file.
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.

Example

Generating a high quality custom size thumbnail from a selected image file with a background color.

using (GdPictureImaging gdpictureImaging = new GdPictureImaging())
{
    // Create a thumbnail with a black background that is 100 pixels width and 200 pixels height.
    // An empty string allows the control to prompt for selecting an input file.
    int thumbnailID = gdpictureImaging.CreateThumbnailHQ("", 100, 200, gdpictureImaging.ARGB(255, 0, 0, 0));
    gdpictureImaging.SaveAsPNG(thumbnailID, "thumbnail.png");
 
    // Release used resources.
    gdpictureImaging.ReleaseGdPictureImage(thumbnailID);
}

Reference

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