Gets this page as a raster image at the specified resolution.
Public Function GetImage() As RasterImage
public RasterImage getImage(int resolution)
Resolution to use in dots per inch. If this value is 0, then the current page Resolution value is used.
This page as a RasterImage object.
GetImage and GetImage(resolution) are used to get a raster image representation of this page. All document types support this method and it will always return a value object.
If this document type supports loading raster images at any resolution (the value of DocumentImages.IsResolutionsSupported is true), then this method will use the resolution parameter instead of the Resolution property when loading the image.
If this document type does not support loading raster images at any resolution (the value of DocumentImages.IsResolutionsSupported is false), then resolution is ignored and the original page Resolution value is used.
This method works as follows (the "item" is a raster image with the specified resolution):
If an item was found in the cache, it is returned right away. This is available if the document was created using the cache system. and LEADDocument.CacheOptions contains DocumentCacheOptions.PageImage.
If this is not an original page in the source document file (the value of OriginalPageNumber is not 1), then a new RasterImage object is created based on the page size and resolution and the default values in DocumentImages.
If this document uses the cache system (LEADDocument.HasCache is true), then the RasterImage object is saved to the cache before it is returned. Next time this method is called, the image will be returned from the cache directly without loading it from the file or creating a new instance.
Note that if SetImage has been previously called with a null object for the image parameter, then this method will return null as well.
The LEADTOOLS Document Viewer uses this method to obtain the raster image for the page when the view mode is "Raster Image".
The LEADTOOLS Document Converter uses this method to obtain the raster image for the page when converting using OCR or when adding the overlay image of a page if needed.
Refer to Loading Using LEADTOOLS Document Library for more information.
For an example, refer to DocumentPage.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries