IFlexiCaptureTools

動作

そのIFlexiCaptureToolsインターフェイスは、スクリプトで使用可能なFCToolsグローバルオブジェクトで実施されています。FCToolsグローバルオブジェクトのすべてのメソッドは、静的メソッドとして呼び出すことができます。次に例を示します:

FCTools.ShowMessage( "Test" );
    

注:ローカルのルールチェックの場合、このオブジェクトの方法とプロパティの一部をウェブ検証ステーションで使用することはできません。サポート外の方法とプロパティには、アスタリスク(*)が付けられています。

メソッド

定義 説明
ClassifyPage( page: IPage, [optional] callback: IProcessingCallback, [optional] detectClassesWithoutLayout : bool ) :IPageClassificationResult

ページを分類し、分類に成功した場合は分類結果を返します。分類結果は、バッチタイプの分類子のクラスの名前でも、nullでもかまいません。

このメソッドは、次の場合に使用できます:

  • 分類結果に応じて、ページを分類し、エクスポート設定として別のフォルダにエクスポートする必要があり、文書定義の認識や照合は不要です。
  • 分類結果に応じて、認識の前に文書に対していくつかのアクション(例えば、ページの向きの修正)を行うべきです。

注:もし、detectClassesWithoutLayoutパラメータが指定されていない場合、その値は以下に設定されます:false。値がtrueの場合、分類は分類子のクラスのみに基づいており、利用可能な文書定義は分類には使用されません。

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

IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool モジュールの使用がライセンスによって許可されているかどうかをチェックします。
LoadImage( filePath : string, [optional] pageNumber : int ) :IEditablePictureObject ファイルから画像を読み込みます。読み込まれた画像は編集可能です。もし、pageNumberパラメータが指定されていない場合、その値は "1"に設定されます。
NewImageSavingOptions() :IExportImageSavingOptions 以下、IExportImageSavingOptionsクラスの新しいオブジェクトを作成します。
PictureFromHBitmap( bitmap :HBITMAP, [optional] resolution : int ) :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 文書定義が含まれていない場合、ページに適用されたClassifyPageメソッドは、この文書定義のセクションを返すことができます。

プロパティ

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

11/10/2020 12:08:06 PM


Please leave your feedback about this article