ImageGear .NET v24.12 - Updated
PopulatePDFPage Method




ImageGear24.Recognition Assembly > ImageGear.Recognition Namespace > ImGearRecPage Class : PopulatePDFPage Method
Existing ImageGear.Formats.PDF.ImGearPDFDocument containing the PDF page to be populated.
Existing ImageGear.Formats.PDF.ImGearPDFPage to be populated with recognized data.
ImGearRecPDFOutputOptions class object.
Populates an existing PDF page in a PDF document with recognized text and/or image.
Syntax
'Declaration
 
Public Sub PopulatePDFPage( _
   ByVal outputDocument As ImGearPDFDocument, _
   ByVal outputPage As ImGearPDFPage, _
   ByVal options As ImGearRecPDFOutputOptions _
) 
'Usage
 
Dim instance As ImGearRecPage
Dim outputDocument As ImGearPDFDocument
Dim outputPage As ImGearPDFPage
Dim options As ImGearRecPDFOutputOptions
 
instance.PopulatePDFPage(outputDocument, outputPage, options)
public void PopulatePDFPage( 
   ImGearPDFDocument outputDocument,
   ImGearPDFPage outputPage,
   ImGearRecPDFOutputOptions options
)

Parameters

outputDocument
Existing ImageGear.Formats.PDF.ImGearPDFDocument containing the PDF page to be populated.
outputPage
Existing ImageGear.Formats.PDF.ImGearPDFPage to be populated with recognized data.
options
ImGearRecPDFOutputOptions class object.
Remarks
This method populates an existing PDF page in a PDF document with recognized text and/or image. The content of the existing PDF page is preserved and supplemented.

The first two parameters supply the PDF document and page to be populated. The given PDF page must belong to the given PDF document. Also, the dimensions of the PDF page should be appropriate. For example, the aspect ratio of the PDF page should match that of the recognized image, although recognized data will be stretched to fit the PDF page if necessary.

The third parameter is optional and can be used to specify options. Pass Nothing to use default options, which populates the given PDF page with only hidden text elements suitable for searching, highlighting, selection, copying and pasting, etc.

Note: depending on the ImGearRecPDFOutputOptions.UseUnicodeText property value of the options parameter, this method will support either Windows ANSI or Unicode encoding for the recognized text. When using Unicode encoding only, this method will generate ImageGear.Core.ImGearWarning's if the recognized text contains characters that cannot be represented by the selected PDF font. Use the ImGearRecPDFOutputOptions class to specify the PDF fonts used for export.

See Also

Reference

ImGearRecPage Class
ImGearRecPage Members
ImGearPDFDocument Class
ImGearPDFPage Class
ImGearRecPDFOutputOptions Class