Russian (Русский) - Change language

AddNewDocument

Назначение

Добавляет в пакет новый документ из файла с изображением.

Для создания документа без изображения используйте пустой параметр file (file.Name = "", file.Bytes = new bytes [0]).

Новый документ создается с параметром excludeFromAutomaticAssembling, имеющим значение true. Данный параметр указывает, что документ уже собран и к нему не будут применяться настройки сборки, указанные для типа пакета.

Внимание! Добавленные документы будут доступны только после предварительной обработки изображений. Для этого после добавления документов необходимо запустить обработку с помощью метода ProcessBatch.

Замечание. При добавлении в пакет нового документа поле Id соответствующего объекта должно быть заполненным.  

Для того чтобы в документах PDF учитывался текстовый слой, необходимо чтобы в проекте, в который загружаются эти документы был включен чекбокс Использовать текстовый слой PDF вместо OCR
(на вкладке Обработка диалога Свойства страницы).

Определение

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

Параметры

Название Тип Значение
sessionId int Идентификатор сессии подключения к Серверу Приложений
document Document

Описание создаваемого документа.

Рекомендуется добавлять документы с заранее заданным полем Id

file File Файл, содержащий изображение документа.
excludeFromAutomaticAssembling bool

Признак исключения документа из процесса сборки документов:

  • True - документ уже собран, в процессе сборки не участвует;
  • False - документ будет собран в соответствии с настройками, указанными для типа пакета.
previousItemId int

Идентификатор, позволяющий явно указать позицию нового документа в комплекте:

  • -1 - новый документ будет добавлен в конец коллекции;
  • 0 - новый документ будет добавлен в начало коллекции;
  • Id документа - новый документ будет добавлен после указанного.
    Замечание. Документ с указанным идентификатором должен существовать.

Замечание. Также файл с изображением документа можно добавить с помощью POST-запроса. Для этого с помощью данного метода создайте документ с пустым файлом (file.Name = "FileName", file.Bytes = new bytes [0]). Далее загрузите изображение с помощью POST-запроса со следующими параметрами:

  • Action = Save
  • objectType = 0
  • objectId = documentId, где documentId – идентификатор документа, возвращенный методом AddNewDocument
  • version = 0
  • streamName = "C:\Temp\image.pdf", где image.pdf – имя файла, указанное при вызове метода AddNewDocument

Возвращаемое значение

Тип Значение
int Идентификатор созданного документа

11/10/2020 12:08:08 PM


Please leave your feedback about this article