AddNewDocument

操作

画像ファイルから新しい文書をバッチに追加します。

画像なしで文書を作成するには、ファイルパラメータを空のままにします (file.Name = "", file.Bytes = new bytes [0])。

excludeFromAutomaticAssemblingフラグをtrueに設定して新しい文書を作成します。このフラグは、文書がすでに組み込まれされており、バッチ型で指定されている組み込み設定がこの文書に適用されていないことを示します。

重要!追加された文書は、画像が前処理された後にのみアクセス可能になります。ProcessBatch方法を使用して文書を追加した後にバッチ処理を始めます。

PDF文書を追加しながら、テキスト層に格納されているテキストを使用する場合は、文書が処理されるプロジェクトでOCRの代わりにPDFテキストレイヤーを使用するオプションを選択します (ページプロパティダイアログボックスの処理タブにこのオプションがあります)。

定義

int AddNewDocument( int sessionId, Document document, File file, bool excludeFromAutomaticAssembling, int previousItemId );

パラメータ

名前 記述
sessionID int アプリケーションサーバーへの接続のID
document Document 作成されている文書の記述
file File 文書画像を含むファイル
excludeFromAutomaticAssembling bool

文書が文書組み込みから除外されているかを示すフラグ:

  • True - 文書は既に組み込まれているため、文書の組み込みには含まれません
  • False - 文書はバッチ型に指定された設定に従って組み込まれます
previousItemId int

セットの新しい文書の位置を明示的に指定するID:

  • -1 - 新しい文書はセットの最後に追加されます
  • 0 - 新しい文書はセットの先頭に追加されます
  • 文書ID - 新しい文書はこのID
    注:の文書の後に追加されます。このIDの文書は存在しなければなりません。

注:POSTリクエストを使用して文書画像を追加することもできます。追加には、空ファイルのある文書を、この方法で作成します (file.Name = "FileName", file.Bytes = new bytes [0])。次に、以下のパラメータでPOSTリクエストを実行します:

  • Action = Save
  • objectType = 0
  • objectId = documentId、ここではAddNewDocument方法で返されるdocumentId文書ID
  • version = 0
  • streamName = "C:\Temp\image.pdf"、ここではimage.pdfはAddNewDocument方法の呼び出し時に指定されたファイル名

戻り値

記述
int 作成された文書のID

25.05.2023 7:55:10

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.