LEADTOOLS Forms (Leadtools.Forms.Recognition assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
PageRecognitionOptions Class
See Also  Members  
Leadtools.Forms.Recognition Namespace : PageRecognitionOptions Class



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

Specifies the different options for a Form page when it is added to a form using FormRecognitionEngine.AddFormPage for Forms or FormRecognitionEngine.AddMasterFormPage for Master Forms.

Object Model

PageRecognitionOptions Class

Syntax

Visual Basic (Declaration) 
<SerializableAttribute()>
Public Class PageRecognitionOptions 
Visual Basic (Usage)Copy Code
Dim instance As PageRecognitionOptions
C# 
[SerializableAttribute()]
public class PageRecognitionOptions 
C++/CLI 
[SerializableAttribute()]
public ref class PageRecognitionOptions 

Example

This example adds a page image to an attributes.

Visual BasicCopy Code
'''This method add a page to the form attributes object.
Public Sub AddPageToFormAttributes(ByVal page As RasterImage, ByVal attributes As FormRecognitionAttributes, ByVal engine As FormRecognitionEngine)
   Dim pageOptions As PageRecognitionOptions = New PageRecognitionOptions()
   pageOptions.AutoCleanUp = True
   pageOptions.UpdateImage = True
   pageOptions.IncludeRectangles.Add(New LogicalRectangle(0, 0, page.Width, page.Height, LogicalUnit.Pixel))
   pageOptions.ExcludeRectangles.Add(New LogicalRectangle(page.Width * 6 / 10, page.Height * 4 / 10, page.Width * 3 / 10, page.Height * 2 / 10, LogicalUnit.Pixel))
   pageOptions.RegionOfInterestRectangles.Add(New LogicalRectangle(page.Width * 1 / 10, page.Height * 1 / 10, page.Width * 2 / 10, page.Height * 2 / 10, LogicalUnit.Pixel))
   Dim properties As FormRecognitionProperties = engine.GetFormProperties(attributes)
   If properties.IsMaster Then
      engine.OpenMasterForm(attributes)
      engine.AddMasterFormPage(attributes, page, pageOptions)
      engine.CloseMasterForm(attributes)
   Else
      engine.OpenForm(attributes)
      engine.AddFormPage(attributes, page, pageOptions)
      engine.CloseForm(attributes)
   End If
End Sub
C#Copy Code
///This method add a page to the form attributes.
public void AddPageToFormAttributes(RasterImage page, FormRecognitionAttributes attributes, FormRecognitionEngine engine)
{
   PageRecognitionOptions pageOptions = new PageRecognitionOptions();
   pageOptions.AutoCleanUp = true;
   pageOptions.UpdateImage = true;
   pageOptions.IncludeRectangles.Add(new LogicalRectangle(0, 0, page.Width, page.Height, LogicalUnit.Pixel));
   pageOptions.ExcludeRectangles.Add(new LogicalRectangle(page.Width * 6 / 10, page.Height * 4 / 10, page.Width * 3 / 10, page.Height * 2 / 10, LogicalUnit.Pixel));
   pageOptions.RegionOfInterestRectangles.Add(new LogicalRectangle(page.Width * 1 / 10, page.Height * 1 / 10, page.Width * 2 / 10, page.Height * 2 / 10, LogicalUnit.Pixel));
   FormRecognitionProperties properties = engine.GetFormProperties(attributes);
   if(properties.IsMaster)
   {
      engine.OpenMasterForm(attributes);
      engine.AddMasterFormPage(attributes, page, pageOptions);
      engine.CloseMasterForm(attributes);
   }
   else
   {
      engine.OpenForm(attributes);
      engine.AddFormPage(attributes, page, pageOptions);
      engine.CloseForm(attributes);
   }
}

Remarks

IncludeRectangles forms the region of the image that will be considered for feature extraction, any region outside the include region will be ignored.

If IncludeRectangles doesn't have a rectangle then the whole image will be considered as one include region for the feature extraction.

ExcludeRectangles forms the region of the image that will be ignored for feature extraction.

IncludeRectangles are considered first then the ExcludeRectangles will be excluded from the include region.

Inheritance Hierarchy

System.Object
   Leadtools.Forms.Recognition.PageRecognitionOptions

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

Leadtools.Forms requires a Forms Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features