op.document.OCRPages

From PDF XChange PDF SDK
Jump to: navigation, search
(Sample)
 
Line 2: Line 2:
 
{{#customTitle:op.document.OCRPages}}
 
{{#customTitle:op.document.OCRPages}}
 
{{#parentPage:PXV:Operations|op.document.OCRPages|operation}}
 
{{#parentPage:PXV:Operations|op.document.OCRPages|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview...
+
The operation allows to apply the Optical Character Recognition to the selected pages with given parameters.
  
 
== Parameters ==
 
== Parameters ==
Line 15: Line 14:
 
|-
 
|-
 
| class="op_param_name" | Input
 
| class="op_param_name" | Input
| style="text-align:center" | Array
+
| style="text-align:center" | IUnknown
| Array of <code>IUnknown</code>-based objects.
+
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] which the Optical Character Recognition will be applied to.
 
|-
 
|-
 
| class="op_param_name" | Output
 
| class="op_param_name" | Output
 
| style="text-align:center;" | Array
 
| style="text-align:center;" | Array
| Array of <code>IUnknown</code>-based objects.
+
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] processed with the Optical Character Recognition.
 
|-
 
|-
 
| class="op_param_name" | [[PXV:op_document_OCRPages_Options|Options]]
 
| class="op_param_name" | [[PXV:op_document_OCRPages_Options|Options]]

Latest revision as of 02:22, 19 April 2016


Overview

The operation allows to apply the Optical Character Recognition to the selected pages with given parameters.

Parameters

Name Type Description
Input IUnknown IUnknown-based object containing the IPXC_Document which the Optical Character Recognition will be applied to.
Output Array IUnknown-based object containing the IPXC_Document processed with the Optical Character Recognition.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void OCRPages(PDFXEdit.IPXV_Inst Inst, PDFXEdit.IPXV_Document Doc)
{
	int nID = Inst.Str2ID("op.document.OCRPages", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	PDFXEdit.ICabNode input = Op.Params.Root["Input"];
	input.v = Doc;
	PDFXEdit.ICabNode options = Op.Params.Root["Options"];
	options["PagesRange.Type"].v = "All"; //OCR all pages
	options["OutputType"].v = 0;
	options["OutputDPI"].v = 300;
	Inst.AsyncDoAndWaitForFinish(Op);
}