LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
SetRasterImage Method
See Also 
Leadtools.Forms.Ocr Namespace > IOcrPage Interface : SetRasterImage Method



image
A Leadtools.RasterImage object that contains the image data that will be copied into this IOcrPage.

The SetRasterImage Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

image
A Leadtools.RasterImage object that contains the image data that will be copied into this IOcrPage.
Updates the page image data from a Leadtools.RasterImage object.

Syntax

Visual Basic (Declaration) 
Sub SetRasterImage( _
   ByVal image As RasterImage _
) 
Visual Basic (Usage)Copy Code
Dim instance As IOcrPage
Dim image As RasterImage
 
instance.SetRasterImage(image)
C# 
void SetRasterImage( 
   RasterImage image
)
C++/CLI 
void SetRasterImage( 
   RasterImage^ image
) 

Parameters

image
A Leadtools.RasterImage object that contains the image data that will be copied into this IOcrPage.

Example

For an example, refer to IOcrPage.

Remarks

Once you add a page to an OCR document, the image data used to create the page is copied and stored inside the engine even if the original object used to create the page was a Leadtools.RasterImage object. To get a Leadtools.RasterImage that represents this page, use GetRasterImage.

The Leadtools.RasterImage object that the GetRasterImage method returns contains a copy of the page image data. Any modifications you make to the Leadtools.RasterImage object will not affect the page. To update the page image data, you must call SetRasterImage. Since the Leadtools.RasterImage object is a copy, you must dispose it by calling its RasterImage.Dispose method once you are done using it.

Once you obtain a Leadtools.RasterImage object for this page, you can use it with other parts of LEADTOOLS, for example, you can set it in the Leadtools.WinForms.RasterImageViewer or Leadtools.WinForms.RasterPictureBox controls for viewing inside your Windows Forms-based application. You can also perform your own image processing on the page as follows:

            // Flip the 2nd page added to the OCR document
            // Get the page (index is zero-based)
            IOcrPage page = ocrDocument.Pages[1];
            // Get a RasterImage object that represents this page
            Leadtools.RasterImage image = page.GetRasterImage();
            // Flip it vertically
            Leadtools.ImageProcessing.FlipCommand flip = new Leadtools.ImageProcessing.FlipCommand();
            flip.Horizontal = false;
            flip.Run(image);
            // Set it back into the page
            page.SetRasterImage(image);
            // Dispose the image
            image.Dispose();
            

You can also get a Leadtools.RasterImage object representation of a page with the IOcrPageCollection.ExportPage method.

The Leadtools.RasterImage object returned from the GetRasterImage method will contain one page only. To get a multi-page Leadtools.RasterImage object containing the image data of all or a specific range of the pages added to the OCR document, you can either create a Leadtools.RasterImage from the first then loop through the pages of the document and add the returned Leadtools.RasterImage objects to the first object with the RasterImage.AddPage method. Or you can use the IOcrPageCollection.ExportPages methods.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

SetRasterImage requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features