IBatch

IBatch は、FlexiCapture スクリプト内のバッチを表します。ドキュメントやページの移動と削除、画像からのページ作成、バッチのプロパティや SLA データの読み取りを実行できます。

バッチを表します。

このオブジェクトの一部のメソッドとプロパティは、ルールをローカルで確認するための Web Verification Station では使用できません。サポートされていないメソッドとプロパティには、アスタリスク (*) が付いています。

​

メソッド

以下のメソッドを使用してバッチ構造を変更するには、権限が必要です。これらのメソッドは、バッチ処理スクリプトからのみ呼び出すことができます。

メソッド	説明
CleanRecognitionResults( document : IDocument ) *	ドキュメントの認識結果を削除します。
CreateDocumentFromPage( targetPosition : int, page : IPage ) : IDocument *	ドキュメントからページを取得し、そのページから新しいドキュメントを作成します。targetPosition Parameterには、バッチ内での新しいドキュメントのインデックスを指定します。インデックスは 0 ～ N の数値である必要があります。N はバッチ内のドキュメントの総数です。詳細については、ページからドキュメントを作成するを参照してください。
CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage *	IPictureObjectオブジェクトからページを作成し、作成したページを返します。詳細については、画像からページを作成するを参照してください。
DeleteDocument( document : IDocument ) *	ドキュメントを削除します。
DeletePage( page : IPage ) *	ページを削除します。
MoveDocument( source : IDocument, targetPosition : int ) *	ドキュメントをバッチ内の指定した位置に移動します。
MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, targetPageIndex : int ) *	ソース ドキュメント内の sourcePageIndex のページを、対象ドキュメント内の targetPageIndex の位置に移動します。

​

ページからドキュメントを作成する

CreateDocumentFromPage メソッドは、ドキュメントからページを取り出し、そのページから新しいドキュメントを作成します。新しいドキュメントのインデックスは、targetPosition Parameter で指定します。インデックスは 0 から N までの数値である必要があります。N はバッチ内のドキュメントの総数です。

メソッドが呼び出されると:

• インデックスが 0 から targetPosition - 1 までのドキュメントは、元の位置に残ります。
• インデックスが targetPosition から N までのドキュメントは、1 つ後ろに移動します。
• 新しいドキュメントは、空いた targetPosition に配置されます。

ページを取り出した後にドキュメントが空になった場合、そのドキュメントは削除されます。

次の例では、最初のドキュメントを処理します:

IDocument document = Documents[0];
for( int i = document.Pages.Count - 1; i >= 0; --i ) 
{
    Batch.CreateDocumentFromPage( document.Index + 1, document.Pages[i] );
}

​

画像からページを作成する

CreatePageFromImage メソッドは、IPictureObject オブジェクトからページを作成し、作成したページを返します。

• 対象ドキュメントを指定した場合、ページはそのドキュメントに追加されます。1 ページのドキュメントを作成するには、対象ドキュメントに null を指定します。
• 位置を指定した場合、対象ドキュメントが指定されていれば、ページはそのドキュメント内の指定位置に追加されます。それ以外の場合、対象ドキュメントに null を指定すると、1 ページのドキュメントがバッチ内の指定位置に追加されます。先頭の位置は 0、ドキュメントまたはバッチの末尾は -1 です。
• sourceInfo Parameterを指定した場合、その情報がページのソース情報に書き込まれます。それ以外の場合、ページのソース情報は IPictureObject から取得されます。

​

プロパティ

名前	型	アクセス	説明
AsBatchItem *	IBatchItem	読み取り専用	バッチを IBatchItem オブジェクトに変換します。
Attachments	IUserAttachments	読み取り専用	ユーザー添付ファイル。
BatchTypeName	string	読み取り専用	バッチタイプの名前。
Comment	string	読み取り/書き込み	コメント。
CreatedBy	IPrincipal	読み取り専用	新しく作成されたバッチの作成者。ABBYY FlexiCapture のスタンドアロン版では、null を返します。
CreationDate	DateTime	読み取り専用	バッチが作成された日時。
Documents	IDocuments	読み取り専用	バッチを構成するドキュメント。
Id	int	読み取り専用	バッチ識別子 (プロジェクト内で一意) 。
Name	string	読み取り/書き込み	バッチの名前。
Priority	TProcessingPriority	読み取り/書き込み	バッチの優先度。
Project	IProject	読み取り専用	バッチを含むプロジェクト。
Properties	IProperties	読み取り専用	バッチの名前付きパラメーター。
SLAExpirationDate	DateTime	読み取り/書き込み	バッチの処理期限。
SlaStartDate	DateTime	読み取り専用	バッチの処理が開始された日時。
SlaWarningPeriod *	Int	読み取り/書き込み	タスクの期限が近づいていることを示す警告が表示される期間の開始時刻。期限までの残り時間 (分) で指定します。
StageInfo	IStageInfo	読み取り専用	ドキュメントの処理ステージに関する情報を含む IStageInfo オブジェクトを返します。TaskId フィールドと PrincipalId フィールドは使用されません。