asp.net pdf viewer : Change page size pdf Library control class asp.net web page .net ajax Kofax_Developers_Guide_v1011-part970

Custom Module Sample
Kofax Capture Developer's Guide
111
the data is processed selectively, execution is faster than XML import and export. The actual
organization of Kofax Capture data (the element and attribute structure) is identical between
the XML and this new API.
The Kofax Capture Optimized Custom Module .NET Type Implementation Library
is intended for use with both custom modules and workflow agents. Because of the
performance overhead with XML, we suggest that you use the optimized API whenever
possible.
Kofax Capture continues to support XML, which may still be better for developers with
applications that are well-suited to an XML interface.
The Kofax Capture Optimized Custom Module .NET Type Implementation Library is
implemented in the Kofax Capture Optimized Custom Module .NET Type Implementation
Library (Kofax.DBLiteOpt.dll).
The complete API for the Kofax Capture Optimized Custom Module .NET Type
Implementation Library is documented in the Kofax Capture API Reference, which is available
from the 
Documentation\Help\APIRef
folder on your Kofax Capture installation media.
Kofax Capture Document Access .NET Type Implementation Library
This section gives you information about Kofax Capture Document Access .NET Type
Implementation Library, the component that offers the ability to integrate a custom
module into your Kofax Capture installation. Kofax Capture Document Access .NET
Type Implementation Library makes it possible for the custom module to access batch
information from Kofax Capture. Likewise, your custom module can relay batch information
to Kofax Capture. The Kofax Capture Document Access .NET Type Implementation Library,
Kofax.DBLite.dll, is available from <
Kofax Capture installation>\Bin
.
Kofax Capture Document Access .NET Type Implementation Library gives you the ability to
do the following:
▪ Route a Kofax Capture batch to a custom module for processing.
▪ Use XML transport files to export/import batch information between Kofax Capture and a
custom module.
▪ Close a batch from a custom module and route it to the next module in the Kofax Capture
workflow.
Although it is possible to access and modify batch data using Kofax Capture Document
Access .NET Type Implementation Library and XML, we recommend that you use the Kofax
Capture Optimized Custom Module .NET Type Interface Library because it provides a
more efficient mechanism to selectively retrieve and manipulate data. A degradation in
performance could occur when using XML to import and export data.
The complete API for the Kofax Capture Optimized Custom Module .NET Type
Implementation Library is documented in the Kofax Capture API Reference, which is available
from the 
Documentation\Help\APIRef
folder on your Kofax Capture installation media.
Note  Some API methods and properties are reserved for exclusive use by Kofax. These APIs
are not documented and their use is not supported. These items are not displayed when
browsing the API definitions.
Change page size pdf - Compress reduce PDF size in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
C# Code & .NET API to Compress & Decompress PDF Document
change font size in pdf file; adjust pdf size
Change page size pdf - VB.NET PDF File Compress Library: Compress reduce PDF size in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
VB.NET PDF Document Compression and Decompression Control SDK
change paper size pdf; best online pdf compressor
Custom Module Sample
112
Kofax Capture Developer's Guide
Development Environment
To develop a custom module that is compatible with Kofax Capture, you need the following
tools for the setup OCX (optional) and runtime executable.
Setup OCX
▪ Tool such as Visual Basic .NET that allows you to implement a COM interface. Custom
module testing with Kofax Capture has been certified with Visual Basic .NET.
▪ Kofax Capture Administration module type library. Located in <
Kofax Capture
installation folder>\Bin
, the file is Kofax.Capture.AdminModule.dll.
Runtime Executable
▪ Tool such as Visual Basic .NET to create an instance of a COM interface. Custom module
testing with Kofax Capture has been certified with Visual Basic .NET.
▪ Kofax Capture Document Access .NET Type Implementation Library, the COM object
that allows your custom module to access batch information from Kofax Capture, also
allows your custom module to relay information about batches to Kofax Capture. The
Kofax Capture Document Access .NET Type Implementation Library, Kofax.DBLite.dll, is
available from <
Kofax Capture installation>\Bin
.
▪ Kofax Capture Optimized Custom Module .NET Type Implementation Library, the
API that allows your custom module to selectively and quickly retrieve data from
Kofax Capture. This API provides the mechanism to use the Kofax Capture Document
Access .NET Type Implementation Library used to select and open a batch. The
Kofax Capture Optimized Custom Module .NET Type Implementation Library,
Kofax.DBLiteOpt.dll, is available from <
Kofax Capture installation>\Bin
.
Although is it possible to access and modify batch data using Kofax Capture Document
Access .NET Type Implementation Library and XML, we recommend that you use the Kofax
Capture Optimized Custom Module .NET Type Implementation Library, because it provides
a more efficient mechanism to selectively retrieve and manipulate data. A degradation in
performance could occur when using XML to import and export data.
Installing the Sample Custom Module
This section explains how to install the files required to register and run the sample custom
module.
To customize Kofax Capture, you must have Administrator privileges to install files to the
Kofax Capture installation folder.
Start Windows Explorer and browse to 
<Kofax Capture installation folder>
\Source\Sample Projects\CustMod\Generic
.
Display the contents of the 
Generic
folder.
Copy the following files to <
Kofax Capture installation folder>\Bin
:
▪ CMSample.aex
▪ CMSample.exe
VB.NET Image: How to Create Visual Basic .NET Windows Image Viewer
can get a basic idea of the page layout from Apart from that, you are entitled to change the orientation You can accurately define the size and location of all
change font size pdf form; change font size in pdf form field
C# PDF insert text Library: insert text into PDF content in C#.net
Insert formatted text and plain text to PDF page using .NET XDoc.PDF component in C#.NET class. Ability to change text font, color, size and location and
reader pdf reduce file size; adjusting page size in pdf
Custom Module Sample
Kofax Capture Developer's Guide
113
Registering the Sample Custom Module
This section explains how to use the Custom Module Manager to register the sample custom
module, so you can use it as an Kofax Capture processing queue.
Note  You can also register custom modules with the Kofax Capture Extension Registration
Utility
.
After completing the registration process, you can view the properties for the custom module
sample. The properties are defined in the registration file (CMSample.aex), which you copied
earlier to the 
Bin
folder. For detailed information about the format for the registration file, see
Registration File Creation
.
In the Administration module, on the Tools tab, in the System group, click Custom
Modules.
The Custom Module Manager window appears.
2
On the Custom Module Manager window, click Add.
The Open window appears.
3
On the Open window, browse to the 
Bin
folder, select CMSample.aex, and click Open.
The Custom Modules window appears.
On the Custom Modules window, select Sample and click Install.
A message appears to confirm that the registration process is complete.
5
Click OK to clear the confirmation message.
6
Click Close to exit the Custom Modules window.
The name of the newly registered custom module “Sample” appears on the Custom
Module Manager window.
Adding the Sample to the Batch Processing Workflow
Once a custom module is successfully registered, it is available for selection as a batch class
processing queue from the Create Batch Class and Batch Class Properties windows.
You can select it as a processing queue for a batch class, just like any other processing queue.
Just select the custom module from the list of Available Queues and click Add.
When you move the custom module to the list of Selected Queues, it is inserted according to
the valid processing order, according to its processing function. The valid processing order
is defined by the Follow and Precede entries that appear on the Custom Module Properties
Advanced tab (see the preceding section).
For example, the Sample custom module is defined to follow Scan and precede Export.
Therefore, you can move it to any position within the list of Selected Queues after Scan and
before Export.
When you publish the batch class with the custom module in its workflow, check the results
log on the Publish window. Be sure that no errors or warnings are associated with the custom
module.
Use the Administration module to create or open the batch class to include the sample
custom module in its workflow.
C# PDF Convert: How to Convert Word, Excel, PowerPoint, Tiff
Support conversion to PDF from other documents, keeping original document page size. Support rendering image to a PDF document page, no change for image size.
advanced pdf compressor online; pdf paper size
C# PDF Annotate Library: Draw, edit PDF annotation, markups in C#.
Able to edit and change PDF annotation properties such as font users how to add text comments on PDF page using C# text box to PDF and edit font size and color
pdf change font size in textbox; pdf file compression
Custom Module Sample
114
Kofax Capture Developer's Guide
Select the batch class name on the Definitions panel and right-click to open the Properties
Queues tab.
Notice that “Sample” appears on the list of Available Queues.
Verify that Scan appears on the Selected Queues list, and then add Sample to the list.
Click OK to close the window.
Publish the batch class.
Using Batch Manager with a Custom Module
From Batch Manager, you can view the status of any batch, including a batch that includes
a custom module in its workflow. You can launch the custom module and process the batch
from Batch Manager.
In addition, the custom module is available from the list of queues for batches that have the
custom module defined as part of their workflow. You can optionally redirect a batch to a
custom module from Batch Manager.
Creating a Batch to Open in the Sample Custom Module
This section explains how to create a batch to be routed to the sample custom module.
Start the Scan module and create a batch based on the batch class you published.
Scan the batch and close it.
Do one of the following to start the sample module:
▪ Double-click CMSample.exe in <
Kofax Capture installation folder>\Bin
.
▪ Start Batch Manager, select the batch that is ready to open in the sample custom
module, and on the Home tab, in the Batch group, click Process Batch.
The Sample custom module starts and appears on the desktop. If you use Batch Manager
to start the custom module, the options for opening a batch are slightly different.
Optionally select the Include Setup Data check box to import the batch class setup data,
along with the batch data.
The setup data includes information about the batch class properties, including export
connectors, image cleanup, recognition profiles, and more. For this demonstration, the
setup data includes the standard administrative data. Your implementation will probably
include a setup OCX to provide batch class configuration settings and publish checks
associated with a custom module.
Select By Batch as the process mode. For information about the “By Document” process
mode, see Processing by Document
.
If you launched the sample from Batch Manager, click Open Batch # (where # is the
incremental batch identification number) to open the batch.
If you did not launch the sample from Batch Manager, do one of the following:
▪ Click Open Next Batch to open the next available batch.
▪ Click Select Batch to display the Open Batch window where you can select a batch,
and click OK.
C# PDF Thumbnail Create SDK: Draw thumbnail images for PDF in C#.
public override Bitmap ConvertToImage(Size targetSize). Description: Convert the PDF page to bitmap with specified size. Parameters:
pdf compress; change font size pdf
C# PDF File Split Library: Split, seperate PDF into multiple files
set as 1, then the two output PDF files will contains the first page and the explain how to split a PDF file into multiple ones by output PDF file size.
change font size pdf fillable form; pdf page size limit
Custom Module Sample
Kofax Capture Developer's Guide
115
Processing by Document
The previous section explained how to open a batch in the Sample custom module using the
By Batch process mode. You can also process a batch with the By Document process mode.
Use this mode to open a specific range of documents in a batch, rather than the entire batch.
In the Scan module, create a batch as described in Creating a Batch to Open in the Sample
Custom Module
. Be sure that the batch includes documents.
Start the sample custom module as described in Creating a Batch to Open in the Sample
Custom Module
.
When the sample module window appears, select By Document as the process mode and
select the Include Setup data check box.
Select the option to open the batch.
At “Open documents,” select a range of documents to process in the sample custom
module.
If the batch has no documents, the options for selecting and opening a range of
documents are grayed on the window.
Click Open Documents.
Under Process Documents, click Copy XML or Corrupt XML. For more information, see
XML Transport Files
.
Click Close Documents.
Under Process Batch, click Copy XML or Corrupt XML.
10 Click Close Batch.
Setting the Batch Custom Storage String
Use the fields in the Batch Custom Storage String area to read or write the batch custom
storage string when a batch is opened. If the batch is closed, you can only read the value.
In Batch Manager, process a batch that uses the CMSample custom module.
Open the batch using the Sample window, using the “Open Batch n” button.
Type a name and a value in the appropriate fields.
Click Set.
The name and value are set in the batch.
Getting the Batch Custom Storage String
In Batch Manager, process a batch that uses the CMSample custom module.
Open the batch using the Sample window, using the “Open Batch n” button.
Type the name of the batch custom storage string in the name field.
Click Get.
The value appears.
VB.NET PDF File Split Library: Split, seperate PDF into multiple
Separate source PDF document file by defined page range in VB.NET class application. Divide PDF file into multiple files by outputting PDF file size.
best way to compress pdf files; reduce pdf file size
Create Thumbnail Winforms | Online Tutorials
change "Width" & "Height" to set your thumbnail size; items in thumbnail; Click "Swap" to change two items Multi-page Tiff Processing; RasterEdge OCR Engine; PDF
pdf page size may not be reduced; change font size pdf comment box
Custom Module Sample
116
Kofax Capture Developer's Guide
XML Transport Files
XML transport files are used to relay batch class (setup/administration) and batch (runtime)
information between Kofax Capture and the custom module. For example, the sample
custom module uses a runtime XML file called RTExport.xml to list Kofax Capture database
information that the custom module uses. When batch information is imported back to the
database after processing in the custom module, another XML file called RTImport.xml is
used. Any modifications that you make to the XML format are validated by Kofax Capture to
ensure compatibility.
The sample module uses the standard Kofax Capture configuration settings. You will
probably implement a setup OCX to define additional custom configuration and property
settings associated with custom module functionality. The configuration information is
relayed between Kofax Capture and the custom module via files called SUExport.xml and
SUImport.xml.
Once the batch is open, the following files are generated in 
ProgramData\Kofax\Capture
\Local\Kofax.Sample
.
▪ RtExport.xml: Contains Kofax Capture database information related to the current batch.
When the “By Batch” process mode is enabled, RtExport.xml includes data related to all the
documents in the batch. When the “By Document” process mode is enabled, a separate file
(DcExport.xml) is generated with the document information.
▪ SuExport.xml: Contains configuration settings and publish checks associated with the
custom module. This file is generated if you selected the “Include Setup data” check box
before opening the batch.
▪ DcExport.xml: Contains Kofax Capture database information related to selected
documents in the batch. This file is generated only if you select the “By Document” process
mode.
A set of Document Type Definition (DTD) files is also generated. The DTD files list
the required XML format that Kofax Capture requires: AcBatch.dtd, AcDocs.dtd, and
AcSetup.dtd. (AcDocs.dtd is generated only if you opened the batch in “By Document”
mode.)
The .dtd files appear in the Kofax Capture installation folder. To examine these DTD files in
detail, open them in any text editor.
Copying the XML Files Back to Kofax Capture
1
Click the Copy XML button.
Notice that additional import files are generated in the Kofax.Sample folder:
DcImport.xml, RtImport.xml, and SuImport.xml. These files are used to import batch
information to Kofax Capture from the sample module.
Optionally, select a state (Ready, Suspended, Error) in which the batch should be closed.
Click the Close Batch button. The batch is routed to the next module in the Kofax
Capture workflow, unless it is suspended or closed in error.
Corrupt XML
Even if the XML format is technically valid and well-formed, the content may not be
compatible with Kofax Capture. The Sample custom module includes a mechanism to
Custom Module Sample
Kofax Capture Developer's Guide
117
demonstrate the effect of XML content that is incompatible with Kofax Capture. You can click
the Corrupt XML button to intentionally insert an incompatible text string in one of the XML
import files.
If you are processing in the By Document mode, you can click the Corrupt XML button to
insert an incompatible text string in DcImport.xml. If you are processing in By Batch mode,
click the Corrupt XML button to insert a similar string in the RtImport.xml file.
When you select Corrupt XML, the batch is suspended when you close it. A message appears
with text explaining that the error is related to the import process, the KofaxCaptureRuntime
root element, and the first batch element.
When the XML format is not compatible with Kofax Capture, the batch is not routed to the
next queue in the Kofax Capture processing workflow.
Create Page
Use the Create Page button to create a page or a new document. To create a page or a
document, the Process mode must be set to “by Batch.”
Clicking the Create Page button adds a new page to the XML file. If “Create page in new
document” is selected, a document and page are added to the XML file.
You can open RtImport.xml in the Kofax.Sample folder to see the added lines.
Custom Module Sample
118
Kofax Capture Developer's Guide
Kofax Capture Developer's Guide
119
Appendix B
Workflow Agent Sample
This appendix walks you through the process of installing, registering, and using the sample
workflow agent provided in your Kofax Capture product package. The name of this sample is
“Validation Workflow Agent.”
A workflow agent is a custom application that has the ability to examine and modify batch
data, as well as change the routing (next module) and status for the batch. Workflow agents
are invoked whenever a batch is closed from any module.
Workflow agents consist of a runtime module and optional setup program. Prior to using a
workflow agent, you must write the necessary code, and then register the agent.
You can find the sample workflow agent application in 
\Kofax\Capture\Source\Sample
Projects\Workflow\WFSample
. This folder contains a Visual Basic .NET Project for both a
Workflow Agent and Setup OCX. This folder also contains a compiled version of this Project,
and the associated sample Kofax Capture Registration File (.aex).
The sample supports a setup OCX that adds a new menu item (Validation Workflow
Properties) to the Batch Class context menu.
At runtime, the Validation Workflow Agent skips validation for a document if all index
fields in that document are automatically recognized with at least a user-specified confidence
level. You can specify the confidence level with extensions added by the Workflow Agent
setup OCX. If all documents in a batch meet the confidence level, the Validation module (and
Verification module, if applicable) is skipped.
Note  Workflow agents are very similar to custom modules, and the windows for registering
workflow agents are nearly identical to those for custom modules.
Installing the Sample Workflow Agent
This section explains how to install the files required to register and run the sample workflow
agent.
If you are customizing Kofax Capture, you must have Administrator privileges to install files
to the Kofax Capture installation folder.
Start Windows Explorer and browse to 
Kofax\Capture\Source\Sample Projects
\Workflow\WFSample
.
Display the contents of the 
WFSample
folder.
Copy the following files from the 
WFSample
folder to <
Kofax Capture installation
folder>\Bin
:
▪ WorkflowAgentSample.net.aex
▪ SampleWorkflowSetup.net.dll
▪ WFAgent.net.dll
Workflow Agent Sample
120
Kofax Capture Developer's Guide
Registering the Sample Workflow Agent
This section explains how to use the Workflow Agent Manager to register the sample
workflow agent, so you can use it in Kofax Capture.
Note  You can also register workflow agents with the Kofax Capture Extension Registration
Utility.
In the Administration module, on the Tools tab, in the System group, click Workflow
Agents.
The Workflow Agent Manager window appears.
2
On the Workflow Agent Manager window, click Add.
The Open window appears.
3
On the Open window, browse to the 
Bin
folder, select WorkflowAgentSample.net.aex,
and click Open.
The Workflow Agents window appears.
On the Workflow Agents window, select Validation Workflow Agent and click Install.
A message appears to confirm that the registration process is complete.
5
Click OK to clear the confirmation message.
6
Click Close to exit the Workflow Agents window.
The name of the newly registered Validation Workflow Agent appears in the Workflow
Agent Manager window.
You can now view the properties for the registered workflow agent. The properties are
defined in the registration file (WorkflowAgentSample.net.aex), which you copied earlier
to <
Kofax Capture installation folder>\Bin
.
7
Click Properties to open the Workflow Agents Properties window - General tab.
8
Click the General and Programs tabs to familiarize yourself with the other properties for
the sample workflow agent, and then click Close.
9
Click Close again from the Workflow Agent Manager window.
Using the Sample Workflow Agent
This section explains how to use the sample workflow agent in a batch class.
In the Administration module, create or open a batch class for which you want to include
the sample workflow agent.
Select the batch class name from the Definitions panel and right-click to open the Batch
Class Properties window - Queues tab.
Ensure that Scan, Validation, and other modules appear as applicable on the Selected
Queues list.
On the Batch Class Properties window - Workflow Agents tab, select Validation
Workflow Agent and click Add to move it to the Selected Workflow Agents list.
Click OK to close the Batch Class Properties window.
Documents you may be interested
Documents you may be interested