IDocument

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

Document を表します。

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

​

メソッド

メソッド	説明
AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) *	ユーザーファイルをドキュメントのエクスポート結果に追加します。sourceFile パラメーターには、追加するユーザーファイルのパスを指定します。プロジェクト設定でルートのエクスポート パスを必ず指定してください。指定しない場合、ユーザーファイルはファイルストレージの場所にあるバッチフォルダーに配置されます。destinationName パラメーターには、エクスポート先を指定します。replaceIfExists パラメーターを true に設定すると、エクスポート先に同名のファイルが存在する場合は上書きされます。false に設定すると、同名の既存ファイルを保持し、ログにエラーメッセージを追加します。
CheckRules( ) *	ドキュメント内のすべてのルールをチェックします。ドキュメントへの書き込み権限が必要です。
Field( name : string ) : IField *	field の完全パスを使用して、ドキュメントの field にアクセスします。完全パスを使用します。これは、オブジェクトをメモリにロードする必要がある内部 field です。ルールでは使用できません。
HasField( name : string ) : bool *	指定したパスの field が存在するかどうかをチェックします。相対パスを使用します。これは、オブジェクトをメモリにロードする必要がある内部 field です。ルールでは使用できません。
IndexedItemValue( name : string ) : VARIANT *	field 名または field へのパスを指定して field の値を取得します。ドキュメントおよびページの External fields から使用できます。field 名と field への完全パスのどちらも使用できます。ルールでは使用できません。
IndexedItemValues( name : string ) : IVARIANTArray *	field 名または field へのパスを指定して、Document Definition 内の field に対応するインデックス値のセットを取得します。繰り返しセクション内の field がインデックス field としてマークされている場合、このメソッドはすべてのセクションからその field のすべての値を返します。ドキュメントおよびページの External fields から使用できます。field 名と field への完全パスのどちらも使用できます。ルールでは使用できません。
Property( name : string ) : VARIANT	指定したプロパティの値を名前で取得します。返される値は文字列、数値、または時刻です。プロパティ名の一覧については、ドキュメントのプロパティ名を参照してください。
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) *	1ページまたは複数ページ文書の画像を保存します。保存オプションで保存形式が指定されていない場合、画像は *.tif ファイルとして保存されます。これは、オブジェクトをメモリにロードする必要がある内部 field です。
SaveAsStream( [optional] options : IExportImageSavingOptions ) : byte[] *	ドキュメントをメモリストリームに保存し、バイト配列 (COM SafeArray) として返します。JScript および VBScript では、この配列を反復処理できません。
SaveXmlToFile( filename : string ) *	前処理なしのドキュメントの説明を含む XML ファイルを、Web Verification Station で使用するために指定した場所に保存します。
SaveXmlToFileStorage( ) *	前処理なしのドキュメントの説明を含む XML ファイルを、Web Verification Station で使用するためにファイルストレージに保存します。

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

​

プロパティ

名前	型	アクセス	説明
Action *	IActionResult	読み取り専用	エクスポート スクリプトおよびエクスポート後スクリプトでのみ有効です。
AsBatchItem *	IBatchItem	読み取り専用	文書を IBatchItem オブジェクトに変換します。
AssemblingErrors	IAssemblingErrors	読み取り専用	アセンブリ エラーのコレクションです。コレクションへのアクセスは常に読み取り専用です。
Attachments	IUserAttachments	読み取り専用	ユーザー添付ファイル。
Batch	IBatch	読み取り専用	バッチ。文書に対するスクリプトの権限にかかわらず、バッチへのアクセスは読み取り専用で、文書およびページの内部 field にはアクセスできません。
BatchName	string	読み取り専用	バッチ名。
Children *	IFields	読み取り専用	子 field (ドキュメント セクション) 。Sections プロパティとは異なり、セクションの順序は Document Definition 内の順序と一致します。繰り返しセクションは1つのアイテムとして表され、各インスタンスにはそのアイテムの Items メソッドからアクセスできます。これは、オブジェクトをメモリに読み込む必要がある内部 field です。ルールでは使用できません。
Comment	string	読み取り/書き込み	文書のコメント。
DefinitionName	string	読み取り専用	Document Definition の名前。未処理または未認識の文書の場合、このプロパティは空の文字列を返します。
DocumentDefinition	IDocumentDefinitionInfo	読み取り専用	文書に一致する Document Definition の詳細情報。
HasErrors	bool	読み取り専用	文書に単一 field または複数 field のエラーがあるかどうかを示します。
HasUnpreparedImages	bool	読み取り専用	文書に前処理されていないページが含まれているかどうかを示します。
HasWarnings	bool	読み取り専用	文書にルールまたは形式に関する警告があるかどうかを示します。
Id	string	読み取り専用	文書識別子 (External Id) 。値は1から始まり、バッチ内でのみ一意です。
Index	int	読み取り専用	バッチ内の文書のインデックス。値は0から始まり、タスク内でのみ一意です。
IsAnalyzed	bool	読み取り専用	文書が解析済みかどうかを示します。文書内のすべてのページが解析されている場合、文書は解析済みと見なされます。
IsAssembled	bool	読み取り専用	文書が組み立てられているかどうかを示します。
IsExcludedFromAutomaticAssembling	bool	読み取り/書き込み	文書が自動アセンブリから除外されているかどうかを示します。
IsExported	bool	読み取り専用	文書がエクスポート済みかどうかを示します。
IsRecognized	bool	読み取り専用	文書が認識済みかどうかを示します。文書内の各ページが認識済みであるか添付ページである場合、文書は認識済みと見なされます。
IsUsedForTraining	bool	読み取り/書き込み	文書が学習に使用されているかどうかを示します。
IsVerified	bool	読み取り専用	文書が検証済みかどうかを示します。
Pages	IPages	読み取り専用	文書ページ。
PreviousStageInfo *	IStageInfo	読み取り専用	文書の処理ステージを示す IStageInfo オブジェクトを返します。TaskId および PrincipalId field は使用されません。
Priority	TProcessingPriority	読み取り専用	文書の優先度。
ProcessingErrors *	string	読み取り専用	改行で区切られた処理エラー。
ProcessingWarnings *	string	読み取り専用	改行で区切られた処理警告。
ProhibitedUserId *	int	読み取り専用	文書から作成されたタスクは、指定された識別子を持つユーザーには使用できません。デフォルト値は 0 で、この場合タスクはすべてのユーザーが使用できます。
Properties	IProperties	読み取り専用	文書の登録パラメーター。
RecognizedSymbolsCount *	int	読み取り専用	認識された文字数。
RuleErrors *	IRuleErrors	読み取り専用	ドキュメント エラー (フォーマット エラー、ルール エラー、二重検証結果のマージ時のエラー) のコレクション。開いているドキュメントでのみ使用できます。
Sections *	IFields	読み取り専用	ドキュメント セクションのフラットなリスト。繰り返しセクションがある場合、リストにはそのすべての繰り返しが含まれます。リスト内のセクションは、ドキュメント セクションの先頭ページと同じ順序で並びます。ページのないセクションはリストの末尾に配置されます。これは、オブジェクトをメモリにロードする必要がある内部 field です。ルールでは使用できません。
StageInfo	IStageInfo	読み取り専用	Application Server 上の処理ステージに関する情報。
SymbolsForVerificationCount	int	読み取り専用	検証が必要な文字数。
TotalSymbolsCount	int	読み取り専用	文字の総数。
UncertainSymbolsCount	int	読み取り専用	不確実な文字数。

​

Document プロパティ名

Property メソッドは、次のプロパティ名に対応する値を取得します。

名前	返される値
Exported	文書がエクスポートされた日時
ExportedBy	文書をエクスポートしたユーザー
Created	文書が作成された日時
CreatedBy	文書を作成したユーザー
Recognized	文書が認識された日時
RecognizedBy	文書を認識したユーザー
Modified	文書が最後に変更された日時
ModifiedBy	文書を変更したユーザー
TotalSymbolsCount	文字の総数
UncertainSymbolsCount	不確かな文字の総数
RecognizedSymbolsCount	認識された文字数
Comment	文書のコメント
ProcessingErrors	文書処理エラー
ProcessingWarnings	文書処理の警告
Verified	文書の field が最後に手動で編集された日時
VerifiedBy	文書の field を最後に手動で変更したユーザー (Processing Stations からの情報は保存されません)