IBatch

CleanRecognitionResults( document : IDocument ) *

ドキュメントの認識結果を削除します。

CreateDocumentFromPage( targetPosition : int, page : IPage ): IDocument *

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

CreateDocumentFromPage メソッドが呼び出されると、次のようになります。

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

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

CreatePageFromImage( page : IPictureObject, [省略可能] target : IDocument, [省略可能] position : int, [省略可能] sourceInfo : string ) : IPage *

IPictureObject オブジェクトからページを作成し、そのページを返します。

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

DeleteDocument( document : IDocument ) *

ドキュメントを削除します。

DeletePage( page : IPage ) *

ページを削除します。

MoveDocument( source : IDocument, targetPosition : int ) *

ドキュメントをバッチ内の指定した位置に移動します。

MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, int targetPageIndex : int ) *

source ドキュメントの sourcePageIndex 番目のページを、target ドキュメント内の targetPageIndex の位置に移動します。

AsBatchItem *

IBatchItem

読み取り専用

バッチを IBatchItem オブジェクトに変換します。

添付ファイル

IUserAttachments

読み取り専用

ユーザー添付ファイル。

BatchTypeName

string

読み取り専用

バッチタイプの名前

コメント

string

読み取り/書き込み

コメント。

CreatedBy

IPrincipal

読み取り専用

新しく作成されたバッチの著者。

FC のスタンドアロン版では、null を返します。

CreationDate

DateTime

読み取り専用

バッチが作成された日時です。

Documents

IDocuments

読み取り専用

バッチを構成するドキュメント

ID

int

読み取り専用

バッチ ID (プロジェクト内で一意) 。

Name

string

読み取り/書き込み可

バッチの名前。

優先度

TProcessingPriority

読み取り/書き込み可能

バッチの優先度。

プロジェクト

IProject

読み取り専用

このバッチが含まれるプロジェクト。

プロパティ

IProperties

読み取り専用

バッチの名前付きパラメーター。

SLAExpirationDate

DateTime

読み取り/書き込み可能

バッチの処理期限。

SlaStartDate

DateTime

読み取り専用

バッチの処理が開始された時刻。

SlaWarningPeriod *

Int

読み取り/書き込み可能

タスクの期限が近づいていることを知らせる警告が表示され始める時点です。期限までの残り時間を分単位で指定します。

StageInfo

IStageInfo

読み取り専用

ドキュメントの処理ステージに関する情報を含む IStageInfo オブジェクトを返します。TaskId フィールドと PrincipalId フィールドは使用されません。