Capture control properties
You can open a capture form and view the properties.
You can configure an activity in the process and generate an activity form for the process you configured.
When you configure the action such as .Net method, the following properties are available for a form control for mapping to the parameters.
Properties |
Description |
---|---|
These properties are for internal use only. |
|
SessionId |
Internal ID for the current batch loaded into the control (it is not the normal user session ID). |
FolderType |
Type assigned to the folder loaded in the Capture composite control. |
Folder |
Folder object loaded in the Capture composite control. |
DocumentType |
Type assigned to the document currently loaded in the Capture composite control. |
Document |
The document currently loaded in the Capture composite control. |
AssociatedDocTypes |
Contains a collection of document types that are available for classifying the document. |
Permissions |
Returns JavaScript object with properties that indicate the current user's permission, such as "allow annotation", "allow delete page", and more. |
RejectionReasons |
Returns JavaScript array with list of reject reasons configured for the control. |
Vrsprofiles |
Returns complete Scan/VRS profiles as an array of JavaScript Objects. |
DocumentSeparation |
Returns a complete set of document separation settings defined in the assigned separation profile as JavaScript objects. |
FolderSeparation |
Returns a complete set of folder separation settings defined in the assigned separation profile as JavaScript objects. |
FolderType |
Returns a serialized version of the assigned folder type. |
These properties are available for use. |
|
DisplayedDocumentId |
Document ID of the currently displayed document in the image viewer. |
DisplayedPageId |
Page ID of the currently displayed page in the image viewer. |
ActivityVariantName |
Name of the Activity Variant currently used by the Capture Composite control (if any). |
NewSplitDocumentId |
When splitting a document, the document id for the newly created document from the split. |
EnableDocumentFields |
Returns true or false depending on if the document field option is enabled for the composite control. |
EnableFolderFields |
Returns true or false depending on if the folder field option is enabled for the composite control. |
ContextHeader |
This property is useful when calling the Capture SDK (CaptureDocumentService) using web service references from a custom DLL. To make API calls context-aware, you can consume the ContextHeader property and inject it into outgoing HTTP headers before making an API call. Example:
|
For the description of ImageAddress, ImageAddessTemplate, ScanningHostName, ImprinterFormat, ImprinterString, ImprinterIndex, ImprinterIndexStep, ImprinterIndexDigits, ImprinterSuffix, ImprinterRotation, ImprinterVerticalOffset, ImprinterUnits, and ImprinterFontStyle, see Build a Scan create new job form.