←Select platform

GetImage Method

Summary

Gets a raster image of a page.

Syntax
C#
VB
C++
Public Function GetImage( 
   ByVal sourceRect As LeadRect, 
   ByVal imageSize As LeadSize, 
   ByVal cache As Boolean 
) As RasterImage 
public:  
   RasterImage^ GetImage( 
      LeadRect^ sourceRect, 
      LeadSize^ imageSize, 
      bool cache 
   ) 

Parameters

sourceRect

The area, in pixels, of the page to render.

imageSize

The output size, in pixels, of the returned image.

cache

If true, the returned image will be stored for reuse. If the other parameters match the stored image, then the stored image will be returned.

If false, the stored image will not be saved or reused.

Return Value

A Leadtools.RasterImage that represents the rendering of the requested page.

Remarks

sourceRect is a top-left rectangle that must be within the bounds of [0, 0] to Size.Width, Size.Height.

If cache is true, then the returned image should not be disposed or stored. It can be internally disposed in the next call to this method. If cache is false, then the returned image may be saved and/or disposed.

Call the ClearCache method to dispose the stored image, if needed. However, it will be automatically disposed when the IPageRasterizer is disposed.

Requirements
Target Platforms
Help Version 21.0.2021.3.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools Assembly