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

# Layout オブジェクト（ILayout インターフェイス）

> ABBYY FineReader Engine API の Layout オブジェクト（ILayout インターフェイス）— 画像レイアウト内のブロックのルートコンテナー。ブロックコレクション（Blocks、BlackSeparators、SortedBlocks、VisualBlocks）、Width/Height、Name、TextAsString、PageRegion を公開し、ファイル、メモリ、または ストリーム に保存できる永続オブジェクトです。

このオブジェクトは、画像レイアウトを扱うためのメソッドとプロパティを備えています。Layout オブジェクトは、ブロックのルートとして機能します。属性は width と height です。これらのパラメーターは、Layout オブジェクトが定義されている画像の白黒ページに対応するパラメーターと同じ値に設定されます。これは、Layout オブジェクトが解析または認識される際に自動的に行われます。

Layout オブジェクトは永続オブジェクトです。つまり、オブジェクトの現在の状態を永続ストレージに書き込むことができます。後で、永続ストレージからオブジェクトの状態を読み込むことで、オブジェクトを再作成できます。オブジェクトの永続化には、次のメソッドを使用します。

* Linux および macOS: [SaveToFile](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method) と [LoadFromFile](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/loadfromfile-method)
* Windows: [SaveToFile](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method)、[LoadFromFile](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/loadfromfile-method)、[SaveToMemory](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetomemory-method)、および [LoadFromMemory](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/loadfrommemory-method)"

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

<table>
  <thead>
    <tr>
      <th>
        <p>
          <strong>名前</strong>
        </p>
      </th>

      <th>
        <p>
          <strong>型</strong>
        </p>
      </th>

      <th>
        <p>
          <strong>説明</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          <strong>Application</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/engine-object-iengine-interface">
              Engine
            </a>
          </strong>

          ,{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            読み取り専用
          </a>
        </p>
      </td>

      <td>
        <p>
          <strong>Engine</strong> オブジェクトを返します。
        </p>
      </td>
    </tr>

    <tr>
      <td colspan="3">
        <p>
          <em>ブロックコレクション</em>
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="blackseparators" />

          <strong>BlackSeparators</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks">
              LayoutBlocks
            </a>
          </strong>

          ,{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            読み取り専用
          </a>
        </p>
      </td>

      <td>
        <p>
          レイアウトのセパレーター ブロックおよびセパレーターグループブロックのコレクションへのアクセスを提供します。
        </p>

        <p>
          このプロパティは、<strong>Layout</strong> にセパレーター ブロックが存在するかどうかにかかわらず、有効なオブジェクトを参照します。<strong>Layout</strong> に区切り線がない場合、<strong>BlackSeparators</strong> プロパティは空になります。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="blocks" />

          <strong>Blocks</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks">
              LayoutBlocks
            </a>
          </strong>

          ,{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            読み取り専用
          </a>
        </p>
      </td>

      <td>
        <p>
          レイアウトのブロックコレクションへのアクセスを提供します。このコレクションには、セパレーター ブロックおよびセパレーターグループブロックは含まれません。これらのブロックにアクセスするには、<strong>BlackSeparators</strong>{" "}
          プロパティを使用してください。
        </p>

        <p>
          このプロパティは、<strong>Layout</strong> にブロックが存在するかどうかにかかわらず、有効なオブジェクトを参照します。<strong>Layout</strong> にブロックがない場合、<strong>Blocks</strong>{" "}
          プロパティは空になります。関連項目:{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            読み取り専用オブジェクトプロパティの操作
          </a>

          .
        </p>

        <Note>
          このコレクションに自動解析ブロックは含まれません。この型のブロックは Visual Components でのみ使用されます。
        </Note>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/layout-related-objects/layout/sortedblocks-property">
              SortedBlocks
            </a>
          </strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks">
              LayoutBlocks
            </a>
          </strong>

          ,{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            読み取り専用
          </a>
        </p>
      </td>

      <td>
        <p>
          レイアウトのブロックを論理的な順序で格納したコレクションを返します。
        </p>

        <p>
          このコレクションには、<strong>Blocks</strong> プロパティが返すブロックと同じブロックが含まれます。各ブロックの左上隅の位置を基準に、左から右、次に上から下の順に並べ替えられます。互いに近接しているブロックは、1 つの論理グループの一部として扱われます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="visualblocks" />

          <strong>VisualBlocks</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks">
              LayoutBlocks
            </a>
          </strong>

          ,{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            読み取り専用
          </a>
        </p>
      </td>

      <td>
        <Warning>
          Visual Components は現在 Windows のみでサポートされています。
        </Warning>

        <p>
          Visual Components に表示されるブロックのコレクションへのアクセスを提供します。このコレクションには、テキスト、テーブル、ラスター画像、バーコード、自動解析の各型のブロックを含めることができます。コレクション内のブロックの順序は、Visual Components での表示順序と同じです。
        </p>
      </td>
    </tr>

    <tr>
      <td colspan="3">
        <p>
          <em>追加属性</em>
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="height" />

          <strong>Height</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">
              int
            </a>
          </strong>

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

      <td>
        <p>
          レイアウトの高さをピクセル単位で返します。対応する{" "}

          <strong>
            <a href="/ja/fine-reader/engine/api-reference/document-related-objects/frpage">
              FRPage
            </a>
          </strong>

          {" "}

          の{" "}

          <strong>
            <a href="/ja/fine-reader/engine/api-reference/image-related-objects/imagedocument">
              ImageDocument
            </a>
          </strong>

          {" "}

          の高さと同じ値です。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="name" />

          <strong>Name</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">
              BSTR
            </a>
          </strong>
        </p>
      </td>

      <td>
        <p>レイアウト名を格納します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="textasstring" />

          <strong>TextAsString</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">
              BSTR
            </a>
          </strong>

          , read-only
        </p>
      </td>

      <td>
        <p>
          すべてのテキストブロックおよびテーブルブロックのテキストを1行に書き込みます。{" "}

          <strong>
            <a href="/ja/fine-reader/engine/api-reference/layout-related-objects/tablecells">
              TableCells
            </a>
          </strong>

          {" "}

          オブジェクトにより、テーブルセルのテキストが書き込まれる順序が決まります。
          そのため、順序は画像内のテーブルセルの並び順と一致しない場合があります。バーコードブロックのテキストは書き込まれません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="pageregion" />

          <strong>PageRegion</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/region">
              Region
            </a>
          </strong>

          ,{" "}

          <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">
            read-only
          </a>
        </p>
      </td>

      <td>
        <p>
          レイアウト内のブロックの境界 Region を格納します。ブロックが存在しない場合、このプロパティは空の Region を返します。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/api-reference/language-related-objects/baselanguage/userproperty-property">
              UserProperty
            </a>
          </strong>
        </p>
      </td>

      <td>
        <p>
          <strong>VARIANT</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>Layout </strong>型のオブジェクトに任意のユーザー定義情報を関連付けられます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a name="width" />

          <strong>Width</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>
            <a href="/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">
              int
            </a>
          </strong>

          , read-only
        </p>
      </td>

      <td>
        <p>
          レイアウトの幅をピクセル単位で返します。対応する{" "}

          <strong>
            <a href="/ja/fine-reader/engine/api-reference/document-related-objects/frpage">
              FRPage
            </a>
          </strong>

          {" "}

          の{" "}

          <strong>
            <a href="/ja/fine-reader/engine/api-reference/image-related-objects/imagedocument">
              ImageDocument
            </a>
          </strong>

          {" "}

          の幅と同じ値です。
        </p>
      </td>
    </tr>
  </tbody>
</table>

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

| 名前                                                                                                                       | 説明                                                      |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| [Clean](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/clean-method)                                 | レイアウトから、あらゆる種類のブロックと区切り線を削除します。                         |
| [CopyFrom](/ja/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method) | 現在のオブジェクトのプロパティを、別のオブジェクトの対応するプロパティの値で初期化します。           |
| [LoadFromFile](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/loadfromfile-method)                   | ディスク上のファイルからオブジェクトの内容を復元します。                            |
| [LoadFromMemory](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/loadfrommemory-method)               | グローバルメモリからオブジェクトの内容を復元します。 <Note> *Windows のみ。* </Note> |
| [SaveToArray](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/savetoarray-method)                     | オブジェクトの内容をバイト配列として保存します。                                |
| [SaveToFile](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method)                   | オブジェクトの内容をディスク上のファイルに保存します。                             |
| [SaveToMemory](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetomemory-method)               | オブジェクトの内容をグローバルメモリに保存します。 <Note> *Windows のみ。* </Note>  |
| [SaveToStream](/ja/fine-reader/engine/api-reference/layout-related-objects/layout/savetostream-method)                   | オブジェクトの内容をストリームに保存します。                                  |

<div id="related-objects">
  ## 関連オブジェクト
</div>

<div id="windows">
  ### Windows
</div>

<img src="https://mintcdn.com/abbyy/lsETHFYUFiongXSm/images/fine-reader/engine/layout.gif?s=fae7c3d1b6741051e7ce93e8298de134" alt="Layout" width="488" height="319" data-path="images/fine-reader/engine/layout.gif" />[](/ja/fine-reader/engine/api-reference/document-related-objects/frpage#layout)[](/ja/fine-reader/engine/api-reference/layout-related-objects/autoanalysisblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/rasterpictureblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/barcodeblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/tableblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/textblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/block)[](/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks)[](/ja/fine-reader/engine/api-reference/layout-related-objects/vectorpictureblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/rasterpictureblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/checkmarkblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/checkmarkgroup)[](/ja/fine-reader/engine/api-reference/layout-related-objects/barcodeblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/block)[](/ja/fine-reader/engine/api-reference/layout-related-objects/tableblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/textblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/block)[](/ja/fine-reader/engine/api-reference/layout-related-objects/separatorblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/separatorgroup)[](/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks)[](/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks)[](/ja/fine-reader/engine/api-reference/document-related-objects/frpage)[](/ja/fine-reader/engine/api-reference/document-related-objects/frpages)[](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument)

<div id="linux-and-macos">
  ### Linux および macOS
</div>

<img src="https://mintcdn.com/abbyy/lsETHFYUFiongXSm/images/fine-reader/engine/layoutlinuxmac.gif?s=b17a4f40c3b3d7c9736d9d77586ec003" alt="LayoutLinuxMac" width="338" height="272" data-path="images/fine-reader/engine/layoutlinuxmac.gif" />[](/ja/fine-reader/engine/api-reference/layout-related-objects/vectorpictureblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/rasterpictureblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/barcodeblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/tableblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/textblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/block)[](/ja/fine-reader/engine/api-reference/layout-related-objects/block)[](/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks)[](/ja/fine-reader/engine/api-reference/layout-related-objects/separatorblock)[](/ja/fine-reader/engine/api-reference/layout-related-objects/separatorgroup)[](/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks)[](/ja/fine-reader/engine/api-reference/document-related-objects/frpage#layout)[](/ja/fine-reader/engine/api-reference/document-related-objects/frpage)[](/ja/fine-reader/engine/api-reference/document-related-objects/frpages)[](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument)

[オブジェクト図](/ja/fine-reader/engine/api-reference/object-diagram)

<div id="output-parameter">
  ## 出力パラメーター
</div>

このオブジェクトは、[Engine](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface)オブジェクトの[CreateLayoutFromStream](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/creation-methods/createlayoutfromstream-method)メソッドの出力パラメーターです。

<div id="samples">
  ## サンプル
</div>

<Accordion title="C# コード">
  ```csharp theme={null}
  FREngine.IFRDocument frdoc;
  // レイアウト内のブロックを走査します
  for (int iPage = 0; iPage < frDoc.Pages.Count; iPage++)
  {
   FREngine.IFRPage page = frDoc.Pages[iPage];
   FREngine.ILayout layout = page.Layout;
   int blocksCount = layout.Blocks.Count;
   for (int iBlock = 0; iBlock < blocksCount; iBlock++)
   {
    FREngine.IBlock block = layout.Blocks[iBlock];
    ...
   }
  }
  ```
</Accordion>

このオブジェクトは、次のコード サンプルで使用されます。

* Linux: [CustomLanguage](/ja/fine-reader/engine/guided-tour/samples#customlanguage)
* Windows: [CustomLanguage](/ja/fine-reader/engine/guided-tour/samples#customlanguage), [RecognizedTextProcessing](/ja/fine-reader/engine/guided-tour/samples#recognizedtextprocessing)、およびデモ ツール: [Engine Predefined Processing Profiles](/ja/fine-reader/engine/guided-tour/samples#engine_predefined_processing_profiles)

<div id="see-also">
  ## 関連項目
</div>

[Layout と Block の操作](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-layout-and-blocks)

[LayoutBlocks](/ja/fine-reader/engine/api-reference/layout-related-objects/layoutblocks)

[Properties の操作](/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)