IBatch
Назначение
Служит для представления пакета.
Замечание. Для некоторых методов и свойств объекта не поддерживается локальная проверка правил на Веб-станции Верификации. Не поддерживаемые методы и свойства отмечены звездочкой (*).
Методы
Внимание! Методы ниже требуют права на модификацию структуры пакета. Эти методы могут быть вызваны только из скрипта обработки пакета.
Определение | Описание |
CleanRecognitionResults( document : IDocument ) * | Удаление результатов распознавания документа. |
CreateDocumentFromPage( targetPosition : int, page : IPage ): IDocument * |
Извлечение страницы из документа для создания на ее основе нового документа. В параметре targetPosition задается индекс создаваемого документа в пакете. Этот параметр может принимать значения от 0 до N включительно, где N – количество документов в пакете. При вызове метода CreateDocumentFromPage:
Пример |
CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage * |
Создает страницу из объекта IPictureObject и возвращает созданную страницу:
|
DeleteDocument( document : IDocument ) * | Удаление документа. |
DeletePage( page : IPage ) * | Удаление страницы. |
MoveDocument( source : IDocument, targetPosition : int ) * | Перемещение документа в указанную позицию в пакете. |
MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, int targetPageIndex : int ) * | Перемещение страницы с индексом "sourcePageIndex" из документа "source" в документ "target" в позицию "targetPageIndex". |
Свойства
Имя | Тип | Права | Значение |
AsBatchItem * | IBatchItem | Только чтение | Преобразовывает в элемент типа IBatchItem. |
Attachments | IUserAttachments | Только чтение | Пользовательские файлы вложений. |
BatchTypeName | string | Только чтение | Имя типа пакета. |
Comment | string | Чтение/запись | Комментарий. |
CreatedBy | IPrincipal | Только чтение | Автор созданного пакета. |
CreationDate | DateTime | Только чтение | Время создания пакета. |
Documents | IDocuments | Только чтение | Документы пакета. |
Id | int | Только чтение | Идентификатор пакета. Уникален в пределах проекта. |
Name | string | Чтение/запись | Имя пакета. |
Priority | TProcessingPriority | Чтение/запись | Приоритет пакета. |
Project | IProject | Только чтение | Проект, содержащий пакет. |
Properties | IProperties | Только чтение | Именованные параметры пакета. |
SlaExpirationDate | DateTime | Чтение/запись | Крайний срок обработки пакета. |
SlaStartDate | DateTime | Чтение | Время начала обработки пакета. |
SlaWarningPeriod * | Int | Чтение/запись | Начало периода, в течение которого будет показано предупреждение о приближении крайнего срока обработки пакета, задается в минутах от окончания периода обработки пакета |
StageInfo | IStageInfo | Только чтение | Возвращает объект IStageInfo - информацию об этапе обработке документа. Поля TaskId, PrincipalId не используются. |
13.04.2021 11:12:44