- 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)
English (English) - Change language
TCommandID
Description
The command identifier.
Admissible values:
General
- CI_SubMenu - a submenu title
- CI_Separator - a separator
- CI_Undefined - an undefined command identifier
File menu commands
- CI_NewProject - New Project...
- CI_BrowseProject - Open Project...
- CI_BrowseWebProject - Open Project from Server...
- CI_CloseProject - Close Project
- CI_UploadProject - Upload Project to Server...
- CI_Save - Save
- CI_NewBatch - New Batch...
- CI_LoadImage - Load Images...
- CI_ScanImages - Scan Images...
- CI_ImportImage - Import Images...
- CI_Export - Export
- CI_ExportToFile - Export Data to Files
- CI_ExportImages - Export Images to Files
- CI_ExportToDB - Export to Database
- CI_RecentFiles - Open Recent Project
- CI_Exit - Exit ABBYY FlexiCapture 12
Edit menu commands
- CI_EditUndo - Undo
- CI_EditRedo - Redo
- CI_EditCut - Cut
- CI_EditCopy - Copy
- CI_EditPaste - Paste
- CI_EditClear - Delete
- CI_MergeDocuments - Merge Documents
- CI_SplitDocuments - Split Document
- CI_EditSelectAll - Select All
- CI_EditFind - Find...
- CI_EditFindNext - Find Next
- CI_MoveToNextItem - Next Document
- CI_MoveToPreviousItem - Previous Document
- CI_ImageClean - Despeckle Image
- CI_ImageInvert - Invert Image
- CI_ImageMirrorHorizontal - Flip Horizontally
- CI_ImageMirrorVertical - Flip Vertically
- CI_ImageRotate90 - Rotate 90° Clockwise
- CI_ImageRotate270 - Rotate 90° CounterclockWise
- CI_ImageRotate180 - Rotate 180°
- CI_ImageChangeResolution - Change Resolution
- CI_ExportImage - Save Image
Additional commands for a remote Verification station (Field verification):
- CI_EditDeleteAll - Delete All Characters
- CI_EditInsertLineBreak - Insert Line Break
- CI_VerificationMergeSymbols - Merge Characters
View menu commands
- CI_ShowTestBatches - Show Test Batches
- CI_ShowWorkBatches - Show Batches
- CI_ShowQueues - Show Queues
- CI_ShowDetails - Show Details
- CI_ShowThumbnails - Show Thumbnails
- CI_SetupDetailsView - Choose Details to View
- CI_DocModeImage - Document Editor in Image Mode
- CI_DocModeForm - Document Editor in Data Mode
- CI_DockImageOnTop - Image at Top of Document Editor
- CI_DockImageOnBottom - Image at Bottom of Document Editor
- CI_DocImageOnLeft - Image at Left of Document Editor
- CI_DocImageOnRight - Image at Right of Document Editor
- CI_DocImageUndocked - Undocked
- CI_DocErrorsOnTop - Errors at Top of Document Editor
- CI_DocErrorsOnBottom - Errors at Bottom of Document Editor
- CI_DocErrorsOnLeft - Errors at Left of Document Editor
- CI_DocErrorsOnRight - Errors at Right of Document Editor
- CI_ImageScalePageWidth - Fit Image to Width
- CI_ImageScalePageHeight - Fit Image to Height
- CI_ImageScaleWholePage - Best Image Fit
- CI_ImageScale400 - Scale Image to 400%
- CI_ImageScale200 - Scale Image to 200%
- CI_ImageScale100 - Scale Image to 100%
- CI_ImageScale75 - Scale Image to 75%
- CI_ImageScale50 - Scale Image to 50%
- CI_ImageScale25 - Scale Image to 25%
- CI_ImageScaleCustom - Custom Image Scale
- CI_ImageScaleZoomIn - Zoom Image In
- CI_ImageScaleZoomOut - Zoom Image Out
- CI_TextSizeLargest - Largest Data Text
- CI_TextSizeLarger - Larger Data Text
- CI_TextSizeMedium - Medium Data Text
- CI_TextSizeSmaller - Smaller Data Text
- CI_TextSizeSmallest - Smallest Data Text
- CI_ViewToolbarsLayout - Show Toolbar in Document Editor
- CI_ShowFormatErrorInBallon - Show Error Message for Active Field in Balloon
- CI_ShowFormatErrorInErrorView - Show Error Message for Active Field at Top
- CI_ShowFormatErrorInFormView - Show Error Message for Active Field at Bottom
- CI_BWImageMode - Show Images in Black and White
- CI_ThumbnailSizeSmallest - Smallest Thumbnail Size
- CI_ThumbnailSizeDefault - Default Thumbnail Size
- CI_ThumbnailSizeLargest - Largest Thumbnail Size
- CI_ThumbnailSizeIncrease - Increase Thumbnail Size
- CI_ThumbnailSizeDecrease - Decrease Thumbnail Size
- CI_ViewToolbarsStandard - Show/Hide Standard Toolbar
- CI_ViewToolbarsDocuments - Show/Hide View Toolbar
- CI_ViewToolbarsNavigation - Show/Hide Navigation Toolbar
- CI_ViewToolbarsScanAndRead - Show/Hide Scanning Toolbar
- CI_ViewToolbarsProjectSetup - Show/Hide Project Setup Toolbar
- CI_ViewToolbarsTasks - Show/Hide Queues Tasks Toolbar
- CI_ShowToolbar1 - Show Toolbars
- CI_ViewStatusbar - Show/Hide Status Bar
- CI_ViewFullScreen - Switch to Full Screen/Window
- CI_Refresh - Refresh
- CI_ViewProperties - Show Properties
Additional commands for a remote Verification station (Group verification):
- CI_ShowFieldImage - Show/Hide Field Image
- CI_ShowFieldImageOnTop - Show Field Image on Top
- CI_ShowFieldImageOnBottom - Show Field Image on Bottom
- CI_ShrinkToFit - Shrink Field Image to Fit
- CI_ContextImageScale400 - Scale Field Image 400%
- CI_ContextImageScale200 - Scale Field Image 200%
- CI_ContextImageScale150 - Scale Field Image 150%
- CI_ContextImageScale100 - Scale Field Image 100%
- CI_ContextImageScale75 - Scale Field Image 75%
- CI_ContextImageScale50 - Scale Field Image 50%
- CI_ShowCharacterImage - Show Character Image
- CI_ShowActionsToolBar - Show/Hide Actions Toolbar
- CI_ShowVerInfoBar - Show/Hide Verification Info Bar
- CI_VerificationOptions - Show Verification Preferences
Additional commands for a remote Verification station (Field verification):
- CI_ShowRecognizedText - Show Recognized Text
- CI_ShowSymbolImagesCutting - Show/Hide Character Images Cutting
- CI_ShowSpecialSymbols - Show/Hide Special Characters
- CI_ShowAnalogousFields - Show/Hide Analogous Field
Task menu commands
- CI_GetTask - Get Task
- CI_ReturnTask - Close Task
- CI_ShowTaskComment - Show Task Comment
- CI_CancelTask - Reject Task
- CI_DeferTask - Postpone Task
- CI_SendTaskToException - Send Task to Exceptions
- CI_SendTaskToRescan - Send Task to Rescanning Stage
- CI_SendTaskToStage - Send Task to Stage
- CI_AutoTaskReceive - Automatic Task Receive On/Off
- CI_AddDocsToMarked - Add Documents to Marked
- CI_UnmarksDocs - Unmark Documents
- CI_MarkDocsToException - Mark Documents to Send to Exceptions
- CI_MarkDocsToRescan -Mark Documents to Rescanning
- CI_MarkDocsToStage - Mark Documents to Stage
- CI_ViewMarkedGroupList - View Marked Groups List
Recognition menu commands
- CI_ApplyTemplate - Analyze
- CI_SetDocTemplate - Match Document Definition
- CI_ReadActive - Recognize
Verification menu commands
- CI_VerifyAll - Run Verification...
- CI_GotoNextError - Next Item to Verify
- CI_GotoPrevError - Previous Item to Verify
- CI_GotoNextAssembleError - Next Document with Assembly Error(s)
- CI_GotoPrevAssembleError - Previous Document with Assembly Error(s)
- CI_GotoNextUnkCharacher - Next Uncertain Character
- CI_GotoPrevUnkCharacher - Previous Uncertain Character
- CI_GotoNextRuleError - Next Rule Error
- CI_GotoPrevRuleError - Previous Rule Error
Additional commands for a remote Verification station (Group verification):
- CI_VerificationConfirmAll - Confirm All
- CI_VerificationPostponeAll - Postpone All
- CI_VerificationToggleSelected - Toggle Selected Item
- CI_VerificationNextPage - Next Verification Page
- CI_VerificationPrevPage - Previous Verification Page
- CI_VerificationClose - Close Verification
Additional commands for a remote Verification station (Field verification):
- CI_VerificationConfirmField - Confirm Field
- CI_VerificationNextUncertain - Next Uncertain Character
- CI_VerificationPrevUncertain - Previous Uncertain Character
- CI_VerificationNextField - Next Field
- CI_VerificationPrevField - Previous Field
Project menu commands
- CI_ShowTemplatesList - Show List of Document Definitions
- CI_ShowBatchTypes - Show Batch Types List
- CI_ShowImportProfiles - Show Import Profiles List
- CI_SwitchToAdminMode - Switch to Admin Mode
- CI_ProtectProject - Protect Project with Password
- CI_UnprotectProject - Unprotect Project
- CI_ExportProject - Export Project
- CI_ImportProject - Update Project
- CI_ViewProjectProperties - Show Project Properties
- CI_CreateTestCopy - Create Test Copy
- CI_CommitTestCopy - Commit Test Copy
- CI_DeleteTestCopy - Delete Test Copy
Tools menu commands
- CI_DocPriorityLowest - Set Lowest Document Priority
- CI_DocPriorityLow - Set Low Document Priority
- CI_DocPriorityNormal - Set Normal Document Priority
- CI_DocPriorityHigh - Set High Document Priority
- CI_DocPriorityHighest - Set Highest Document Priority
- CI_DocPriorityExtraHigh - Set Extra-High Priority for Document
- CI_UpdateDocToLatestVersion - Update Documents to Latest Version of Project
- CI_Reanalize - Reanalyze
- CI_Reread - Rerecognize
- CI_AssembleDocuments - Refresh Documents Assembly
- CI_RecheckRules - Recheck Rules
- CI_CheckBatchIntegrity - Check Batch Integrity
- CI_BatchPriorityLowest - Set Lowest Batch Priority
- CI_BatchPriorityLow - Set Low Batch Priority
- CI_BatchPriorityNormal - Set Normal Batch Priority
- CI_BatchPriorityHigh - Set High Batch Priority
- CI_BatchPriorityHighest - Set Highest Batch Priority
- CI_BatchPriorityExtraHigh - Set Extra-High Priority for Batch
- CI_ChangeBatchType - Change Batch Type
- CI_ViewOptions - Show Options
Commands of the field local menu
- CI_ExecuteCustomAction - Execute Custom Action
User commands
- CI_UserCommand - User commands
Help menu commands
- CI_HelpAbbyyWebSite - ABBYY Website
- CI_HelpAbout - About ABBYY FlexiCapture
- CI_HelpContent - Help Topics
- CI_HelpPurchaseInfo - How to Buy ABBYY Products
- CI_HelpSendFeedback - Send Feedback...
- CI_HelpTechSupport - Technical Support
9/15/2020 9:42:43 AM