Gets information about the specified page in the OCR document.

Syntax

Visual Basic (Declaration)
Public Function GetPageInfo( _ ByVal pageIndex As Integer _ ) As RasterDocumentPageInfo

Visual Basic (Usage)	Copy Code
`Dim instance As RasterDocumentEngine Dim pageIndex As Integer Dim value As RasterDocumentPageInfo value = instance.GetPageInfo(pageIndex)`

C#
public RasterDocumentPageInfo GetPageInfo( int pageIndex )

Managed Extensions for C++
public: RasterDocumentPageInfo GetPageInfo( int pageIndex )

C++/CLI
public: RasterDocumentPageInfo GetPageInfo( int pageIndex )

Parameters

pageIndex: Specifies the index of the page for which information will be retrieved.

Return Value

A RasterDocumentPageInfo structure which contains information about the specified page

Example

Visual Basic Copy Code

Visual Basic	Copy Code
Public Sub GetPageInfoExample() ' Note that this is a sample key, which will not work in your toolkit RasterSupport.Unlock(Leadtools.RasterSupportType.Ocr, "TestKey") Dim rasterDocument As RasterDocumentEngine rasterDocument = RasterDocumentEngine.Instance rasterDocument.Startup() 'assume page is added, refer to AddPage example for more information Dim pageInfo As RasterDocumentPageInfo = New RasterDocumentPageInfo() pageInfo = rasterDocument.GetPageInfo(0) Dim buffer As String = String.Format("Page Width = {0}" & Constants.vbLf & "Page Height = {2}" & Constants.vbLf & "Page Bits Per Pixel = {4}", pageInfo.Size.Width, pageInfo.Size.Height, pageInfo.BitsPerPixel) MessageBox.Show(buffer) rasterDocument.Shutdown() End Sub

Public Sub GetPageInfoExample()

   ' Note that this is a sample key, which will not work in your toolkit

   RasterSupport.Unlock(Leadtools.RasterSupportType.Ocr, "TestKey")



   Dim rasterDocument As RasterDocumentEngine

   rasterDocument = RasterDocumentEngine.Instance

   rasterDocument.Startup()

   'assume page is added, refer to AddPage example for more information



   Dim pageInfo As RasterDocumentPageInfo = New RasterDocumentPageInfo()

   pageInfo = rasterDocument.GetPageInfo(0)



   Dim buffer As String = String.Format("Page Width = {0}" & Constants.vbLf & "Page Height = {2}" & Constants.vbLf & "Page Bits Per Pixel = {4}", pageInfo.Size.Width, pageInfo.Size.Height, pageInfo.BitsPerPixel)

   MessageBox.Show(buffer)

   rasterDocument.Shutdown()

End Sub

C# Copy Code

C#	Copy Code
public void GetPageInfoExample() { // Note that this is a sample key, which will not work in your toolkit RasterSupport.Unlock(Leadtools.RasterSupportType.Ocr, "TestKey"); RasterDocumentEngine rasterDocument; rasterDocument = RasterDocumentEngine.Instance; rasterDocument.Startup(); // assume page is added, refer to AddPage example for more information RasterDocumentPageInfo pageInfo = new RasterDocumentPageInfo(); pageInfo = rasterDocument.GetPageInfo(0); string buffer = string.Format("Page Width = {0}\nPage Height = {2}\nPage Bits Per Pixel = {4}", pageInfo.Size.Width, pageInfo.Size.Height, pageInfo.BitsPerPixel); MessageBox.Show(buffer); rasterDocument.Shutdown(); }

public void GetPageInfoExample() 
{ 
   // Note that this is a sample key, which will not work in your toolkit 
   RasterSupport.Unlock(Leadtools.RasterSupportType.Ocr, "TestKey"); 
   RasterDocumentEngine rasterDocument; 
   rasterDocument = RasterDocumentEngine.Instance; 
   rasterDocument.Startup(); 
 
   // assume page is added, refer to AddPage example for more information 
 
   RasterDocumentPageInfo pageInfo = new RasterDocumentPageInfo(); 
   pageInfo = rasterDocument.GetPageInfo(0); 
 
   string buffer = string.Format("Page Width = {0}\nPage Height = {2}\nPage Bits Per Pixel = {4}", pageInfo.Size.Width, pageInfo.Size.Height, pageInfo.BitsPerPixel); 
   MessageBox.Show(buffer); 
   rasterDocument.Shutdown(); 
}

Remarks

To get the number of pages of the OCR document, use the PageCount property. To recognize a page, call Recognize.
For more information, refer to Working with Pages.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Leadtools.Document	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 15.10.31
GetPageInfo Method
See Also Example