IFlexiCaptureTools - ABBYY Documentation

The IFlexiCaptureTools interface is implemented with an FCTools global object that is available in scripts. You can call all methods of the FCTools global object as static methods, for example:

FCTools.ShowMessage( "Test" );

Some methods and properties of this object are not available on the Web Verification Station for checking rules locally. The methods and properties that are not supported are marked with an asterisk (*).

Methods

Method	Description
`ClassifyPage( page : IPage, [optional] callback : IProcessingCallback, [optional] detectClassesWithoutLayout : bool ) : IPageClassificationResult` *	Classifies the page and, in the event of successful classification, returns the classification result. The classification result can be the name of a class from a batch type classifier or `null`. Use this method in two situations. The first is exporting pages as searchable PDF to different folders by classification result, without recognition or Document Definition matching. The second is acting on a document before recognition, such as correcting page orientation, based on its classification result. If the `detectClassesWithoutLayout` parameter is not specified, its value is `false`. If it is `true`, classification is based only on classes from a classifier and the available Document Definitions are not used. You can use the IProcessingCallback interface or implement your own.
`IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool` *	Checks whether the use of a module is allowed by the license.
`LoadImage( filePath : string, [optional] pageNumber : int ) : IEditablePictureObject` *	Loads an image from a file. The loaded image is available for editing. If the `pageNumber` parameter is not specified, its value is `1`.
`NewImageSavingOptions() : IExportImageSavingOptions` *	Creates a new object of the IExportImageSavingOptions class.
`PictureFromHBitmap( [optional] resolution : int, bitmap : HBITMAP ) : IEditablePictureObject` *	Generates an image from an HBITMAP object with the specified resolution. If the `resolution` parameter is not specified, image resolution is detected automatically. The generated image is available for editing. As an HBITMAP object is taken into ownership, there is no need to call the `CloseHandle` method for it after generating the image. For an example, see Generate an image from an HBITMAP.
`Rect( left : int, top : int, right : int, bottom : int ) : string`	Generates a string in the form of a rectangle with the specified coordinates.
`ShowMessage( text : string, [optional] isError : bool )`	Shows a message to the user. If the `isError` flag is not specified, its value is `false`. If the `isError` flag is `true`, an error message is displayed; otherwise, a notification message is displayed. If the script is executed within a handling process, the message is written to the processing log.

Unlike a classifier, ClassifyPage analyzes the page class without matching the classification result. For example, ClassifyPage can return a section of the Banking_eng Document Definition even when the classifier does not contain that Document Definition.

Properties

Name	Type	Access	Description
CurrentUserSession *	IUserSessionInfo	Read-only	Returns information about the session of the user currently using the Processing Station. During verification, it returns information about the session of the user currently performing verification (including remote users).
ScriptContext *	IScriptDefinitionContext	Read-only	Provides access to the object in which the script was created. This property allows you to access the project regardless of the parameters received by the script.

Generate an image from an HBITMAP

System.Drawing.Bitmap bitmap = System.Drawing.Image.FromHbitmap( handle );
<do something>
IPictureObject FinalPicture = FCTools.PictureFromHBitmap( 300, bitmap.GetHbitmap().ToInt32() );