IDocument - ABBYY Documentation

機能

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

メソッド


AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) *	ユーザーファイルをドキュメントのエクスポート結果に追加します。 sourceFile パラメーターには、追加するユーザーファイルのパスを指定します。注: プロジェクト設定でルートのエクスポートパスを必ず指定してください。指定しない場合、ユーザーファイルはファイルストレージ上のバッチフォルダーに配置されます。 destinationName パラメーターには、エクスポート先を指定します。保存先に同名の既存ファイルがある場合に上書きするには、replaceIfExists パラメーターを true に設定します。保存先に同名の既存ファイルを保持し、ログにエラーメッセージを追加するには、replaceIfExists パラメーターを false に設定します。
CheckRules( ) *	ドキュメント内のすべてのルールをチェックします。ドキュメントに対する書き込み権限が必要です。
Field( name : string ) : IField *	field へのフルパスを指定して、ドキュメントのfieldにアクセスします。フルパスを使用します。これは内部**fieldです。ルールでは使用できません。
HasField( name : string ) : bool *	指定したパスを持つfieldが存在するかどうかを確認します。相対パスを使用します。これは内部**fieldです。ruleでは使用できません。
IndexedItemValue( name : string ) : VARIANT *	field 名または field へのパスを指定して、field の値を取得します。文書およびページの External fields で使用できます。field 名と field への完全パスのどちらも使用できます。ルールでは使用できません。
IndexedItemValues( name : string ) : IVARIANTArray *	name または field へのパスを指定して、Document Definition 内の該当する field のインデックス値の集合を取得します。field が繰り返しセクション内でインデックス field としてマークされている場合、このメソッドはすべてのセクションにあるその field の値をすべて返します。Document およびページの External fields から使用できます。field 名とフルパスのどちらも使用できます。ルールでは使用できません。
Property( name : string ) : VARIANT	指定した名前のプロパティ値を取得します。返される値は、string、数値、または時刻の形式です。プロパティ名と返される値は次のとおりです。 Exported - 文書がエクスポートされた日時 ExportedBy - 文書をエクスポートしたユーザー Created - 文書が作成された日時 CreatedBy - 文書を作成したユーザー Recognized - 文書が認識された日時 RecognizedBy - 文書を認識したユーザー Modified - 文書が最後に変更された日時 ModifiedBy - 文書を変更したユーザー TotalSymbolsCount - シンボルの総数 UncertainSymbolsCount - 不確実なシンボルの総数 RecognizedSymbolsCount - 認識されたシンボルの数 Comment - 文書のコメント ProcessingErrors - 文書処理エラー ProcessingWarnings - 文書処理に関する警告 Verified - 文書のフィールドが最後に手動で編集された日時 VerifiedBy - 文書のフィールドに最後の手動変更を加えたユーザー (Processing Stations からの情報は保存されません)
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) *	1 ページまたは複数ページ文書の画像を保存します。保存オプションで保存形式が指定されていない場合、画像は .tif ファイルとして保存されます。これは内部 * field です。
SaveAsStream( [optional] options: IExportImageSavingOptions) : byte[] *	ドキュメントをメモリストリームに保存し、バイト配列 (COM SafeArray) として返します。注: JScript と VBScript は、この配列の反復処理に対応していません。
SaveXmlToFile( filename : string ) *	Web Verification Station で使用するため、前処理前のドキュメントの説明を含む XML ファイルを指定した場所に保存します。
SaveXmlToFileStorage() *	前処理前のドキュメントの説明を含む XML ファイルを、Web Verification Station で使用するためにファイルストレージへ保存します。

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

プロパティ


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

** - 内部fieldを使用するには、オブジェクトをメモリにロードする必要があります。

​機能

​メソッド

​プロパティ

機能

メソッド

プロパティ