> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IBatch

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

<div id="what-it-does">
  ## 機能
</div>

バッチを表します。

<a id="webverificationavailableinterface" />

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

<div id="methods">
  ## メソッド
</div>

<Warning>
  以下のメソッドを使用するには、バッチ構造を変更する権限が必要です。これらのメソッドは、[バッチ処理](/ja/flexi-capture/appendix/scripts/scripts-handling#batchprocessingscript)スクリプトからのみ呼び出せます。
</Warning>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>定義</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>説明</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          CleanRecognitionResults( document : <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a> ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>ドキュメントの認識結果を削除します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          CreateDocumentFromPage( targetPosition : int, page : <a href="/ja/flexi-capture/appendix/scripts/ipage">IPage</a> ): <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a>{" "}
          <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

        <ul>
          <li>
            <strong>0</strong> から <strong>targetPosition – 1</strong> までのインデックスを持つドキュメントは、元の位置のまま保持されます。
          </li>

          <li>
            <strong>targetPosion</strong> から <strong>N</strong> までのインデックスを持つドキュメントは、1 つ後ろの位置に移動します。
          </li>

          <li>
            新しいドキュメントは、空いた <strong>targetPosition</strong> に配置されます。
          </li>
        </ul>

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

        <details>
          <summary>例</summary>
          <p>最初のドキュメントを処理するスクリプトの例:</p>

          <pre>
            <code>
              IDocument document = Documents\[0]; for( int i = document.Pages.Count - 1; i >= 0; --i ) \{    Batch.CreateDocumentFromPage( document.Index + 1, document.Pages\[i]
              ); }
            </code>
          </pre>
        </details>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          CreatePageFromImage( page : <a href="/ja/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a>, \[省略可能] target :{" "}
          <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a>, \[省略可能] position : int, \[省略可能] sourceInfo : string ) :{" "}
          <a href="/ja/flexi-capture/appendix/scripts/ipage">IPage</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a> オブジェクトからページを作成し、そのページを返します。
        </p>

        <ul>
          <li>
            対象のドキュメントが指定されている場合、そのページはそのドキュメントに追加されます。1ページのドキュメントを作成するには、対象ドキュメントに <strong>null</strong> を指定します。
          </li>

          <li>
            位置が指定されている場合、そのページはドキュメントの指定した位置に追加されます (対象ドキュメントが指定されている場合) 。それ以外の場合は、1ページのドキュメントがバッチの指定した位置に追加されます (対象ドキュメントに <strong>null</strong> が指定されている場合) 。先頭位置は "0"、ドキュメントまたはバッチの末尾は "-1" に対応します。
          </li>

          <li>
            <strong>sourceInfo</strong> パラメーターが指定されている場合、その値はページソース情報に書き込まれます。指定されていない場合、ページソース情報は{" "}
            <a href="/ja/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a> から取得されます。
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          DeleteDocument( document : <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a> ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>ドキュメントを削除します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          DeletePage( page : <a href="/ja/flexi-capture/appendix/scripts/ipage">IPage</a> ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>ページを削除します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          MoveDocument( source : <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a>, targetPosition : int ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

    <tr>
      <td>
        <p>
          MovePage( source : <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a>, target : <a href="/ja/flexi-capture/appendix/scripts/idocument">IDocument</a>, sourcePageIndex : int, int
          targetPageIndex : int ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>source ドキュメントの sourcePageIndex 番目のページを、target ドキュメント内の targetPageIndex の位置に移動します。</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## プロパティ
</div>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>名前</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>型</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>アクセス</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>説明</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          AsBatchItem <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>
          バッチを <a href="/ja/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a> オブジェクトに変換します。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>添付ファイル</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iattachments">IUserAttachments</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>ユーザー添付ファイル。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>BatchTypeName</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>バッチタイプの名前</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>コメント</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>読み取り/書き込み</p>
      </td>

      <td>
        <p>コメント。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>CreatedBy</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iprincipal">IPrincipal</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>新しく作成されたバッチの著者。</p>

        <p>
          FC のスタンドアロン版では、<strong>null</strong> を返します。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>CreationDate</p>
      </td>

      <td>
        <p>DateTime</p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>バッチが作成された日時です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Documents</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/idocuments">IDocuments</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>バッチを構成するドキュメント</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ID</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>バッチ ID (プロジェクト内で一意) 。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Name</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>読み取り/書き込み可</p>
      </td>

      <td>
        <p>バッチの名前。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>優先度</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/tprocessingpriority-appendix-scripts">TProcessingPriority</a>
        </p>
      </td>

      <td>
        <p>読み取り/書き込み可能</p>
      </td>

      <td>
        <p>バッチの優先度。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>プロジェクト</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iproject">IProject</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>このバッチが含まれるプロジェクト。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>プロパティ</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iproperties">IProperties</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>バッチの名前付きパラメーター。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a id="ibatch-slaexpirationdate" />SLAExpirationDate
        </p>
      </td>

      <td>
        <p>DateTime</p>
      </td>

      <td>
        <p>読み取り/書き込み可能</p>
      </td>

      <td>
        <p>バッチの処理期限。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>SlaStartDate</p>
      </td>

      <td>
        <p>DateTime</p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>バッチの処理が開始された時刻。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SlaWarningPeriod <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Int</p>
      </td>

      <td>
        <p>読み取り/書き込み可能</p>
      </td>

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

    <tr>
      <td>
        <p>StageInfo</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a>
        </p>
      </td>

      <td>
        <p>読み取り専用</p>
      </td>

      <td>
        <p>
          ドキュメントの処理ステージに関する情報を含む <a href="/ja/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a> オブジェクトを返します。TaskId フィールドと PrincipalId フィールドは使用されません。
        </p>
      </td>
    </tr>
  </tbody>
</table>