メインコンテンツへスキップ

概要

IFlexiCaptureTools インターフェイスは、スクリプトで使用できるグローバルオブジェクト FCTools によって実装されています。FCTools グローバルオブジェクトのすべてのメソッドは静的メソッドとして呼び出すことができます。たとえば、次のようになります。
FCTools.ShowMessage( "Test" );
注記。 ルールをローカルで確認するための Web Verification Station では、このオブジェクトの一部のメソッドおよびプロパティは使用できません。サポートされていないメソッドとプロパティには、アスタリスク (*) が付いています。

メソッド

ClassifyPage( page : IPage, [optional] callback : IProcessingCallback, [optional] detectClassesWithoutLayout : bool ) : IPageClassificationResult *

ページを分類し、分類に成功した場合は分類結果を返します。分類結果には、バッチタイプ分類器のクラス名または null が返されます。

このメソッドは、次のような場合に使用できます。

  • ページを分類し、分類結果に応じて別々のフォルダーへ 検索可能な PDF検索可能な PDF としてエクスポートする必要があり、 Document Definitions の認識やマッチングが不要な場合。
  • 分類結果に応じて、認識前にドキュメントに対して何らかの操作を実行する必要がある場合 (例: ページの向きの補正) 。

注: detectClassesWithoutLayout パラメーターが指定されていない場合、その値は false に設定されます。値が true の場合、 分類は分類器のクラスのみに基づいて行われ、利用可能な Document Definitions は分類に使用されません。

注: IProcessingCallback インターフェイスを使用することも、独自のインターフェイスを実装することもできます。

IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool *

モジュールの使用がライセンス上許可されているかどうかを確認します。

LoadImage( filePath : string, [optional] pageNumber : int ) : IEditablePictureObject *

ファイルから画像をロードします。ロードした画像は編集可能になります。pageNumber パラメーターが指定されていない場合、値は “1” に設定されます。

NewImageSavingOptions() : IExportImageSavingOptions *

IExportImageSavingOptions クラスの新しいオブジェクトを作成します。

PictureFromHBitmap( [optional] resolution : int, bitmap : HBITMAP ) : IEditablePictureObject *

指定した解像度で、HBITMAP オブジェクトから画像を生成します。resolution パラメーターが指定されていない場合は、画像解像度が自動的に検出されます。生成された 画像は編集可能です。

注: HBITMAP オブジェクトの所有権は取得されるため、画像の生成後にこのオブジェクトに対して CloseHandle メソッドを呼び出す必要はありません。

Rect( left : int, top : int, right : int, bottom : int ) : string

指定した座標の長方形を表す文字列を生成します。

ShowMessage( text : string, [optional] isError : bool )

ユーザーにメッセージを表示します。isError フラグが指定されていない場合、その値は false に設定されます。isError フラグが true に設定されている場合はエラーメッセージが表示され、それ以外の場合は通知メッセージが表示されます。スクリプトがハンドリング処理内で実行される場合、メッセージは 処理ログに書き込まれます。

ClassifyPage メソッドは分類器とは異なり、ページのクラスを分析するために使用されますが、分類結果は照合されません。たとえば、分類器に Banking_eng Document Definition が含まれていない場合でも、そのページに適用した ClassifyPage メソッドは、この Document Definition のセクションを返すことがあります。

プロパティ

名前アクセス説明
CurrentUserSession *IUserSessionInfo読み取り専用現在 Processing Station を使用しているユーザーのセッション情報を返します。検証中は、現在検証を実行しているユーザー (リモートユーザーを含む) のセッション情報を返します。
ScriptContext *IScriptDefinitionContext読み取り専用スクリプトが作成されたオブジェクトへのアクセスを提供します。このプロパティを使用すると、スクリプトが受け取るパラメーターに関係なく、プロジェクトにアクセスできます。