- Introducing ABBYY FlexiCapture
- ABBYY FlexiCapture architecture
-
Using scripts in ABBYY FlexiCapture
- Specifics of scripts written in .Net languages
- External assemblies
- Script editor
- Object model
-
Scripts for customizing processing stages
-
Types of scripts
- Script rule
- Autocorrection script
- Export script
- User script (custom action)
- Document assembly script
- Custom recognition script
- Stage rule
- Processing scripts
- Data set update script
- Data set validation scripts
- Document classification script
-
Event handlers
- Batch created
- Batch deleted
- Batch parameter change
- Batch structure change (page added/page deleted/document added/document deleted)
- Pages moved
- Batch opened/closed
- Batch integrity check
- Document parameter changed
- Document state changed
- Export completed
- Script that is run after rule checks
- Before matching
- Field verification request
-
Objects
- IActionResult
- IAssemblingError
- IAssemblingErrors
- IBatch
- IBatchCheckResults
- IBatchItem
- IBatchItems
- IBatchTypeClassifier
- IBatchTypeClassifierResult
- IBinarizationParams
- IBoxedBoolean
- ICharacterParams
- ICharactersParams
- ICheckmarkGroupValue
- ICheckmarkValue
- IDataSet
- IDataSetQuery
- IDataSetRecord
- IDocument
- IDocuments
- IDocumentExportResults
- IDocumentsExportResults
- IDocumentDefinitionInfo
- IDocumentDefinitionInfoArray
- IEditablePictureObject
- IExportFieldsToRedact
- IExportImageSavingOptions
- IField
- IFieldRegion
- IFieldRegions
- IFields
- IFlexiCaptureTools
- ILocalContrastParams
- IMatchedSectionInfo
- IMatchingInfo
- IPage
- IPageClassificationResult
- IPages
- IPictureObject
- IPictureObjectsInfo
- IPrincipal
- IPrincipals
- IProcessingCallback
- IProject
- IProperties
- IProperty
- IPropertyModificationInfo
- IRecordCheckResult
- IRecordset
- IRect
- IRects
- IRoutingRuleResult
- IRuleContext
- IRuleError
- IRuleErrors
- IRuleTag
- IRuleTags
- IScriptBinaryAttributes
- IScriptDefinitionContext
- ISectionDefinitionInfo
- ISectionDefinitionInfoArray
- IShadowsHighlightsParams
- IStageInfo
- IUserAttachment
- IUserAttachments
- IUserSessionInfo
- IValue
- IVARIANTArray
- TAssemlingErrorType
- TBatchItemType
- TColorToFilter
- TExportFieldType
- TExportType
- TImageCompressionType
- TPageClassificationType
- TPdfAVersion
- TPdfDocumentInfoType
- TPdfTextSearchAreaType
- TPrincipalType
- TProcessingPriority
- TPropertyType
- TRuleErrorType
- TStateType
- Sample scripts
- Internal names of recognition languages
-
Types of scripts
-
Scripts for processing interface events
-
Event handlers
- On Document Closed
- On Project Closed
- On Activate Document
- On Field Control Activate
- On Return From Task
- On User Command
- On Field Control Deactivate
- On Closing Document
- On Task Close
- On Closing Project
- On Region Change
- On Task Window Mode Changed
- On Open Document
- On Task Window Create
- On Task Reject
- On Region Control Draw
- On Task Send To Stage
- On Text Field Validating
-
Objects
- IBoolean
- IBoxedFieldControl
- IDocumentEditor
- IDocumentItem
- IDocumentItems
- IDocumentsCollection
- IDocumentsWindow
- IDrawContext
- IErrorControl
- IErrorControls
- IErrorsWindow
- IFieldControl
- IFieldRegionControl
- IFieldRegionControls
- IFormWindow
- IImageWindow
- IMainMenu
- IMainWindow
- IMenu
- IMenuItem
- IPageControl
- IPageItem
- IPageItems
- IPagesCollection
- IPoint
- ISelection
- IShellRational
- IShellRect
- IShellRects
- ITaskWindow
- ITextEditor
- IToolbar
- IToolbarButton
- IToolbars
- TCommandBarType
- TCommandID
- TDockingType
- TDocumentState
- TErrorType
- TSelectionType
- TTaskWindowMode
- TTextSize
- TUserRole
- TWorkWindowType
-
Event handlers
- User script for Web Verification Station
-
Application Programming Interface (API)
- About the ABBYY FlexiCapture Application Server Web Services API
- Using the Web Services API of the ABBYY FlexiCapture Application Server
-
References
- API Methods
- Data types
- Working with files
- Web Services Mobile API
- Web Services for user account management
- Examples of API Use
- Integrating Web Stations into third-party systems
- Configuring additional settings and customizing Web Stations
- Custom reports
-
Appendix
- Supported recognition languages
- Fonts for correct characters rendering
- Supported text types
- Supported barcode types
- Supported input formats
- Export file formats
- Date formats
- Alphabet used in regular expressions
- Protecting Document Definitions and additional modules
- Glossary
- Patents
- Third-party technologies
- Technical support
- End-User License Agreement (EULA)
IPictureObject
What it does
Represents the image of a page or a region.
The object implements the IPicture interface and provides access to some of its properties through the IDispatch interface.
For more details about the IPicture interface, see the corresponding article at MSDN.
Note. This object is not available on the Web Verification Station for checking rules locally.
Methods
Definition | Description |
AnalyzePageObjects( [optional] reserved: Object ) : IPictureObjectsInfo | Defines objects on the page and returns the parameters of the page as seen by the recognition module. Some delay in the operation is possible. |
CalcSuitabilityForOCR(): float |
Shows how suitable is an image for OCR. Possible values are from 0.0 to 1.0. ExampleThis script records results of method's operation for the selected documents to a page comment by clicking a user button: foreach( IDocument doc in MainWindow.Selection.Documents ) { MainWindow.TaskWindow.OpenDocument( doc ); foreach( IPage page in doc.Pages ) { IPictureObject picture = page.Picture; double score = (double)picture.CalcSuitabilityForOCR(); bool verdict = (bool)picture.IsSuitableForOcr(); page.Comment = score.ToString( "0.0000" ) + " / " + verdict.ToString(); } } |
CreateEditableCopy() : IEditablePictureObject | Creates an editable copy of the image. |
DetectPageOrientation( [optional] language: string ) : int | Detects page orientation by the text on it. The internal name of the language is passed as the input parameter. If the language is not specified, the language of the current locale is used. Returns the angle (in degrees) to which the page must be rotated. The following values can be returned: 0, 90, 180 and 270. |
IsPhoto(): bool | Shows whether an image is a photo. |
IsSuitableForOcr(): bool | Shows whether an image is suitable for OCR. |
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) | Saves the image. If no options are specified, the image is saved as *.tif. |
Properties
Name | Type | Access | Description |
Handle | OLE_HANDLE | Read-only |
The Windows GDI handle of the picture. In .Net this property can be used in System.Drawing.Image.FromHbitmap method to retrieve the picture object. |
Height | int | Read-only | The height of the picture in dots |
hPal | OLE_HANDLE | Read/write, Mutable (can be modified even in scripts with read-only permissions) |
The Windows handle of the palette used by the picture. This property can be used in System.Drawing.Image.FromHbitmap as a second parameter. |
IsBlackWhite | bool | Read-only | Whether the picture is black-and-white. |
IsColor | bool | Read-only | Whether the picture is color. |
IsGrayscale | bool | Read-only | Whether the picture is grayscale. |
Type | SHORT | Read-only | The type of picture. |
Width | int | Read-only | The width of the picture in dots |
XResolution | int | Read-only | The horizontal image resolution |
YResolution | int | Read-only | The vertical image resolution |
14.01.2021 14:17:18