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

IFlexiCaptureTools

Назначение

Глобальный объект FCTools, реализующий данный интерфейс, доступен из скриптов. Все методы глобального объекта FCTools можно вызывать как статические, например:

FCTools.ShowMessage( “Test” );
    

Замечание. Для некоторых методов и свойств объекта не поддерживается локальная проверка правил на Веб-станции Верификации. Не поддерживаемые методы и свойства отмечены звездочкой (*).

Методы

Определение Описание
ClassifyPage( page : IPage, [optional] callback : IProcessingCallback, [optional] detectClassesWithoutLayout : bool ) : IPageClassificationResult *

Классифицирует страницу и, если операция была успешной, возвращает результат классификации. Результатом классификации может быть имя класса из классификатора в типе пакетов или пустое значение.

Данный метод может использоваться в следующих случаях:

  • требуется классифицировать страницы и в соответствии с результатами классификации экспортировать их в разные папки в PDF с возможностью поиска; распознавание и наложение определений документов при этом не требуется;
  • в зависимости от результатов классификации требуется выполнить какие-либо действия с документами до распознавания (например, скорректировать ориентацию страниц).

Замечание. Если параметр detectClassesWithoutLayout не указан, его значение считается равным false. Если значение параметра равно true, то при классификации используются только классы из классификатора без учета имеющихся определений документов.

Замечание. Вы можете либо использовать имеющийся интерфейс IProcessingCallback, либо реализовать этот интерфейс самостоятельно.

IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool * Проверяет, разрешен ли указанный модуль лицензией.
LoadImage( filePath : string, [optional] pageNumber : int ) : IEditablePictureObject * Загружает из файла изображение, которое в дальнейшем можно редактировать. Если не указан параметр pageNumber, его значение считается равным 1.
NewImageSavingOptions() : IExportImageSavingOptions * Создаёт новый объект типа IExportImageSavingOptions.
PictureFromHBitmap( bitmap : HBITMAP, [optional] resolution : int ) : IEditablePictureObject *

Создает из объекта HBITMAP изображение с указанным разрешением, доступное для дальнейшего редактирования. Если параметр resolution не указан, разрешение определяется автоматически.

Пример кода

Замечание. Так как объект HBITMAP берется во владение, для него не нужно вызывать метод CloseHandle после генерации изображения.

Rect( left : int, top : int, right : int, bottom : int ) : string Генерирует по координатам строку, представляющую прямоугольник.
ShowMessage( text : string, [optional] isError : bool ) Показывает сообщение пользователю. Если значение флага isError равно true, будет показано сообщение об ошибке, иначе будет показана нотификация. Если параметр isError не указан, его значение считается равным false. Если данный скрипт выполняется внутри какого-либо процесса обработки, то сообщение запишется в лог процесса обработки.

В отличие от использования классификатора, метод ClassifyPage определяет класс страницы, но не применяет к странице результат классификации. Например, если классификатор не содержит определение документа Banking_eng, метод ClassifyPage может вернуть для страницы раздел данного определения документа.

Свойства

Имя Тип Права Значение
CurrentUserSession * IUserSessionInfo Только чтение Возвращает информацию о текущей сессии пользователя, работающего на Станции Обработки. При верификации возвращает информацию о сессии пользователя, выполняющего верификацию (в т.ч. удаленно).
ScriptContext * IScriptDefinitionContext Только чтение Предоставляет доступ к объекту, внутри которого скрипт был написан. Данное свойство позволяет получить доступ к проекту независимо от того, какие параметры приходят на вход скрипту.

11/10/2020 12:08:08 PM


Please leave your feedback about this article