IDocument
動作
文書を表します。
注:ローカルのルールチェックの場合、このオブジェクトの方法とプロパティの一部をウェブ検証ステーションで使用することはできません。サポート外の方法とプロパティには、アスタリスク(*)が付けられています。
メソッド
定義 | 説明 |
---|---|
AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) * |
ユーザーファイルを文書エクスポート結果に追加します。 sourceFileパラメータで、追加するユーザーファイルのアドレスを指定します。 注:プロジェクト設定でルートエクスポートパスを必ず指定してください。指定しないと、ユーザーファイルがファイル格納場所のバッチフォルダに置かれます。 destinationNameパラメータで、エクスポート先を指定します。 宛先で同じ名前の既存のファイルに上書きする場合は、replaceIfExistsパラメータをtrueに設定します。宛先で同じ名前の既存のファイルをそのまま残し、エラーメッセージをログに追加する場合は、replaceIfExistsパラメータをfalseに設定します。 |
CheckRules( ) * | 文書内のすべてのルールをチェックします。文書の書き込み権限が必要です。 |
Field( name : string ) :IField * |
フィールドへの完全なパスで文書フィールドへのアクセスを取得します。完全なパスが使用されます。 内部**フィールド。ルールでは使用できません。 |
HasField( name : string ) : bool * |
指定されたパスを持つフィールドが存在するかどうかを確認します。相対パスが使用されます。 内部**フィールド。ルールでは使用できません。 |
IndexedItemValue( name : string ) : VARIANT * | フィールド値を名前またはフィールドへのパスで取得します。文書やページの外部フィールドから利用できます。フィールド名とフィールドへの完全なパスの両方を使用できます。ルールでは使用できません。 |
IndexedItemValues( name : string ) :IVARIANTArray * | 文書定義内のフィールドに対応するインデックス値のセットを、フィールドの名前またはパスで取得します。反復セクションでフィールドがインデックスフィールドとしてマークされている場合、メソッドはすべてのセクションからフィールドのすべての値を返します。文書やページの外部フィールドから利用できます。フィールド名とフィールドへの完全なパスの両方を使用できます。ルールでは使用できません。 |
Property( name : string ) : VARIANT |
指定されたプロパティの値を名前で取得します。返される値は、文字列、数値または時刻の形式で指定できます。 プロパティ名と戻り値:
|
SaveAs( filename : string, [optional] options :IExportImageSavingOptions) * | 1ページまたは複数ページの文書の画像を保存します。保存オプションに保存フォーマットが指定されていない場合、画像は*.tifファイルに保存されます。これは内部**フィールド。 |
SaveAsStream( [optional] options:IExportImageSavingOptions) : byte[] * |
文書をメモリストリームに保存し、バイト配列(COM SafeArray)として返します。 注:JScriptとVBScriptは、この配列に対する反復をサポートしていません。 |
SaveXmlToFile( filename : string ) * | Web検証ステーションで使用する指定された場所に前処理を行わずにXMLファイルを文書の説明とともに保存します。 |
SaveXmlToFileStorage() * | Web検証ステーションで使用するファイルストレージに前処理を行わずに、XMLファイルを文書の説明とともに保存します。 |
重要!そのメソッPropertyドは、ユーザーが指定した文書プロパティを含むPropertiesコレクションと混同しないでください。
プロパティ
名前 | タイプ | アクセス | 説明 |
---|---|---|---|
Action * | IActionResult | 読み取り専用 | エクスポートとポストエクスポートスクリプトでのみ有効です。 |
AsBatchItem * | IBatchItem | 読み取り専用 | 文書をIBatchItemオブジェクトに変換します。 |
AssemblingErrors | IAssemblingErrors | 読み取り専用 | アセンブリエラーのコレクション。コレクションへのアクセスは常に読み取り専用です。 |
Attachments | IUserAttachments | 読み取り専用 | ユーザーの添付 |
Batch | IBatch | 読み取り専用 | バッチ文書のスクリプトのアクセス許可に関係なく、バッチへのアクセスは読み取り専用で、文書およびページの内部**フィールドは使用できません。 |
BatchName | string | 読み取り専用 | バッチ名 |
Children * | IFields | 読み取り専用 |
子フィールド(文書セクション)。プロパティSectionsセクションの順序は、文書定義での順序に対応します。反復セクションは1つのアイテムとして表され、インスタンスはそのアイテムのItemsメソッドを通じて使用できます。 内部**フィールド。ルールでは使用できません。 |
Comment | string | 読み取り/書き込み | 文書のコメント。 |
DefinitionName | string | 読み取り専用 |
文書定義の名前。 処理されていない文書や認識されない文書の場合、プロパティは空の文字列を返します。 |
DocumentDefinition | IDocumentDefinitionInfo | 読み取り専用 | 文書に一致する文書定義に関する詳細情報。 |
HasErrors | bool | 読み取り専用 | 文書にシングルフィールドエラーまたはマルチフィールドエラーがあるかどうかを指定します。 |
HasUnpreparedImages | bool | 読み取り専用 | 文書に前処理されていないページが含まれているかどうかを指定します。 |
HasWarnings | bool | 読み取り専用 | 文書にルールまたは書式警告があるかどうかを指定します。 |
ID | string | 読み取り専用 | 文書識別子(External ID)。値は1から始まり、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フィールドは使用されません。 |
Priority | TProcessingPriority | 読み取り専用 | 文書の優先度。 |
ProcessingErrors * | string | 読み取り専用 | 処理エラーを改行で割った値。 |
ProcessingWarnings * | string | 読み取り専用 | 警告を改行で区切って処理します。 |
ProhibitedUserId * | int | 読み取り専用 | 文書から作成されたタスクは、指定された識別子を持つユーザーが使用できません。デフォルトでは、値は「0」です。これは、タスクがすべてのユーザーに使用可能であることを意味します。 |
Properties | IProperties | 読み取り専用 | 文書の登録パラメータ。 |
RecognizedSymbolsCount * | int | 読み取り専用 | 認識されたシンボルの数。 |
RuleErrors * | IRuleErrors | 読み取り専用 |
文書エラーの集合(フォーマットエラー、ルールエラー、ダブル検証結果のマージエラー)。 注:開いている文書のみに使用できます。 |
Sections * | IFields | 読み取り専用 |
文書セクションのフラットリスト。反復セクションがある場合、そのセクションにはすべての複製がリストに含まれます。リストのセクションは、文書セクションの最初のページと同じ順序で表示されます。ページのないセクションがリストを閉じます。 内部**フィールド。ルールでは使用できません。 |
StageInfo | IStageInfo | 読み取り専用 | アプリケーションサーバー上の処理ステージに関する情報。 |
SymbolsForVerificationCount | int | 読み取り専用 | 検証が必要なシンボルの数。 |
TotalSymbolsCount | int | 読み取り専用 | シンボルの総数。 |
UncertainSymbolsCount | int | 読み取り専用 | 不確実なシンボルの数。 |
4/12/2024 6:16:06 PM