WFStepParameters Class |
In IPRO, you can set workflow step parameters.
Inheritance HierarchyNamespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
SyntaxThe WFStepParameters type exposes the following members.
Fields| Name | Description | |||||||
|---|---|---|---|---|---|---|---|---|
  | SP_ATM_FALLBACKONFAIL |
If the template file cannot be used as a form template in case of SP_ATM_TRYASFORM = true, then it is used as a common zone template file.
| ||||||
| SP_ATM_MANZONE |
Turn manual zoning on.
| ||||||
| SP_ATM_POPBKGNDZONES |
Automatically creates UserZones from BackgroundZones in case of manual zoning.
| ||||||
| SP_ATM_SKIPZONELESSPAGE |
Skips those pages in case of manual zoning, whose BackgroundZones collection is empty.
| ||||||
| SP_ATM_TEMPFILENAME |
Specify Zone Template file name.
| ||||||
| SP_ATM_TRYASFORM |
The specified template file form will be interpreted as a template.
| ||||||
| SP_CLS_PROJECT |
This API is preliminary and subject to change. | ||||||
| SP_D2D_PROMPT_FOR_INPUT |
Whether to prompt for input file name during DocToDoc conversion.
| ||||||
| SP_D2D_PROMPT_FOR_OUTPUT |
Whether to prompt for output file name during DocToDoc conversion.
| ||||||
| SP_D2D_PROMPT_INPUT_PATH |
Default input path in case of DocToDoc conversion.
| ||||||
| SP_D2D_PROMPT_OUTPUT_PATH |
Default output path in case of DocToDoc conversion.
| ||||||
| SP_EXP_APPENDPROMPT |
Whether to prompt for appending if the file exists at export.
| ||||||
| SP_EXP_BARCODEPAGEIMAGEINDEX |
This API is preliminary and subject to change. | ||||||
| SP_EXP_BARCODESEPARATION |
This API is preliminary and subject to change. | ||||||
| SP_EXP_BARCODETEXT |
This API is preliminary and subject to change. | ||||||
| SP_EXP_CONVERTERNAME |
Specify export converter name.
| ||||||
| SP_EXP_CONVERTPROMPT |
Whether to prompt when the image must be converted at export due to the limitation of the output format.
| ||||||
| SP_EXP_FILENAMEIN |
Specify input file names for export.
| ||||||
| SP_EXP_FILENAMEOUT |
Specify output file names for export.
| ||||||
| SP_EXP_FILEOPTIONS |
Set export file options.
| ||||||
| SP_EXP_FORMATTINGLEVEL |
Set export formatting level.
| ||||||
| SP_EXP_GENERATEOUTPUT |
This API is preliminary and subject to change. | ||||||
| SP_EXP_HASFOLDERNOTES |
Apply Folder Notes.
| ||||||
| SP_EXP_HASPPLAUNCH |
Launch PaperPort on export.
| ||||||
| SP_EXP_HASPROMPTFORDEST |
Prompt for export destination.
| ||||||
| SP_EXP_HASSAVEANDLAUNCH |
Launch associated application.
| ||||||
| SP_EXP_HASTIMESTAMP |
Apply timestamp name.
| ||||||
| SP_EXP_INCLUDEBARCODESEPARATOR |
This API is preliminary and subject to change. | ||||||
| SP_EXP_OVERWRITEPROMPT |
Prompt for overwrite.
| ||||||
| SP_EXP_PAGERANGE |
Set export page range.
| ||||||
| SP_EXP_PASSWORDPROMPT |
Prompt for password if the output file is password protected at export.
| ||||||
| SP_EXP_POSTBARCODESEPARATION |
This API is preliminary and subject to change. | ||||||
| SP_EXP_PROMPTPATH |
Specify prompting path.
| ||||||
| SP_EXP_SKIPSINGLEOUTPUTNUMBERING |
This API is preliminary and subject to change. | ||||||
| SP_EXP_TIMESTAMP |
Specify Timestamp name.
| ||||||
| SP_EXP_TIMESTAMPTYPE |
In case of timestamp at export, the type of the timestamp.
| ||||||
| SP_EXP_USEENGINECONVERTERS |
Set whether Engine Converters are used.
| ||||||
| SP_FDE_FORMTEMPLATENAME |
Specify Form Template name.
| ||||||
| SP_FDE_TEMPLATEPAGES |
Specify pages (page range) for Form Data Extraction.
| ||||||
| SP_ILN_PASSWORD |
Specify password for the input link.
| ||||||
| SP_ILN_PROMPTPATH |
Specify prompt path (URL) for the input link.
| ||||||
| SP_ILN_USER |
Specify user name for the input link.
| ||||||
| SP_IPP_FILENAME |
Specify preprocess file template name.
| ||||||
| SP_IPP_INITDIR |
Specify prompt directory for enhancement template files.
| ||||||
| SP_IPP_MANUAL |
Turn processing manually (display Enhance Images UI) on / off.
| ||||||
| SP_LDI_ADVANCED |
Display 'Advanced File Open Dialog'.
| ||||||
| SP_LDI_AUTOCROP |
Automatic crop at Load.
| ||||||
| SP_LDI_BLANKPAGESENSITIVITY |
Sensitivity of detecting when blank state of a page needs to be detected at Load.
| ||||||
| SP_LDI_DESKEW |
Turn deskew for loading on / off.
| ||||||
| SP_LDI_DESPECKLE |
Turn despeckle for loading on / off.
| ||||||
| SP_LDI_DESPECKLEDITHERING |
If an image needs to be despeckled at Load, its method is halftone, (otherwise normal).
| ||||||
| SP_LDI_DESPECKLEOUTPUT |
This API is preliminary and subject to change. | ||||||
| SP_LDI_DIGITALCAMERA |
Turn loading of digital camera files on / off.
| ||||||
| SP_LDI_DOPREVIEW |
Show image preview.
| ||||||
| SP_LDI_DOUBLEPAGE |
Turn double pages for loading on / off.
| ||||||
| SP_LDI_DOWNSAMPLE |
Turn resolution reduction (downsampling) On/Off for loading.
When set to 'On', large PDF images are cropped to 300 DPI at loading, in order to save resources.
| ||||||
| SP_LDI_IGNOREPDFTAGS |
Set to ignore / not to ignore PDF tags.
| ||||||
| SP_LDI_LANGUAGES |
Specify recognition language(s) for image load.
| ||||||
| SP_LDI_LEGALPLEADING |
Turn processing of legal pleading on / off.
| ||||||
| SP_LDI_NEWPAGEINDEX |
Specify new page index.
| ||||||
| SP_LDI_NEWPAGEPOS |
Specify new page position for image load.
| ||||||
| SP_LDI_OPENPDFASIMAGE |
Turn opening of PDF files as image on / off.
| ||||||
| SP_LDI_PAGEROTATION |
Specify page rotation for loading.
| ||||||
| SP_LDI_PDFPASSWORD |
Specify PDF password for image load.
| ||||||
| SP_LDI_PROMPTFORINPUT |
If set, prompts whether there is a Load step in the workflow.
| ||||||
| SP_LDI_PROMPTPATH |
Specify prompting path for image load.
| ||||||
| SP_LDI_REMOVEBLANKPAGES |
Blank pages are not loaded at Load.
| ||||||
| SP_LDI_REMOVEBORDER |
Automatically removes marginal shadow at Load.
| ||||||
| SP_LDI_REMOVEPUNCHHOLES |
Automatically removes marginal shadow at Load.
| ||||||
| SP_LDI_SHOWOPENDLG |
Display 'File Open' dialog.
| ||||||
| SP_LDI_SINGLESEL |
Turn single file selection in 'Open' dialog
on / off.
| ||||||
| SP_LOP_PROMPTFORINPUT |
Turn prompting for input on / off.
| ||||||
| SP_LOP_PROMPTPATH |
Specify prompting path for opening an OPD.
| ||||||
| SP_LOP_RECOVER |
Turn open document recovery on / off.
| ||||||
| SP_OLN_PASSWORD |
Specify password for the output link.
| ||||||
| SP_OLN_PROMPTPATH |
Specify prompt path for the output link.
| ||||||
| SP_OLN_URI |
Specify output link URI.
| ||||||
| SP_OLN_USER |
Specify user name for the output link.
| ||||||
| SP_PRO_AUTOPROOFREAD |
Turn auto proofing on / off.
| ||||||
| SP_PRO_MARKNONDICTWORDS |
Mark Non-Dictionary words during proofing.
| ||||||
| SP_PRO_PROOFMODE |
Set proofing mode.
| ||||||
| SP_PRO_TRAININGDATAFILE |
Specify Training Data file.
| ||||||
| SP_PRO_USEINTELIFIX |
Turn IntelliTrain on / off.
| ||||||
| SP_QC_FILENAME | This API is preliminary and subject to change. | ||||||
| SP_QC_OVERWRITEPROMPT | This API is preliminary and subject to change. | ||||||
| SP_RCI_ADDITIONALCHARS |
Specify additional characters.
| ||||||
| SP_RCI_AUTODETECTLANG |
Autodetects language of incoming documents at unattended processing when it cannot be determined in advance.
| ||||||
| SP_RCI_AUTOLANGUAGE |
Invokes automatic language detection that warns of differences between a detected language and the language setting.
| ||||||
| SP_RCI_BARTYPES |
This API is preliminary and subject to change. | ||||||
| SP_RCI_CUSTOMLAYOUT |
Specify custom layout.
| ||||||
| SP_RCI_FONTNAMES |
Specify font names for font matching of the recognized text.
| ||||||
| SP_RCI_INSERTFULLPAGEZONE |
This API is preliminary and subject to change. | ||||||
| SP_RCI_LANGUAGES |
Specify recognition language(s).
| ||||||
| SP_RCI_LOOKFORHEADERFOOTER |
Turn looking for headers / footers on / off.
| ||||||
| SP_RCI_LOOKFORHYPERLINK |
Turn looking for hyperlinks
on / off.
| ||||||
| SP_RCI_OPTIMIZESPEED |
Turn speed optimization on / off.
| ||||||
| SP_RCI_PAGELAYOUT |
Set page layout.
| ||||||
| SP_RCI_PRESERVCOLORGRAPH |
Turn preservation of color graphics on / off.
| ||||||
| SP_RCI_PRESERVCOLORTEXT |
Turn preservation of color text
on / off.
| ||||||
| SP_RCI_PROFDICT |
Specify Vertical Dictionaries.
| ||||||
| SP_RCI_REJECTCHARS |
Specify reject character.
| ||||||
| SP_RCI_RERECOGNIZE |
Turn re-recognition on / off.
| ||||||
| SP_RCI_USEPDFFONTS |
Turn using PDF fonts on / off.
| ||||||
| SP_RCI_USERDICT |
Specify User Dictionary name.
| ||||||
| SP_SCI_AUTOCROP |
Automatic crop at Scan.
| ||||||
| SP_SCI_AUTOSCAN |
Turn automatic scanning on / off.
| ||||||
| SP_SCI_AUTOSCANTIME |
Specify automatic scan time.
| ||||||
| SP_SCI_BLANKPAGESENSITIVITY |
The sensitivity of detection if the blank state of a page needs to be detected at Scan.
| ||||||
| SP_SCI_BRIGHTNESS_BINARY |
Set scanning brightness for B/W scanning.
| ||||||
| SP_SCI_BRIGHTNESS_BINARY_AUTO |
Turn auto brightness for B/W scanning on / off.
| ||||||
| SP_SCI_BRIGHTNESS_COLOR |
Set scanning brightness for color scanning.
| ||||||
| SP_SCI_BRIGHTNESS_COLOR_AUTO |
Turn auto brightness for color scanning on / off.
| ||||||
| SP_SCI_BRIGHTNESS_GRAY |
Set scanning brightness for grayscale scanning.
| ||||||
| SP_SCI_BRIGHTNESS_GRAY_AUTO |
Turn auto brightness for grayscale scanning on / off.
| ||||||
| SP_SCI_CONTRAST_COLOR |
Specify contrast for color scanning.
| ||||||
| SP_SCI_CONTRAST_GRAY |
Specify contrast for grayscale scanning.
| ||||||
| SP_SCI_DESKEW |
Turn deskew for scanning on / off.
| ||||||
| SP_SCI_DESPECKLE |
Turn despeckle for scanning on / off.
| ||||||
| SP_SCI_DESPECKLEDITHERING |
If an image needs to be despeckled at Scan, then its method is halftone (otherwise normal).
| ||||||
| SP_SCI_DESPECKLEOUTPUT |
This API is preliminary and subject to change. | ||||||
| SP_SCI_DIGITALCAMERA |
Turn digital camera input on / off.
| ||||||
| SP_SCI_DOUBLEPAGE |
Turn scanning double pages on / off.
| ||||||
| SP_SCI_DOWNSAMPLE |
Turn resolution redaction (downsampling) for scanning on / off.
| ||||||
| SP_SCI_DUPLEX |
Turn Duplex scanning on / off.
| ||||||
| SP_SCI_LEGALPLEADING |
Turn legal pleading for scanning
on / off.
| ||||||
| SP_SCI_MODE |
Specify scanning mode.
| ||||||
| SP_SCI_NEWPAGEINDEX |
Specify new page index at scan.
| ||||||
| SP_SCI_NEWPAGEPOS |
Set new page position.
| ||||||
| SP_SCI_ORIENTATION |
Turn scanning in Landscape orientation on / off.
Field ValueType:
| ||||||
| SP_SCI_PAGEROTATION |
Set page rotation for scanning.
| ||||||
| SP_SCI_PAGESIZE |
Specify page size for scanning.
| ||||||
| SP_SCI_PROMPTFORPAGES |
Turn prompting for pages on / off.
| ||||||
| SP_SCI_REMOVEBLANKPAGES |
Blank pages are not loaded at Scan.
| ||||||
| SP_SCI_REMOVEBORDER |
Automatically removes marginal shadow at Scan.
| ||||||
| SP_SCI_REMOVEPUNCHHOLES |
Automatically removes punchholes at Scan.
| ||||||
| SP_SCI_RESOLUTION_BINARY |
Set scan resolution for B/W scanning.
| ||||||
| SP_SCI_RESOLUTION_COLOR |
Set scan resolution for color scanning.
| ||||||
| SP_SCI_RESOLUTION_GRAY |
Set scan resolution for grayscale scanning.
| ||||||
| SP_SCI_SCANNERINI |
Specify scanner INI file name.
| ||||||
| SP_SCI_SCANNERNAME |
Specify scanner name.
| ||||||
| SP_SCI_SOURCE |
Specify scan source.
| ||||||
| SP_SCI_UIENABLED |
Enable / disable scan UI.
| ||||||
| SP_SCI_USEENGINESCANNERS |
Set to use / not to use Engine scanners.
| ||||||
| SP_SOP_ADDTIMESTAMPFOLDER |
Set to save / not to save document in Timestamp Folder.
| ||||||
| SP_SOP_EXTENDEDFORMAT |
Save OmniPage document in extended format.
| ||||||
| SP_SOP_FILENAME |
Specify document save file name.
| ||||||
| SP_SOP_PROMPTFORINPUT |
Turn prompting for input on / off.
| ||||||
| SP_SOP_PROMPTPATH |
Specify document save path.
| ||||||
| SP_SOP_SAVETOSOURCE |
Turn saving to source on / off.
| ||||||
| SP_SOP_TIMESTAMPFOLDER |
Specify Timestamp Folder name.
| ||||||
| SP_TM_BOOKMARKPAGE |
Set page bookmarking.
| ||||||
| SP_TM_HIGHLIGHTLIST |
Specify word list for highlight.
| ||||||
| SP_TM_MATCHCASE |
Set case matching.
| ||||||
| SP_TM_REDACTDOCUMENT |
If this parameter is set, all the others are ignored. This implements a workflow step that performs redaction on all text strings in the document that are marked for redaction.
| ||||||
| SP_TM_REDACTLIST |
Specify word list for redaction.
| ||||||
| SP_TM_REDACTTEXT |
Set text redaction. If this is set, the words on the SP_TM_REDACTLIST word list will be redacted. If it is NOT set, those words will be marked for redaction and not redacted.
| ||||||
| SP_TM_STRIKEOUTLIST |
Specify word list for strikeout.
| ||||||
| SP_TM_WHOLEWORD |
Set whole-word matching.
|
CautionSee Also