> ## 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.

# IDocument

> ABBYY FlexiCapture スクリプト用の IDocument オブジェクトリファレンス。文書のfield、ページ、ルール、エクスポート結果、プロパティ、処理状態にアクセスできます。

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

ドキュメントを表します。

<a id="webverificationavailableinterface" />

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

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

<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>
          AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>ユーザー ファイルをドキュメントのエクスポート結果に追加します。</p>

        <p>
          <strong>sourceFile </strong>パラメーターには、追加するユーザー ファイルのパスを指定します。
        </p>

        <p>
          <strong>注: </strong> プロジェクト設定でルートのエクスポート パスを必ず指定してください。指定しない場合、ユーザー ファイルはファイル ストレージ上のバッチ フォルダーに配置されます。
        </p>

        <p>
          <strong>destinationName </strong>パラメーターには、エクスポート先を指定します。
        </p>

        <p>
          保存先に同名の既存ファイルがある場合に上書きするには、<strong>replaceIfExists</strong> パラメーターを <em>true</em> に設定します。保存先に同名の既存ファイルを保持し、ログにエラー メッセージを追加するには、<strong>replaceIfExists</strong>{" "}
          パラメーターを <em>false</em> に設定します。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          CheckRules( ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>ドキュメント内のすべてのルールをチェックします。ドキュメントに対する書き込み権限が必要です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          Field( name : string ) : <a href="/ja/flexi-capture/appendix/scripts/ifield">IField</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          field へのフルパスを指定して、ドキュメントのfieldにアクセスします。<a href="/ja/flexi-capture/appendix/scripts/scripting-model#pathforming">フルパス</a>を使用します。
        </p>

        <p>
          これは内部<a href="#loadintomemoryrequired">\*\*</a>fieldです。ルールでは使用できません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          HasField( name : string ) : bool <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          指定したパスを持つfieldが存在するかどうかを確認します。<a href="/ja/flexi-capture/appendix/scripts/scripting-model#pathforming">相対パス</a>を使用します。
        </p>

        <p>
          これは内部<a href="#loadintomemoryrequired">\*\*</a>fieldです。ruleでは使用できません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          IndexedItemValue( name : string ) : VARIANT <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          field 名または field へのパスを指定して、field の値を取得します。文書およびページの External fields で使用できます。field 名と field への{" "}
          <a href="/ja/flexi-capture/appendix/scripts/scripting-model#pathforming">完全パス</a>のどちらも使用できます。ルールでは使用できません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          IndexedItemValues( name : string ) : <a href="/ja/flexi-capture/appendix/scripts/ivariant">IVARIANTArray</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          name または field へのパスを指定して、Document Definition 内の該当する field のインデックス値の集合を取得します。field が繰り返しセクション内でインデックス field としてマークされている場合、この
          メソッドはすべてのセクションにあるその field の値をすべて返します。Document およびページの External fields から使用できます。field 名と
          <a href="/ja/flexi-capture/appendix/scripts/scripting-model#pathforming">フルパス</a> のどちらも使用できます。ルールでは使用できません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Property( name : string ) : VARIANT</p>
      </td>

      <td>
        <p>指定した名前のプロパティ値を取得します。返される値は、string、数値、または時刻の形式です。</p>
        <p>プロパティ名と返される値は次のとおりです。</p>

        <ul>
          <li>Exported - 文書がエクスポートされた日時</li>
          <li>ExportedBy - 文書をエクスポートしたユーザー</li>
          <li>Created - 文書が作成された日時</li>
          <li>CreatedBy - 文書を作成したユーザー</li>
          <li>Recognized - 文書が認識された日時</li>
          <li>RecognizedBy - 文書を認識したユーザー</li>
          <li>Modified - 文書が最後に変更された日時</li>
          <li>ModifiedBy - 文書を変更したユーザー</li>
          <li>TotalSymbolsCount - シンボルの総数</li>
          <li>UncertainSymbolsCount - 不確実なシンボルの総数</li>
          <li>RecognizedSymbolsCount - 認識されたシンボルの数</li>
          <li>Comment - 文書のコメント</li>
          <li>ProcessingErrors - 文書処理エラー</li>
          <li>ProcessingWarnings - 文書処理に関する警告</li>
        </ul>

        <ul>
          <li>Verified - 文書のフィールドが最後に手動で編集された日時</li>
          <li>VerifiedBy - 文書のフィールドに最後の手動変更を加えたユーザー (Processing Stations からの情報は保存されません) </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveAs( filename : string, \[optional] options : <a href="/ja/flexi-capture/appendix/scripts/iexportimagesavingoptions">IExportImageSavingOptions</a> ){" "}
          <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          1 ページまたは複数ページ文書の画像を保存します。保存オプションで保存形式が指定されていない場合、画像は \*.tif ファイルとして保存されます。これは内部<a href="#loadintomemoryrequired">\*\*</a> field です。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveAsStream( \[optional] options: <a href="/ja/flexi-capture/appendix/scripts/iexportimagesavingoptions">IExportImageSavingOptions</a>) : byte\[]{" "}
          <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>ドキュメントをメモリストリームに保存し、バイト配列 (COM SafeArray) として返します。</p>

        <p>
          <strong>注: </strong>JScript と VBScript は、この配列の反復処理に対応していません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveXmlToFile( filename : string ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Web Verification Station で使用するため、前処理前のドキュメントの説明を含む XML ファイルを指定した場所に保存します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveXmlToFileStorage() <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>前処理前のドキュメントの説明を含む XML ファイルを、Web Verification Station で使用するためにファイルストレージへ保存します。</p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  **Property** メソッドを、ユーザー指定のドキュメントのプロパティを含む **Properties** コレクションと混同しないでください。
</Note>

<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>
          Action <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iactionresult">IActionResult</a>
        </p>
      </td>

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

      <td>
        <p>エクスポート スクリプトおよびエクスポート後スクリプトでのみ有効です。</p>
      </td>
    </tr>

    <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>AssemblingErrors</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iassemblingerrors">IAssemblingErrors</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/iattachments">IUserAttachments</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/ibatch">IBatch</a>
        </p>
      </td>

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

      <td>
        <p>
          バッチです。ドキュメントに対するスクリプトの権限に関係なく、バッチへのアクセスは読み取り専用であり、ドキュメントおよび
          ページの内部<a href="#loadintomemoryrequired">\*\*</a>フィールドは利用できません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>BatchName</p>
      </td>

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

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

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

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

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

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

      <td>
        <p>
          子 field (ドキュメント セクション) 。<strong>Sections</strong> プロパティとは異なり、セクションの順序は Document Definition での順序に対応します。繰り返しセクションは 1 つの
          アイテムとして表され、各インスタンスにはそのアイテムの <strong>Items</strong> メソッドからアクセスできます。
        </p>

        <p>
          これは内部<a href="#loadintomemoryrequired">\*\*</a> field です。ルールでは使用できません。
        </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>DefinitionName</p>
      </td>

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

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

      <td>
        <p>Document Definition の名前です。</p>
        <p>未処理かつ未認識のドキュメントでは、このプロパティは空の文字列を返します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>DocumentDefinition</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/idocinfo">IDocumentDefinitionInfo</a>
        </p>
      </td>

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

      <td>
        <p>ドキュメントに対してマッチした Document Definition の詳細情報。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasErrors</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントに単一fieldエラーまたは複数fieldエラーがあるかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasUnpreparedImages</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントに前処理されていないページが含まれているかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasWarnings</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントにルールまたは形式に関する警告があるかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Id</p>
      </td>

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

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

      <td>
        <p>ドキュメント識別子 (外部ID) 。値は1から始まり、同一バッチ内でのみ一意です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Index</p>
      </td>

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

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

      <td>
        <p>バッチ内のドキュメントのインデックスです。値は 0 から始まり、1 つのタスク内でのみ一意です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsAnalyzed</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントが解析済みかどうかを示します。ドキュメント内のすべてのページが解析されている場合、そのドキュメントは解析済みと見なされます。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsAssembled</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントが結合済みかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsExcludedFromAutomaticAssembling</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントが自動アセンブリの対象に含まれるかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsExported</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントがエクスポート済みかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsRecognized</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントが認識済みかどうかを示します。ドキュメント内の各ページが認識済みであるか、または別紙ページである場合、そのドキュメントは認識済みと見なされます。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsUsedForTraining</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>このドキュメントを学習に使用するかどうかを指定します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsVerified</p>
      </td>

      <td>
        <p>bool</p>
      </td>

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

      <td>
        <p>ドキュメントが検証済みかどうかを示します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Pages</p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/ipages">IPages</a>
        </p>
      </td>

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

      <td>
        <p>文書ページ。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          PreviousStageInfo <a href="#webverificationavailableinterface">\*</a>
        </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> オブジェクトを返します。<strong>TaskId</strong> と{" "}
          <strong>PrincipalId</strong> フィールドは使用されません。
        </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>
          ProcessingErrors <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

      <td>
        <p>処理エラー。各エラーは改行で区切られます。</p>
      </td>
    </tr>

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

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

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

      <td>
        <p>改行区切りの処理警告メッセージ。</p>
      </td>
    </tr>

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

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

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

      <td>
        <p>文書から作成されたタスクは、指定した識別子を持つユーザーには割り当てられません。既定値は "0" で、この場合はすべてのユーザーがそのタスクを利用できます。</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>
          RecognizedSymbolsCount <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

      <td>
        <p>認識された文字数。</p>
      </td>
    </tr>

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

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/iruleerrors">IRuleErrors</a>
        </p>
      </td>

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

      <td>
        <p>ドキュメントのエラー (形式エラー、ルール エラー、二重検証結果のマージ時のエラー) のコレクション。</p>

        <p>
          <strong>注: </strong>開いているドキュメントでのみ使用できます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          セクション <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/ja/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

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

      <td>
        <p>
          ドキュメントのセクションをフラットに並べた一覧です。繰り返しセクションがある場合、この一覧にはそのセクションのすべての繰り返しインスタンスが含まれます。一覧内のセクションは、各ドキュメントセクションの最初のページと同じ順序で並びます。ページを持たないセクションがあると、一覧はそこで終了します。
        </p>

        <p>
          内部<a href="#loadintomemoryrequired">\*\*</a> fieldです。ルールでは使用できません。
        </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>Application Server上の処理ステージに関する情報。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>SymbolsForVerificationCount</p>
      </td>

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

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

      <td>
        <p>検証が必要な文字数。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TotalSymbolsCount</p>
      </td>

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

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

      <td>
        <p>シンボルの総数。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>UncertainSymbolsCount</p>
      </td>

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

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

      <td>
        <p>判別が不確かな文字数。</p>
      </td>
    </tr>
  </tbody>
</table>

<a id="loadintomemoryrequired" />\*\* - 内部fieldを使用するには、オブジェクトをメモリにロードする必要があります。
