CreateThumbnail Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public RasterImage CreateThumbnail( 
   int thumbnailWidth,
   int thumbnailHeight,
   int bitsPerPixel,
   RasterViewPerspective viewPerspective,
   RasterSizeFlags sizeFlags
)

'Declaration
 
Public Function CreateThumbnail( _
   ByVal thumbnailWidth As Integer, _
   ByVal thumbnailHeight As Integer, _
   ByVal bitsPerPixel As Integer, _
   ByVal viewPerspective As RasterViewPerspective, _
   ByVal sizeFlags As RasterSizeFlags _
) As RasterImage

'Usage
 
Dim instance As RasterImage
Dim thumbnailWidth As Integer
Dim thumbnailHeight As Integer
Dim bitsPerPixel As Integer
Dim viewPerspective As RasterViewPerspective
Dim sizeFlags As RasterSizeFlags
Dim value As RasterImage
 
value = instance.CreateThumbnail(thumbnailWidth, thumbnailHeight, bitsPerPixel, viewPerspective, sizeFlags)

public RasterImage CreateThumbnail( 
   int thumbnailWidth,
   int thumbnailHeight,
   int bitsPerPixel,
   RasterViewPerspective viewPerspective,
   RasterSizeFlags sizeFlags
)

 function Leadtools.RasterImage.CreateThumbnail( 
   thumbnailWidth ,
   thumbnailHeight ,
   bitsPerPixel ,
   viewPerspective ,
   sizeFlags 
)

public:
RasterImage^ CreateThumbnail( 
   int thumbnailWidth,
   int thumbnailHeight,
   int bitsPerPixel,
   RasterViewPerspective viewPerspective,
   RasterSizeFlags sizeFlags
)

Parameters

thumbnailWidth: The desired maximum width of the thumbnail image in pixels.
thumbnailHeight: The desired maximum height of the thumbnail image in pixels.
bitsPerPixel: The desired bits per pixel.
viewPerspective: The desired view perspective.
sizeFlags: Flags that control the resize operation.

Return Value

A new RasterImage that is the thumbnail image.

If the image width and height is less than thumbnailWidth and thumbnailHeight, then this method returns a copy of the image in the original size.

If the image 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 thumbailWidth and thumbnailHeight, keeping the original image aspect ratio.

The result image will always have a resolution of 96 by 96 regardless of the resolution this RasterImage and will never return a thumbnail bigger than the original image.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub CreateThumbnailExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "image1.cmp")

      ' Load the image
      Dim srcImage As RasterImage = codecs.Load(srcFileName)

      ' Use the CreateTumbnail method to create a thumbnail of this image
      Dim thumbnail As RasterImage = srcImage.CreateThumbnail(200, 200, 24, RasterViewPerspective.TopLeft, RasterSizeFlags.Bicubic)
      Debug.Assert(thumbnail.PageCount = 1)

      ' Clean up
      thumbnail.Dispose()
      srcImage.Dispose()
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void CreateThumbnailExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "image1.cmp");

      // Load the image
      RasterImage srcImage = codecs.Load(srcFileName);

      // Use the CreateTumbnail method to create a thumbnail of this image
      RasterImage thumbnail = srcImage.CreateThumbnail(200, 200, 24, RasterViewPerspective.TopLeft, RasterSizeFlags.Bicubic);
      Debug.Assert(thumbnail.PageCount == 1);

      // Clean up
      thumbnail.Dispose();
      srcImage.Dispose();
      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

RasterImageExamples.prototype.CreateThumbnailExample = function ()
{
   Tools.SetLicense();
   var codecs = new Leadtools.Codecs.RasterCodecs();

   var srcFileName = "Assets\\Image1.cmp";

   // Load the image
   return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function ( loadFile ) {
      return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile));})
   .then ( function (srcImage ){

      // Use the CreateTumbnail method to create a thumbnail of this image
      var thumbnail = srcImage.createThumbnail(200, 200, 24, Leadtools.RasterViewPerspective.topLeft, Leadtools.RasterSizeFlags.bicubic);
      console.assert(thumbnail.pageCount == 1, "thumbnail.pageCount == 1");

      // Clean up
      thumbnail.close();
      srcImage.close();
      codecs.close();
   });
}

[TestMethod]
public async Task CreateThumbnailExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\Image1.cmp";

   // Load the image
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage srcImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Use the CreateTumbnail method to create a thumbnail of this image
   RasterImage thumbnail = srcImage.CreateThumbnail(200, 200, 24, RasterViewPerspective.TopLeft, RasterSizeFlags.Bicubic);
   Assert.IsTrue(thumbnail.PageCount == 1);

   // Clean up
   thumbnail.Dispose();
   srcImage.Dispose();
   codecs.Dispose();
}

public void CreateThumbnailExample(RasterImage srcImage)
{
   // Use the CreateTumbnail method to create a thumbnail of this image
   RasterImage thumbnail = srcImage.CreateThumbnail(200, 200, 24, RasterViewPerspective.TopLeft, RasterSizeFlags.Bicubic);
   Debug.Assert(thumbnail.PageCount == 1);
   // Clean up
   thumbnail.Dispose();
   srcImage.Dispose();
}

Public Sub CreateThumbnailExample(ByVal srcImage As RasterImage)
   ' Use the CreateTumbnail method to create a thumbnail of this image
   Dim thumbnail As RasterImage = srcImage.CreateThumbnail(200, 200, 24, RasterViewPerspective.TopLeft, RasterSizeFlags.Bicubic)
   Debug.Assert(thumbnail.PageCount = 1)
   ' Clean up
   thumbnail.Dispose()
   srcImage.Dispose()
End Sub

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

RasterImage Class
RasterImage Members