XMLExportParams オブジェクト (IXMLExportParams インターフェイス)

ABBYY FineReader Engine API の XMLExportParams オブジェクト (IXMLExportParams インターフェイス) — ABBYY_Scheme_XML.xsd スキーマに従って認識されたテキストの XML 形式へのエクスポートを調整する、ファイル/メモリに保存可能な永続オブジェクト。

このオブジェクトは、認識されたテキストを XML 形式でエクスポートする際のパラメーターを調整する機能を提供します。このオブジェクトへのポインターは入力パラメーターとしてエクスポート メソッドに渡されるため、エクスポート結果に影響します。この型の新しく作成されたオブジェクトのすべてのプロパティには、適切な既定値が設定されています。各プロパティの既定値の詳細については、対応するプロパティの説明を参照してください。

XML スキーマは、ABBYY_Scheme_XML.xsd ファイルにあります。

このファイルは、macOS では Headers フォルダーに、Linux および Windows では Inc フォルダーにあります (Windows の場合: Start > Programs > ABBYY FineReader Engine 12 > Installation Folders > Include Files Folder) 。XML タグの説明については、XML Schema Description を参照してください。

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

Linux: SaveToFile、および LoadFromFile

Windows: SaveToFile、LoadFromFile、SaveToMemory、および LoadFromMemory。

​

プロパティ

Name	Type	Description
Application	Engine, 読み取り専用	Engine オブジェクトを返します。
WriteCharacterRecognitionVariants	VARIANT_BOOL	文字認識候補のコレクションを XML 形式のファイルに書き込むかどうかを指定します。WriteCharAttributes プロパティが XCA_None の場合、このプロパティは無視されます。 コレクションに複数の要素を含められるのは、認識時に IRecognizerParams::SaveCharacterRecognitionVariants プロパティが TRUE に設定されていた場合のみです。詳細については、Using Voting API を参照してください。 このプロパティの既定値は FALSE です。
WriteCharAttributes	XMLCharAttributesEnum	XML 形式のファイルに保存する文字属性を指定します。このプロパティの既定値は XCA_None です。
WriteCharFormatting	VARIANT_BOOL	文字の書式を XML 形式のファイルに保存するかどうかを指定します。このプロパティの既定値は FALSE です。
WriteNondeskewedCoordinates	VARIANT_BOOL	XML 形式のファイルに保存される文字座標を、傾き補正前の画像平面上の座標にするかどうかを指定します。このプロパティの既定値は TRUE です。
WriteParagraphStyles	VARIANT_BOOL	段落スタイルおよびフォントスタイルの Parameter を XML 形式のファイルに書き込むかどうかを指定します。XML から段落の役割に関する情報を取得したい場合に、このプロパティが役立つことがあります。このプロパティの既定値は FALSE です。
WriteWordRecognitionVariants	VARIANT_BOOL	単語認識候補のコレクションを XML 形式のファイルに書き込むかどうかを指定します。 コレクションに複数の要素を含められるのは、認識時に IRecognizerParams::SaveWordRecognitionVariants プロパティが TRUE に設定されていた場合のみです。詳細については、Using Voting API を参照してください。 このプロパティの既定値は FALSE です。

​

メソッド

名前	説明
CopyFrom	現在のオブジェクトのプロパティを、別のオブジェクトの対応するプロパティの値で初期化します。
LoadFromFile	ディスク上のファイルからオブジェクトの内容を復元します。
LoadFromMemory 注: Windows のみ。	グローバル メモリからオブジェクトの内容を復元します。
SaveToFile	オブジェクトの内容をディスク上のファイルに保存します。
SaveToMemory 注: Windows のみ。	オブジェクトの内容をグローバル メモリに保存します。

​

出力Parameter

このオブジェクトは、Engineオブジェクトの CreateXMLExportParams メソッドの出力Parameterです。

​

入力Parameter

このオブジェクトは、次のメソッドの入力Parameterとして渡されます。

• Export、ExportPages、ExportToMemory：FRDocument オブジェクトのメソッド

• Export：FRPage オブジェクトのメソッド

• RecognizeImageFile：Engine オブジェクトのメソッド

• OnExportPages：Windows Visual Components 用 IDocumentViewerEvents インターフェイスのメソッド

• OnSendToPages：Windows Visual Components 用 IDocumentViewerEvents インターフェイスのメソッド

​

サンプル

このオブジェクトは、以下のコードサンプルで使用されています: CommandLineInterface (Windows および Linux)

​

関連項目

Export Parameter の調整

プロファイルの操作

プロパティ の操作