P2WW-1512-48ENZ0

RICOH Scanner Control SDK

Version 2.3 L60

Reference Manual
- No part of the Product may be copied, reproduced, distributed, or transmitted in any form or for any
purpose without the permission of PFU Limited.
- The contents and specifications of this Product may be revised for improvement without prior notice.
- Customer shall assume all responsibilities for the use of and results obtained from the Product and
manual.
- Should Customer have any questions concerning the contents of the Product, please feel free to
contact our office.

I
Introduction
This manual explains information about the functions and sample source
codes of RICOH Scanner Control SDK. Make sure you read the "Getting
Started" before reading this manual. "Getting Started" explains the
preparation for using RICOH Scanner Control SDK and the development
procedures.

Refer to "Getting Started" for trademarks and abbreviations.

II
<Contents>
1. Reference .............................................................................................................. 1
1.1 Property ....................................................................................................................................... 1
1.1.1 Property list ............................................................................................................................ 1
1.1.2 Example of use and conventions in this chapter ................................................................... 7
1.1.3 AdjustRGB .... Adjusting the brightness of each color (RGB) separately ............................. 8
1.1.4 AdjustRGBB .... Brightness of the Color Blue ....................................................................... 9
1.1.5 AdjustRGBG .... Brightness of the Color Green .................................................................. 10
1.1.6 AdjustRGBR .... Brightness of the Color Red ...................................................................... 11
1.1.7 ADTCThreshold .... Automatic (advanced) binary threshold ............................................... 12
1.1.8 AIQCNotice .... Automatic Image Quality Checker setting .................................................. 13
1.1.9 AIQCResult .... Acquire Automatic Image Quality Checker results ..................................... 14
1.1.10 AutoBorderDetection .... automatic border detection ........................................................ 15
1.1.11 AutoBright .... Automatic adjustment of brightness-related image quality ......................... 16
1.1.12 AutomaticColorBackground .... setting auto color detection which ignores background
color .................................................................................................................................. 17
1.1.13 AutomaticColorSensitivity .... Sensitivity for auto color detection ...................................... 18
1.1.14 AutomaticRotateMode .... Mode for detecting the orientation of an image ....................... 19
1.1.15 AutomaticSenseMedium .... ADF / FB automatic switching .............................................. 20
1.1.16 AutoProfile .... Applying a profile automatically ................................................................. 21
1.1.17 AutoProfileSensitivity .... Sensitivity level for identifying forms ......................................... 22
1.1.18 AutoSeparation .... automatic image area separation ....................................................... 23
1.1.19 Background .... background tracking ................................................................................. 24
1.1.20 BackgroundColor .... setting the background color (black background) .............................. 25
1.1.21 BackgroundSmoothing .... Background color smoothing(Color cleanup) ......................... 26
1.1.22 BackgroundSmoothness .... Background color smoothness(Color cleanup
smoothness) ..................................................................................................................... 27
1.1.23 BackgroundThreshold .... Background color threshold ..................................................... 28
1.1.24 BarcodeDetection .... Barcode detection ........................................................................... 29
1.1.25 BarcodeDirection .... Barcode detection direction setting ................................................. 30
1.1.26 BarcodeMaxSearchPriorities .... Barcode maximum detection count setting ................... 31
1.1.27 BarcodeNotDetectionNotice .... Barcode detection notification when a barcode is not
detected ............................................................................................................................ 32
1.1.28 BarcodeRegionLeft .... Barcode detection area left edge position .................................... 33
1.1.29 BarcodeRegionLength .... Barcode detection area length ................................................ 34
1.1.30 BarcodeRegionTop .... Barcode detection area top edge position ................................... 36
1.1.31 BarcodeRegionWidth .... Barcode detection area width .................................................... 37
1.1.32 BarcodeType .... Barcode type setting .............................................................................. 38
1.1.33 Binding .... duplex binding direction ................................................................................... 39
1.1.34 BlankPageIgnoreAreaSize .... Sides undetected during blank page detection ................. 40
1.1.35 BlankPageNotice .... Output blank page setting ................................................................ 41
1.1.36 BlankPageResult .... Get blank page detection results ..................................................... 42
1.1.37 BlankPageSkip .... Blank page skip sensitivity .................................................................. 43
1.1.38 BlankPageSkipMode .... Blank page skip mode................................................................ 44
1.1.39 BlankPageSkipTabPage .... Blank page skip settings for index-tabbed pages ................ 45
1.1.40 Brightness .... brightness ................................................................................................... 46
1.1.41 CarrierSheetClippingMode .... Carrier Sheet clipping mode ............................................. 47
1.1.42 CharacterExtraction .... Extracting characters ................................................................... 48
1.1.43 CharacterExtractionMethod .... Setting the type of character extractions ......................... 49
1.1.44 CharacterThickness .... Dynamic Threshold (iDTC) binary character thickness setting 50
1.1.45 CloseSourceUI .... exit setting for the user interface (UI) of the source ............................ 51
1.1.46 ColorReproduction .... Color reproduction ......................................................................... 52
1.1.47 ColorReproductionBrightness .... Brightness when a color hue is prioritized ................... 53
1.1.48 ColorReproductionContrast .... Color contrast when a color hue is prioritized ................. 54
1.1.49 ColorReproductionCustomGamma .... Gamma value when a color hue is prioritized ...... 55
1.1.50 ColorReproductionHighlight .... Highlight when a color hue is prioritized ......................... 56

III
1.1.51 ColorReproductionShadow .... Shadow when a color hue is prioritized ............................ 57
1.1.52 CompressionType .... data compression type ................................................................... 58
1.1.53 Contrast .... contrast .......................................................................................................... 60
1.1.54 CropMarginSize .... Sizes of cropping margins ................................................................. 61
1.1.55 CropPriority .... Priority setting during automatic paper size detection .............................. 62
1.1.56 CustomGamma .... custom gamma ................................................................................... 63
1.1.57 CustomPaperLength .... custom document length ............................................................ 64
1.1.58 CustomPaperWidth .... custom document width................................................................ 66
1.1.59 CustomResolution .... custom resolution ........................................................................... 67
1.1.60 Deskew .... Skew correction .............................................................................................. 68
1.1.61 DeskewBackground .... Background color used for skew correction ................................ 69
1.1.62 DeskewMode .... Deskew mode ........................................................................................ 70
1.1.63 DigitalEndorser .... Digital endorser setting ....................................................................... 71
1.1.64 DigitalEndorserCountDirection .... Digital endorser counter step direction setting ............ 72
1.1.65 DigitalEndorserCounter .... Digital endorser counter default value setting ........................ 73
1.1.66 DigitalEndorserCountStep .... Digital endorser counter step value setting ....................... 74
1.1.67 DigitalEndorserDirection .... Digital endorser output direction setting ............................... 75
1.1.68 DigitalEndorserString .... Digital endorser character string setting .................................... 76
1.1.69 DigitalEndorserXOffset .... Digital endorser output start position (X offset) setting ........... 77
1.1.70 DigitalEndorserYOffset .... Digital endorser output start position (Y offset) setting ........... 78
1.1.71 DivideLongPage .... Dividing long pages ........................................................................... 79
1.1.72 DoubleFeed .... double feed detection ............................................................................... 80
1.1.73 DTCSensitivity .... Dynamic Threshold (iDTC) binary sensitivity setting ........................... 81
1.1.74 EdgeFiller .... Edge filler..................................................................................................... 82
1.1.75 EdgeFillerBottom .... Edge filler bottom edge area setting ................................................ 83
1.1.76 EdgeFillerLeft .... Edge filler left edge area setting ............................................................ 84
1.1.77 EdgeFillerRight .... Edge filler right edge area setting ....................................................... 85
1.1.78 EdgeFillerTop .... Edge filler top edge area setting ........................................................... 86
1.1.79 EdgeRepair .... Edge filler repair ....................................................................................... 87
1.1.80 Endorser .... Endorser / Imprinter setting........................................................................... 88
1.1.81 EndorserCountDirection .... Endorser / Imprinter counter step direction setting ............... 89
1.1.82 EndorserCounter .... Endorser / Imprinter counter default setting ..................................... 90
1.1.83 EndorserCountStep .... Endorser / Imprinter counter step count setting ........................... 92
1.1.84 EndorserDialog .... Endorser / Imprinter print settings window ......................................... 93
1.1.85 EndorserDirection .... Endorser / Imprinter print direction setting...................................... 94
1.1.86 EndorserFont .... Endorser / Imprinter print font setting .................................................... 95
1.1.87 EndorserOffset .... Endorser / Imprinter start print position setting ................................... 96
1.1.88 EndorserString .... Endorser / Imprinter string setting ....................................................... 97
1.1.89 ErrorCode .... Error information acquisition ....................................................................... 99
1.1.90 FadingCompensation .... Dynamic Threshold (iDTC) binary fading compensation ...... 100
1.1.91 FileCounter .... file serial number setting ......................................................................... 101
1.1.92 FileCounter1, FileCounter2, FileCounter3 .... file serial number settings for files created
from each output image .................................................................................................. 103
1.1.93 FileCounterEx .... file serial number setting ..................................................................... 105
1.1.94 FileCounterEx1, FileCounterEx2, FileCounterEx3 .... file serial number settings for files
created from each output image ..................................................................................... 107
1.1.95 FileName .... file name ..................................................................................................... 109
1.1.96 FileName1, FileName2, FileName3 .... file names used for each output image ............. 111
1.1.97 FileType .... file format (image data format)..................................................................... 113
1.1.98 Filter .... dropout color ...................................................................................................... 115
1.1.99 FilterSaturationSensitivity .... Chromatic dropout color sensitivity setting ....................... 117
1.1.100 FrontBackDetection .... ID card automatic detection ..................................................... 118
1.1.101 FrontBackMergingEnabled .... Setting for merging the front and back side images ..... 119
1.1.102 FrontBackMergingLocation .... Setting for the way of merging the front and back side
images ............................................................................................................................. 120
1.1.103 FrontBackMergingRotation .... Setting for the angle to rotate the back side when
merging the front and back side images ......................................................................... 121
1.1.104 FrontBackMergingTarget .... Setting a type of document whose front and back side
images are to be merged ................................................................................................ 122

IV
1.1.105 FrontBackMergingTargetMode .... Setting the criteria for determining a type of
document whose front and back side images are to be merged .................................... 123
1.1.106 FrontBackMergingTargetSize .... Setting the length for the criteria for determining a
type of document whose front and back images are to be merged ................................ 125
1.1.107 Gamma .... gamma adjustment ..................................................................................... 126
1.1.108 GammaFile .... gamma pattern file name ...................................................................... 127
1.1.109 Halftone .... halftone ...................................................................................................... 128
1.1.110 HalftoneFile .... halftone pattern file ............................................................................... 129
1.1.111 Highlight .... highlight ..................................................................................................... 130
1.1.112 HwAutomaticDeskew.... Automatic Skew Correction .................................................... 131
1.1.113 HwCompression .... Transfer mode of the hardware .................................................... 132
1.1.114 HwMoireReductionMode.... Moire Reduction(Advanced) ............................................. 133
1.1.115 ImageScanner .... image scanner name acquisition ..................................................... 134
1.1.116 Indicator .... progress indicator setting .......................................................................... 135
1.1.117 IsExistsFB .... image scanner's flatbed (FB) support .................................................... 136
1.1.118 JobControl .... job control setting ................................................................................... 137
1.1.119 JobControlMode .... Job control type setting ................................................................. 139
1.1.120 JpegQuality .... Jpeg data compression level ................................................................ 140
1.1.121 LengthDetection .... Simultaneous setting of paper end detection / background color /
overscan ......................................................................................................................... 141
1.1.122 LongPage .... Long document (long page) scan setting ................................................ 142
1.1.123 ManualFeedMode .... Manual Feed Mode .................................................................... 143
1.1.124 Mirroring .... mirror image (flip horizontal) ..................................................................... 144
1.1.125 MultiFeed .... multifeed detection .................................................................................. 145
1.1.126 MultiFeedModeChangeSize .... Specifying the paper length to disable multifeed
detection ......................................................................................................................... 146
1.1.127 MultiFeedNotice .... Multifeed notification setting .......................................................... 147
1.1.128 MultiFeedResult .... Getting the multifeed result ........................................................... 148
1.1.129 MultiStreamDefaultValueMode .... Mode for keeping the default value for each
image .............................................................................................................................. 149
1.1.130 MultiStreamFileNameMode .... File name and file counter settings for a file created
from each output image .................................................................................................. 151
1.1.131 MultiStreamMode .... Settings for outputting multiple images ....................................... 152
1.1.132 NoiseRejection .... Dynamic Threshold (iDTC) binary noise removal ........................... 156
1.1.133 NoiseRemoval .... dust removal mode .......................................................................... 157
1.1.134 Orientation .... document orientation setting.................................................................. 158
1.1.135 Outline .... outline correction .......................................................................................... 159
1.1.136 OverScan .... overscan setting ...................................................................................... 161
1.1.137 Overwrite .... file overwrite setting ................................................................................. 162
1.1.138 PageCount .... scan page count acquisition .................................................................. 163
1.1.139 PageNumber .... Getting a page number ...................................................................... 164
1.1.140 PaperProtection .... Paper Protection ............................................................................ 165
1.1.141 PaperSize .... document size ......................................................................................... 166
1.1.142 PaperSupply .... paper feed method .............................................................................. 168
1.1.143 ParentAppName .... specifying the parent application name ........................................ 172
1.1.144 PatchCodeDetection .... Patch code detection .............................................................. 173
1.1.145 PatchCodeDirection .... Patch code detection direction setting .................................... 174
1.1.146 PatchCodeType .... Patch code type setting ................................................................. 175
1.1.147 PatternRemoval .... Dynamic Threshold (iDTC) binary pattern removal setting......... 176
1.1.148 PixelType .... pixel type.................................................................................................. 177
1.1.149 PreFiltering .... ballpoint pen filtering ............................................................................. 179
1.1.150 PunchHoleRemoval .... Punch hole removal ................................................................. 180
1.1.151 PunchHoleRemovalMode .... Punch hole removal mode .............................................. 181
1.1.152 RegionLeft .... Left Edge of the Scanning Area ............................................................. 182
1.1.153 RegionLength .... Length of the Scanning Area ............................................................ 183
1.1.154 RegionTop .... Top Edge of the Scanning Area ............................................................ 185
1.1.155 RegionWidth .... Width of the Scanning Area ................................................................ 186
1.1.156 Report .... Report Output ............................................................................................... 188
1.1.157 ReportFile .... Report File Name .................................................................................... 189

V
 1.1.158 Resolution .... Standard Resolution ............................................................................... 190
1.1.159 Reverse .... Black and White Inversion / Color Inversion .............................................. 191
1.1.160 Rotation .... Rotation Angle ............................................................................................ 192
1.1.161 ScanContinue .... Setting Continuous Scanning ........................................................... 193
1.1.162 ScanContinueMode .... Setting Continuous Scanning Method ..................................... 194
1.1.163 ScanCount .... Number of Pages to be Scanned .......................................................... 195
1.1.164 ScanMode .... Scan mode ............................................................................................. 196
1.1.165 ScanTo .... Output Method of Scanned Data ................................................................ 197
1.1.166 SDTCSensitivity .... Automatic (simple) binary dispersion value ................................... 198
1.1.167 SEE .... Selectable Edge Enhancement ........................................................................ 199
1.1.168 SelectOutputSize .... Selecting output size.................................................................... 200
1.1.169 Shadow .... shadow ....................................................................................................... 201
1.1.170 Sharpness .... Sharpness .............................................................................................. 202
1.1.171 ShowSourceUI .... Source User Interface (UI) Display .................................................. 204
1.1.172 SilentMode .... Silent Mode ............................................................................................ 206
1.1.173 SimpleSlicePatternRemoval .... Simple slice binary pattern removal setting ................ 207
1.1.174 SkipBlackPage .... Skip Black Pages ............................................................................ 208
1.1.175 SkipWhitePage .... Skip White Pages ............................................................................ 210
1.1.176 Smoothing .... OCR Smoothing Mode / Background Removal...................................... 212
1.1.177 SourceCurrentScan .... Scan with the Source Current Value........................................ 213
1.1.178 sRGB .... sRGB output................................................................................................... 215
1.1.179 StapleDetection.... Stapled Documents Detection ........................................................ 216
1.1.180 SynchronizationDigitalEndorser .... Endorser / Imprinter and Digital Endorser
synchronization function setting ...................................................................................... 217
1.1.181 Threshold .... Threshold ................................................................................................. 218
1.1.182 ThresholdCurve .... Density Curve in Automatic Binarization ........................................ 219
1.1.183 TwainDS .... Data Source .............................................................................................. 220
1.1.184 TwainDSAnyPort .... Locking the Data Source Name ................................................... 222
1.1.185 UndefinedScanning .... Scanning an Undefined Length (Paper End Detection) ........... 223
1.1.186 Unit .... unit of size (inch / centimeter / pixel) ................................................................. 224
1.1.187 VerticalLineReduction .... Vertical line reduction setting ............................................... 226
1.2 Methods.................................................................................................................................... 227
1.2.1 List of Methods .................................................................................................................. 227
1.2.2 Examples and Notation Conventions in This Chapter ....................................................... 229
1.2.3 AboutBox .... Version Information Dialog Box Display ...................................................... 230
1.2.4 CancelScan .... Stopping an Image Scanning ................................................................... 231
1.2.5 ClearPage .... Document Ejection ..................................................................................... 232
1.2.6 CloseScanner .... Closing the Scanner .............................................................................. 234
1.2.7 FeederLoaded .... Notifying Whether or Not a Document Is Loaded on the ADF ............. 235
1.2.8 GetCapability .... Capability Acquisition ............................................................................. 236
1.2.9 GetSerialNumber .... Obtaining a scanner serial number .................................................. 237
1.2.10 GetSlpcTemplateCount .... Total Number of Templates Acquisition ............................... 238
1.2.11 GetSlpcTemplateName .... Template Name Acquisition ................................................. 240
1.2.12 GetSlpcTemplateSelect .... Selected Template Number Acquisition .............................. 241
1.2.13 GetSourceCount .... Getting the total number of data source ......................................... 242
1.2.14 GetSourceName .... Getting a data source name ........................................................... 244
1.2.15 GetSourceSelect .... Getting the index of a selected data source ................................... 246
1.2.16 GetTWAINTemplateCount .... Setting File / profile Total Number Acquisition ................ 248
1.2.17 GetTWAINTemplateName .... Setting File / profile Name Acquisition ............................ 251
1.2.18 GetTWAINTemplateSelect .... Selected Setting File / profile Number Acquisition .......... 252
1.2.19 OpenScanner .... Opening the Scanner .......................................................................... 253
1.2.20 OpenScanner2 .... Open scanner (part 2) ....................................................................... 255
1.2.21 ScannerAvailable .... Image Scanner Availability ............................................................ 257
1.2.22 SelectSource .... Data source Selection .......................................................................... 259
1.2.23 SelectSourceName .... data source selection.................................................................. 261
1.2.24 SetCapability .... Capability Configuration ....................................................................... 263
1.2.25 SetSlpcTemplateSelect .... Template Number Specification ........................................... 264
1.2.26 SetTWAINTemplateSelect .... Configuring Setting File / profile Numbers ...................... 265
1.2.27 SetupDataSourceProperties .... Settable UI Display ....................................................... 266

VI
 1.2.28 StartScan .... Starting an Image Scanning ...................................................................... 269
1.3 Events ...................................................................................................................................... 273
1.3.1 List of Events ..................................................................................................................... 273
1.3.2 Notes on a Process Written in an Event Handler .............................................................. 274
1.3.3 Examples and Notation Conventions in This Chapter ....................................................... 274
1.3.4 AutoProfileSelection .... Notification of the identified forms ............................................... 275
1.3.5 DetectBarcode .... Barcode detection notification ............................................................. 276
1.3.6 DetectBarcodeDetail .... Barcode detail detection notification .......................................... 277
1.3.7 DetectJobSeparator .... Special Document / Patch Code Document Detection
Notification ...................................................................................................................... 279
1.3.8 DetectPatchCode .... Patch code detection notification .................................................... 280
1.3.9 MultiStreamPropertySetting .... Setting Properties for Each Image .................................. 281
1.3.10 NegotiateCapabilities .... Capability Configuration Notification ....................................... 284
1.3.11 PagePartition .... Page break notification ........................................................................ 285
1.3.12 ScanToDib .... DIB Handle Consignment ........................................................................ 286
1.3.13 ScanToDibEx .... DIB Handle Consignment .................................................................... 287
1.3.14 ScanToFile .... File Output ............................................................................................... 288
1.3.15 ScanToRaw .... Memory Output ...................................................................................... 289
1.3.16 ScanToRawEx .... Memory Output .................................................................................. 290
1.4 Property Pages ........................................................................................................................ 291
2. Samples............................................................................................................. 294
2.1 Basic Operations .................................................................................................................... 294
2.2 Item Names .............................................................................................................................. 295
2.3 SoftIPC Template .................................................................................................................... 296
2.4 TWAIN Template ..................................................................................................................... 296
2.5 Source List............................................................................................................................... 297
2.6 Output Result .......................................................................................................................... 297
2.7 Visual Basic / Visual C# Sample Screen ............................................................................... 298
2.8 Visual C++ Sample Screen ..................................................................................................... 308
2.9 Java Sample Program ............................................................................................................ 315
3. Appendix ........................................................................................................... 316
3.1 Error code and how to fix error ............................................................................................. 316
3.2 Relationships Between Properties ........................................................................................ 322
3.3 Property Priority Order ........................................................................................................... 339
3.4 Valid Specifications When Using the Image Processing Software Option ....................... 339
3.5 How to Change the Property Default Values ........................................................................ 340
3.6 Bitmap Class Conversion Libraries for Visual Basic / Visual C#....................................... 344
3.6.1 Preparation for using DLL .................................................................................................. 344
3.6.2 Constructors ...................................................................................................................... 346
3.6.3 Properties .......................................................................................................................... 346
3.6.3.1 ErrorCode .... error information acquisition ................................................................ 346
3.6.4 Methods ............................................................................................................................. 347
3.6.4.1 GetBitmapFromDIB .... Converting the DIB handle into the Bitmap class ................. 347
3.6.4.2 GetBitmapFromRAW .... Converting the image data handle into the Bitmap class
................................................................................................................................................ 348
3.7 Explanation of Terms Used.................................................................................................... 349

VII
1. Reference
This chapter describes properties, methods, and events for when Visual Basic / Visual
C++ / Visual C# are used.
When using Java, select the following menu, and refer to the API document in HTML
format.
[Start menu]→ [Programs] →[RICOH Scanner Control SDK V2.3]→[Javadoc]

1.1 Property

1.1.1 Property list

The following table gives an overview of the supported RICOH Scanner Control SDK
properties:
PaperStream IP (TWAIN) driver : PSIP
FUJITSU TWAIN32 driver : TWAIN

Property name Description PSIP TWAIN

Group representing equipment properties
ImageScanner Gets the name of the image scanner. ○ ○
IsExistsFB Gets the device information regarding whether the ○ ○
flatbed (FB) is supported.
Driver properties (or feed method)
AutomaticRotateMode Sets a mode for detecting the orientation of an ○ N/A
image when an image is automatically rotated.
AutomaticSenseMedium Sets automatic switching for the ADF/FB feeding ○ N/A
method.
AutoProfile Sets whether to apply a profile automatically. ○ N/A
AutoProfileSensitivity Specifies the sensitivity level for identifying a form ○ N/A
when a profile is applied automatically.
CarrierSheetClippingMode Sets the mode for clipping the Carrier Sheet. ○ N/A
CloseSourceUI Sets whether or not to close the user interface (UI) ○ ○
of the source after scanning.
ErrorCode Gets error information when methods end ○ ○
abnormally.
Indicator Set whether to show the progress indicator while ○ ○
scanning.
LongPage Sets the scanning of paper with a length greater ○ ○
than the maximum specifiable length (long page).
PageCount Gets the scan page count. ○ ○
PageNumber Gets the number of a page that is currently being ○ ○
scanned.
PaperSupply Sets the document feed method (flatbed, ADF, ○ ○
etc.).
ScanContinue Sets continuous scanning. ○ N/A
ScanContinueMode Sets the continuous scanning method. ○ N/A
ScanCount Specifies the document scan page count. ○ ○
ScanMode Sets the scan mode. ○ N/A
ShowSourceUI Sets whether or not to display the user interface ○ ○
(UI) of the source.
SilentMode Sets whether or not to signal (display) error ○ ○
messages.
SourceCurrentScan Sets whether or not to scan with the current ○ ○
settings of the source.
TwainDS Sets the TWAIN data source used for scanning. ○ ○
TwainDSAnyPort Sets whether or not to lock the TWAIN data ○ N/A
source name that is to be used.

1
 Property name Description PSIP TWAIN
Image format properties/destination
CompressionType Sets the data compression type. ○ ○
FileCounter Sets the serial numbers of files. ○ ○
FileCounter1 Sets an initial value for each serial number that ○ N/A
FileCounter2 will be added to a file name when a file created
FileCounter3 from each output image is saved.
FileCounterEx Sets the serial numbers of files. ○ ○
FileCounterEx1 Sets an initial value for each serial number that ○ N/A
FileCounterEx2 will be added to a file name when a file created
FileCounterEx3 from each output image is saved.
FileName Sets the file name for storing the image. ○ ○
(Extension not included)
FileName1 Sets the file names used for saving files for each ○ N/A
FileName2 output image (excluding extensions).
FileName3
FileType Sets the image data format of a file to output. ○ ○
JpegQuality Specifies the JPEG data compression level. ○ ○
Overwrite Specifies whether or not to overwrite files. ○ ○
ScanTo Sets how to output scan data (file, DIB handle, ○ ○
etc.).
Image properties
AdjustRGB Sets whether to adjust the brightness of each ○ N/A
color (Red, Green, Blue) separately.
AdjustRGBB Sets the brightness of the color blue when the ○ N/A
brightness of each color (RGB) is adjusted
separately.
AdjustRGBG Sets the brightness of the color green when the ○ N/A
brightness of each color (RGB) is adjusted
separately.
AdjustRGBR Sets the brightness of the color red when the ○ N/A
brightness of each color (RGB) is adjusted
separately.
ADTCThreshold Sets the automatic (advanced) binary threshold. ○ N/A

AutoBright Sets the automatic adjustment of the ○ N/A

brightness-related image quality.
AutomaticColorBackground Detects color automatically ignoring background ○ N/A
color.
AutomaticColorSensitivity Sets the sensitivity for auto color detection. ○ N/A
Background Sets the background tracking. ○ ○
BackgroundSmoothing Smoothens the image backgrounds, and prevents ○ N/A
unevenness of color and density.
BackgroundSmoothness Sets the smoothness level of the background ○ N/A
color.
BackgroundThreshold Sets the background threshold. ○ N/A
Brightness Specifies the brightness. ○ ○
CharacterExtraction Sets whether to extract characters or not. ○ N/A
CharacterExtractionMethod Sets the type of character extractions. ○ N/A
CharacterThickness Sets the thickness of the Dynamic Threshold ○ N/A
(iDTC) binary character.
ColorReproduction Sets the color reproduction. ○ N/A
ColorReproductionBrightness Specifies the brightness when a color hue is ○ N/A
prioritized.
ColorReproductionContrast Specifies the color contrast when a color hue is ○ N/A
prioritized.
ColorReproductionCustomGa Specifies the gamma value when a color hue is ○ N/A
mma prioritized.

2
 Property name Description PSIP TWAIN
ColorReproductionHighlight Specifies a highlight when a color hue is ○ N/A
prioritized.
ColorReproductionShadow Specifies a shadow when a color hue is prioritized. ○ N/A
Image properties
Contrast Sets the contrast. ○ ○
CustomGamma Specifies a customized gamma value. ○ ○
Specifies the "custom value" when customization
is set for the gamma pattern.

CustomPaperLength Sets the length of a custom-sized document. ○ ○

CustomPaperWidth Sets the width of a custom-sized document. ○ ○
CustomResolution Specifies the scan resolution. (Custom) ○ ○
DTCSensitivity Sets the Dynamic Threshold (iDTC) binary ○ N/A
sensitivity.
EdgeFiller Sets the edge filler. ○ N/A
EdgeFillerBottom Sets the edge filler area at the bottom edge of the ○ N/A
paper size.
EdgeFillerLeft Sets the edge filler area at the left edge of the ○ N/A
paper size.
EdgeFillerRight Sets the edge filler area at the right edge of the ○ N/A
paper size.
EdgeFillerTop Sets the edge filler area at the top edge of the ○ N/A
paper size.
EdgeRepair Sets the edge filler repair. ○ N/A
FadingCompensation Sets the compensation of the fading section of the ○ N/A
image during Dynamic Threshold (iDTC) binary
scanning.
Filter Sets the dropout color. ○ ○
FilterSaturationSensitivity Sets the chromatic dropout color sensitivity. ○ N/A
Gamma Sets the gamma pattern type ○ ○
(soft/sharp/download/custom).
GammaFile Specifies a customized gamma pattern file. ○ ○
Halftone Specifies the halftone pattern. ○ ○
HalftoneFile Specifies the halftone pattern file. ○ ○
Highlight Set highlights. ○ ○
HwMoireReductionMode Specify whether to adjust the scanning speed of ○ N/A
the scanner to reduce moire (vertical streaks)
pattern appearing on the images.
MultiStreamDefaultValueMod For properties that can be specified for each ○ N/A
e output image, this function enables the properties
with a default value to be kept for each image.
MultiStreamFileNameMode Sets a file name and file counter for a file created ○ N/A
from each output image.
MultiStreamMode Outputs multiple images for each page that is ○ N/A
scanned.
NoiseRejection Sets the sensitivity for Dynamic Threshold (iDTC) ○ N/A
binary noise removal.
Orientation Sets the document orientation ○ ○
(portrait/landscape).
Outline Sets the correction of the image outline. ○ ○
PaperSize Specifies the document size. ○ ○
PatternRemoval Sets the removal of the Dynamic Threshold (iDTC) ○ N/A
binary pattern.
PixelType Sets the pixel type (binary, gray, or color). ○ ○
RegionLeft Specifies the left end of the scan area. ○ ○
RegionLength Specifies the length of the scan area. ○ ○

3
 Property name Description PSIP TWAIN
RegionTop Specifies the top of the scan area. ○ ○
RegionWidth Specifies the width of the scan area. ○ ○
Resolution Specifies the scan resolution. (Fixed style) ○ ○
Reverse Sets the black and white reversal / color reversal. ○ ○
SDTCSensitivity Sets the automatic (simple) binary dispersion ○ N/A
value.
SEE Sets the selective enhancement. ○ ○
Image properties
Shadow Sets shadow. ○ ○
Sharpness Sets the sharpness. ○ N/A
SimpleSlicePatternRemoval Sets the removal of the simple slice binary pattern. ○ N/A
Smoothing Sets the OCR smoothing/background removal N/A ○
(function to smooth jagged lines of images and
remove irregularities of the background).
sRGB Sets the sRGB output. ○ N/A
Threshold Sets the threshold. ○ ○
VerticalLineReduction Sets whether the vertical lines are reduced. ○ N/A
Properties relating to behavior
AIQCNotice Sets whether the image recognition check function ○ ○
is used.
AIQCResult Gets the image recognition check function results. ○ ○
AutoBorderDetection Sets the auto document size detection (detects ○ ○
the document size and outputs the scan image
with the same size).
BackgroundColor Sets the background color. ○ ○
BarcodeDetection Sets barcode detection. ○ N/A
BarcodeDirection Sets the direction of the barcode that is detected. ○ N/A
BarcodeMaxSearchPriorities Sets the maximum number of barcodes that are ○ N/A
detected.
BarcodeNotDetectionNotice Sets whether to send a barcode detection ○ N/A
notification even if a barcode is not detected.
BarcodeRegionLeft Sets the left edge of the barcode detection area. ○ N/A
BarcodeRegionLength Sets the length of the barcode detection area. ○ N/A
BarcodeRegionTop Sets the top edge of the barcode detection area. ○ N/A
BarcodeRegionWidth Sets the width of the barcode detection area. ○ N/A
BarcodeType Sets the type of barcode that is detected. ○ N/A
Binding Sets the binding direction for duplex scanning. ○ ○
BlankPageIgnoreAreaSize Sets the sides around a page to be undetected ○ N/A
during blank page detection.
BlankPageNotice Sets whether a blank page is output or not. ○ N/A
BlankPageResult Requires blank page detection results. ○ N/A
BlankPageSkip Sets the sensitivity to scan by skipping blank ○ N/A
pages during continuous ADF scanning.
BlankPageSkipMode Sets a criteria for detecting blank pages. ○ N/A
BlankPageSkipTabPage Sets whether or not index-tabbed pages are ○ N/A
checked during blank page detection.
CropMarginSize Specifies the sizes of cropping margins. ○ N/A
CropPriority Sets the priority during automatic paper size ○ N/A
detection.
Deskew Sets the skew correction. ○ N/A
DeskewBackground Sets whether or not to fill in the areas around the ○ N/A
scanned image that are produced as a result of
skew correction with the contents deskew
function.

4
 Property name Description PSIP TWAIN
DeskewMode Sets the driver's deskew setting in [Configuration]. ○ N/A
DigitalEndorser Sets whether the digital endorser is used. ○ N/A
DigitalEndorserCountDirection Sets the step direction of the digital endorser ○ N/A
counter.
DigitalEndorserCounter Sets the default value of the digital endorser ○ N/A
counter.
DigitalEndorserCountStep Sets the step value of the digital endorser counter. ○ N/A
Properties relating to behavior
DigitalEndorserDirection Sets the digital endorser output direction. ○ N/A
DigitalEndorserString Sets the digital endorser character string. ○ N/A
DigitalEndorserXOffset Sets the digital endorser output start position (X ○ N/A
offset).
DigitalEndorserYOffset Sets the digital endorser output start position (Y ○ N/A
offset).
DivideLongPage Sets whether or not to divide long pages. ○ N/A
Endorser Sets whether or not to use the endorser/imprinter. ○ ○
EndorserCountDirection Specifies the step direction (increase/decrease) of ○ ○
the endorser/imprinter counter.
EndorserCounter Sets the default of the endorser/imprinter counter. ○ ○
EndorserCountStep Sets the step count of the endorser/imprinter ○ ○
counter.
Endorser Dialog Sets whether or not to display the ○ N/A
endorser/imprinter print settings window when
scanning starts.
EndorserDirection Sets the print direction of the endorser/imprinter. ○ ○
EndorserFont Sets the print font of the endorser/imprinter. ○ ○
EndorserOffset Sets the print start position of the ○ ○
endorser/imprinter.
EndorserString Sets the string to print with the endorser/imprinter. ○ ○
FrontBackDetection Sets the ID card automatic detection setting. ○ N/A
FrontBackMergingEnabled Sets whether or not to merge the front and back ○ N/A
side images.
FrontBackMergingLocation Sets the way of merging the front and back side ○ N/A
images.
FrontBackMergingRotation Sets the angle to rotate the back side when ○ N/A
merging the front and back side images.
FrontBackMergingTarget Sets a type of document whose front and back ○ N/A
side images are to be merged.
FrontBackMergingTargetMod Sets the criteria for determining a type of ○ N/A
e document whose front and back side images are
to be merged.
FrontBackMergingTargetSize Sets the length for the criteria for determining a ○ N/A
type of document whose front and back side
images are to be merged.
HwAutomaticDeskew Specify whether to have document skew ○ N/A
automatically corrected when documents are fed.
HwCompression Sets the transfer mode in the hardware. ○ N/A
JobControl Specifies the job when detecting a special ○ ○
document (document in a particular shape).
JobControlMode Sets the type of job control document. ○ N/A
LengthDetection Sets paper end detection, background color, and ○ N/A
overscan simultaneously.
ManualFeedMode Switches to Manual Feed Mode. ○ N/A
MultiFeed Sets the multifeed detection function (“MultiFeed” ○ ○
refers to the phenomenon, when two or more
sheets of paper are fed at one time).

5
 Property name Description PSIP TWAIN
MultiFeedModeChangeSize Specifies the paper length to disable multifeed ○ N/A
detection.
MultiFeedNotice Sets whether or not to use the multifeed ○ ○
notification function.
MultiFeedResult Gets the result of the multifeed notification ○ ○
function.
OverScan Set overscan. ○ ○
PaperProtection Detects document feeding errors. ○ N/A
PatchCodeDetection Sets patch code detection. ○ N/A
PatchCodeDirection Sets the direction of the patch code that is ○ N/A
detected.
Properties relating to behavior
PatchCodeType Sets the type of patch code that is detected. ○ N/A
PunchHoleRemoval Sets removal of punch holes. ○ N/A
PunchHoleRemovalMode Sets which type of punch holes to be removed. ○ N/A
Rotation Specifies the rotation angle for a scanned image. ○ ○
SelectOutputSize Select the method for specifying the output size ○ N/A
used for automatic cropping.
SkipBlackPage Sets the function to scan by skipping blank pages ○ ○
(black pages) for continuous ADF scanning.
SkipWhitePage Sets the function to scan by skipping blank pages ○ ○
(white pages) for continuous ADF scanning.
StapleDetection Specify whether to stop the scan when stapled ○ N/A
documents are detected during scanning by
feeder.
SynchronizationDigitalEndors Sets the endorser/imprinter and digital endorser ○ N/A
er synchronization function.
UndefinedScanning Sets the undefined scanning. ○ ○
Unit Set units (inch/centimeter/pixel). ○ ○
Others
Report Sets how to output the scan result report. ○ ○
ReportFile Specifies the name of the file to which the scan ○ ○
result is output.

6
1.1.2 Example of use and conventions in this chapter

Feature
Describes the overview of the property

Coding Style
Shows the description method and style used for the property’s coding.
Describes codes in accordance with the conventions of Visual Basic.
Example) [form.] scancontrolname.ScanTo [ = Integer ]
The content given between square brackets ([ ]) can be omitted.

Value
Gives the list and description of values that can be set or referenced.

Default
Describes the value for Control (OCX), which is the default when loaded.

Explanation
Describes the usage and function of the property. In addition, notes and restraints regarding
correlated properties are also described if necessary.

Target method
Shows the list of methods that, when processed, change the property’s state.

Related Properties
Shows all properties affecting each other.

Value Setting
Describes the state in which the value can be set. At the design stage, the building state
(environment) of the application, which uses Control (OCX) or Java class in the development
environment (Visual Basic, Visual C++, Visual C#, Java, etc.), and at the time of
implementation, the state of the running application, which actually uses Control (OCX) or
Java class.
Even if the value is set, its validity is unknown in reality. (Note that if the value goes beyond
the setting range, its validity is known.) In fact, the validity of the value cannot be judged until
a certain method is implemented.
There are two cases of the setting being disabled: Firstly, after the value is changed, an error
may return when a certain method is implemented. Secondly, even if the value is changed,
the value itself may be disregarded.

Value Reference
Describes the state in which the value can be referenced.
At the time of program implementation: shows the value supposed to be enabled in the
target method that will be implemented, or shows the implementation result of one previous
method.

Error Recovery
Describes the handling in the event of invalid setting or processing.

Compatibility and Restraints

Describes differences in functionality between versions, or restraints on functionality, should
such be the case.

7
1.1.3 AdjustRGB .... Adjusting the brightness of each color (RGB) separately

Feature
Sets whether to adjust the brightness of each color (Red, Green, Blue) separately.

Coding Style
[form.] scancontrolname.AdjustRGB [ = Boolean ]

Value
True Adjusts the brightness of each color (RGB) separately
False Does not adjust the brightness of each color (RGB) separately

Default
False Does not adjust the brightness of each color (RGB) separately

Explanation
Sets whether to adjust the brightness of each color (RGB) separately.
This property is enabled only when "2 - RGB" is specified for the PixelType property.
The AdjustRGBR, AdjustRGBG, and AdjustRGBB property settings are applied only when
"True" is set for this property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AdjustRGBB
AdjustRGBG
AdjustRGBR
PaperSupply
PixelType
ScanMode
sRGB

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

8
1.1.4 AdjustRGBB .... Brightness of the Color Blue

Feature
Sets the brightness of the color blue when the brightness of each color (RGB) is adjusted
separately.

Coding Style
[form.] scancontrolname.AdjustRGBB [ = Short ]

Value
Value in the range from 1 to 255

Default
128

Explanation
The brightness of each color (RGB) can be adjusted separately.
This property sets the brightness of the color blue.
This property is enabled only when "True" is set for the AdjustRGB property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBG
AdjustRGBR

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

9
1.1.5 AdjustRGBG .... Brightness of the Color Green

Feature
Sets the brightness of the color green when the brightness of each color (RGB) is adjusted
separately.

Coding Style
[form.] scancontrolname.AdjustRGBG [ = Short ]

Value
Value in the range from 1 to 255

Default
128

Explanation
The brightness of each color (RGB) can be adjusted separately.
This property sets the brightness of the color green.
This property is enabled only when "True" is set for the AdjustRGB property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB
AdjustRGBR

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

10
1.1.6 AdjustRGBR .... Brightness of the Color Red

Feature
Sets the brightness of the color red when the brightness of each color (RGB) is adjusted
separately.

Coding Style
[form.] scancontrolname.AdjustRGBR [ = Short ]

Value
Value in the range from 1 to 255

Default
128

Explanation
The brightness of each color (RGB) can be adjusted separately.
This property sets the brightness of the color red.
This property is enabled only when "True" is set for the AdjustRGB property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB
AdjustRGBG

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

11
1.1.7 ADTCThreshold .... Automatic (advanced) binary threshold
Feature
Sets the automatic (advanced) binary threshold.

Coding Style
[form.] scancontrolname.ADTCThreshold [ = Short ]

Value
Value in the range from 1 to 255

Default
83

Explanation
Sets the automatic (advanced) binary threshold value.
This property is enabled only when the Threshold property is set to "-1".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).

Compatibility and Restraints

N/A

12
1.1.8 AIQCNotice .... Automatic Image Quality Checker setting
Feature
Sets whether Automatic Image Quality Checker is used.

Coding Style
[form.]scancontrolname.AIQCNotice [=Boolean]

Value
True Automatic Image Quality Checker is used.
False Automatic Image Quality Checker is not used.

Default
False Automatic Image Quality Checker is not used.

Explanation
Sets whether Automatic Image Quality Checker is used during scanning.
When "True" is set for this property, set the AutoBorderDetection property to "TRUE" or the
BackgroundColor property to "1 - ON".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AIQCResult
AutoBorderDetection
BackgroundColor
PaperSupply

Value Setting
When designed and when implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

13
1.1.9 AIQCResult .... Acquire Automatic Image Quality Checker results
Feature
Gets the Automatic Image Quality Checker results.

Coding Style
[form.]scancontrolname.AIQCResult [=Boolean]

Value
N/A. Property for value reference purposes only.

Default
False An error image was not detected.

Explanation
This enables a check of whether there is an error in the image of the current page when
notification is sent for a ScanToFile, ScanToDibEx, or ScanToRawEx event.
True An error image was detected.
False An error image was not detected.
This property is enabled when [True] is set for the AIQCNotice property.
Even if a scanned image contains an error, when the EdgeRepair property has been set to
"True" and the scanned image is repaired, False is returned.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AIQCNotice
ScanTo

Related Events
ScanToFile
ScanToDibEx
ScanToRawEx

Value Setting
Not allowed.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

14
1.1.10 AutoBorderDetection .... automatic border detection
Feature
Sets the automatic document size detection function.

Coding Style
[form.] scancontrolname.AutoBorderDetection [ = Boolean ]

Value
True Detects the document size.
False Does not detect the document size.

Default
False Does not detect the document size.

Explanation
Detects the document size at the time of ADF scanning and outputs the scan image with the
same size.
If the document is scanned askew, detects and automatically corrects the skew.
In flatbed scanners, this is enabled in scanners that include the black document pad option.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoProfile
BackgroundColor
Deskew
DivideLongPage
LengthDetection
OverScan
PaperSupply
UndefinedScanning

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
And if this property cannot be enabled depending on device type, sets it to "False" when
scanning to carry out a scan. (* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

The property name "AutoBorderDetection" has been changed to "AutoBorderDetection"
since V2.0L10. Operated correctly even if the old name "AutoBorderDetection" is used, but
this is provided as a compatible for recompiling the source program created by a version of
SDK older than V2.0L10 as is using an SDK version V2.0L10 or later. Note that compiling
may become impossible in the future, should a major update of the version be conducted.
Use the new property name "AutoBorderDetection" rather than "AutoBorderDetection" in
order to newly create applications or modify existing programs.

15
1.1.11 AutoBright .... Automatic adjustment of brightness-related image quality
Feature
Sets the automatic adjustment of the brightness-related image quality.

Coding Style
[form.] scancontrolname.AutoBright [ = Boolean ]

Value
True Automatic adjustment is performed.
False Automatic adjustment is not performed.

Default
False Automatic adjustment is not performed.

Explanation
Image brightness-related (brightness, contrast, shadow, highlight, gamma) image quality is
adjusted automatically during scanning.
If "0 - Black & White" is set for the PixelType property, automatic adjustment is performed for
the brightness, contrast, and gamma only.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

16
1.1.12 AutomaticColorBackground
.... setting auto color detection which ignores background color
Feature
Sets auto color detection which ignores background color.

Coding Style
[form.] scancontrolname. AutomaticColorBackground [ = Short ]

Value
0 - Include Background Color (document which consists of only black and white)
1 - Ignore Background Color (document which consists of two colors)

Default
0 - Include Background Color (document which consists of only black and white)

Explanation
This is a function that detects color ignoring background color when auto color detection is
enabled.
This property is enabled only when "3 - Automatic" is specified for the PixelType property.
If "0 - Include Background Color" is specified for this property, a document which consists of
only black and white is detected as a binary (black and white) document.
If "1 - Ignore Background Color" is specified for this property, a document which consists of
two colors is detected as a binary (black and white) document. However, a document with
the background in an achromatic color (black, gray, or white) and with the contents in a
chromatic color (color other than an achromatic color) is detected as an RGB color
document.
For details, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

17
1.1.13 AutomaticColorSensitivity .... Sensitivity for auto color detection
Feature
Sets the sensitivity for auto color detection.

Coding Style
[form.] scancontrolname. AutomaticColorSensitivity [ = Short ]

Value
The range is from -7 (likely to be black and white (grey)) to 7 (likely to be in color).

Default
0

Explanation
This function sets the sensitivity for auto color detection.
This property is enabled only when "3 - Automatic" is specified for the PixelType property.
Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
PaperSupply
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

18
1.1.14 AutomaticRotateMode .... Mode for detecting the orientation of an image
Feature
Sets a mode for detecting the orientation of an image when an image is automatically
rotated.

Coding Style
[form.] scancontrolname.AutomaticRotateMode [ = Short ]

Value
0 - Standard Standard
1 - Custom Rotation based on the reference area

Default
0 - Standard Standard

Explanation
Sets a mode for detecting the orientation of an image when an image is automatically rotated.
When "1-Custom" is selected for this property, the scanned image and the registered
reference area are compared and if the orientation is different from each other, the scanned
image is rotated accordingly.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
CustomPaperLength
LongPage
PaperSize
PaperSupply
Rotation

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Some devices do not support "1 - Custom". In this case, "0 - Standard" is set and a scanning
process is carried out.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

19
1.1.15 AutomaticSenseMedium .... ADF / FB automatic switching
Feature
Sets automatic switching for the ADF/FB feeding method.

Coding Style
[form.] scancontrolname.AutomaticSenseMedium [ = Boolean ]

Value
True Automatic switching is performed.
False Automatic switching is not performed.

Default
False Automatic switching is not performed.

Explanation
If a document is loaded in the ADF, scanning is performed from the ADF. If no document is
loaded in the ADF, scanning is performed from the flatbed.
This property is enabled only when "1 - ADF", "2 - ADF(Duplex)", or "3 - ADF(Back Side)" is
set for the PaperSupply property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DivideLongPage
FrontBackMergingEnabled
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

If no document is loaded in the ADF, it takes some time for scanning to start when scanning
from the flatbed.

20
1.1.16 AutoProfile .... Applying a profile automatically
Feature
Sets whether to apply a profile automatically.

Coding Style
[form.] scancontrolname. AutoProfile [ = Short]

Value
0 - Disabled Does not apply a profile automatically.
1 - Enabled Applies a profile automatically.

Default
0 - Disabled Does not apply a profile automatically.

Explanation
Sets whether to identify a scanned form and apply a profile associated with the form
automatically.
In the case that a profile is applied automatically, some functions are enabled due to the
profile that was applied. In addition, the SDK property settings related to these functions are
disabled in the above case.
For the functions that are enabled due to the profile that was applied, refer to the Help of the
driver.
When "1 - Enabled" is set for this properly
・"True" is set for the AutoBorderDetection property.
・If "22 - 8.5 x 34inch" - "27 - 8.5 x 220inch", "31 - 12 x 34inch" - "32 - 12 x 125inch", or
"34 - 12 x 106.3inch" - "39 - 12 x 240inch" has been set for the PaperSize property, the
default paper size for the scanner is set for the PaperSize property.
・If "4 - ADF(CarrierSheet Spread A3)" - "49 - ADF(CarrierSheet Clipping Duplex
Custom)" has been set for the PaperSupply property, the operation is not guaranteed.
・If a value other than "0 - OFF" has been set for the Report property, the scanner is not
guaranteed to work.
・"4 - Automatic" is set for the Rotation property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfileSensitivity
MultiStreamMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

21
1.1.17 AutoProfileSensitivity .... Sensitivity level for identifying forms
Feature
Specifies the sensitivity level for identifying a form when a profile is applied automatically.

Coding Style
[form.] scancontrolname. AutoProfileSensitivity [ = Short ]

Value
Value in the range from 1 to 5. The higher the value is, the stricter the matching criteria
becomes for identifying forms.

Default
3

Explanation
In the process for applying a profile automatically, the scanned image is compared with
images of forms that are registered. If the scanned image exceeds the matching criteria, the
associated profile is applied.
Increasing the value of this property makes the matching criteria stricter (which means that
the profile is applied only to the scanned images that go over the strict criteria).

Target method
StartScan

Related Properties
AutoProfile

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 5).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

22
1.1.18 AutoSeparation .... automatic image area separation
Feature
Sets the automatic image area separation.

Coding Style
[form.] scancontrolname.AutoSeparation [ = Short ]

Value
0 - OFF Does not execute the automatic image area separation.
1 - ON Executes the automatic image area separation.

Default
0 - OFF Does not execute the automatic image area separation.

Explanation
If the automatic image area separation is enabled (1-ON), line (character) and image (photo)
areas are distinguished: the former being scanned in "binary (black and white)" mode, while
the latter being scanned in "subtle black and white (halftone)" mode. This is especially
suitable for documents consisting of pages filled with text and pages containing photographs.
This property is enabled only when "0 - Black & White" is set for the PixelType property.
Because this property is not supported in devices without an image processing board, it will
be set to OFF (does not execute the auto image area separation) when executing a scan.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
Halftone
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If "1 - Grayscale" or "2 - RGB" has been set for the PixelType property, a scan will be
executed without regard to this property. If the Halftone property is set to "0 - None," sets it
to the "1 - Dither Pattern 0" (for dark photo image).
In devices not supporting this property, if "1 - ON" is set for this property, the halftone effect
may appear on the image scanned.

Compatibility and Restraints

N/A

23
1.1.19 Background .... background tracking
Feature
Sets the background tracking.

Coding Style
[form.] scancontrolname.Background [ = Integer ]

Value
0 - OFF No (disabled)
1 - ON Yes (enabled)
2 - AUTO Automatic

Default
0 - OFF N/A

Explanation
Sets the background tracking (No/Yes/Auto).
* Background tracking refers to the function that automatically tracks and adjusts the
contrast when scanning a document with background color other than white.
This function is effective for scanning documents whose ground color is not pure white like
newspapers, for example.

Target method
StartScan

Related Properties
N/A

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
And if this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

24
1.1.20 BackgroundColor .... setting the background color (black background)

Feature
Sets the background color (black background)

Coding Style
[form.] scancontrolname. BackgroundColor [ = Short ]

Value
0 - OFF No (Uses the scanner settings)
1 - ON Yes (Black) * Enabled only for scanners that support the black background

Default
0 - OFF No (Uses the scanner settings)

Explanation
Sets the background color at the time of ADF scanning.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to"3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
LengthDetection
OverScan
PaperSupply
PunchHoleRemoval
UndefinedScanning

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
And if this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

The values 0-OFF and 1-ON are described as 0-White and 1-Black since V2.0L20. Note that
both are the same behavior.

25
1.1.21 BackgroundSmoothing .... Background color smoothing(Color cleanup)

Feature
Smoothens the image backgrounds, and prevents unevenness of color and density.

Coding Style
[form.] scancontrolname. BackgroundSmoothing [ = Short ]

Value
0 - None No smoothing is performed.
1 - Automatic Smoothing is performed automatically.
2 - White Smoothing is performed in white.

Default
0 - None No smoothing is performed.

Explanation
This is a function that sets the way of smoothing image backgrounds.
1 - Automatic Prevents unevenness of color and density.
2 - White Changes the area of the color that is used the most in the background to
white in order to emphasize letters and lines.
This property is enabled only when "1 - Grayscale" or "2 - RGB" is specified for the
PixelType property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

26
1.1.22 BackgroundSmoothness
.... Background color smoothness(Color cleanup smoothness)

Feature
Sets the smoothness level of the background color.

Coding Style
[form.] scancontrolname. BackgroundSmoothness [ = Short ]

Value
Value in the range from 0 (low) to 10 (high)

Default
5

Explanation
This is a function that adjusts the smoothness level of image backgrounds.
The color range for smoothing is bigger when the smoothness is set higher. The color range
for smoothing is smaller when the smoothness is set lower.
This property is enabled only when "1 - Automatic" or "2 - White" is specified for the
BackgroundSmoothing property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BackgroundSmoothing

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

27
1.1.23 BackgroundThreshold .... Background color threshold

Feature
Sets the background threshold.

Coding Style
[form.] scancontrolname. BackgroundThreshold [ = Short ]

Value
The range is from 0 (background is likely to be darker) to 100 (background is not likely to be
darker).

Default
50

Explanation
This function sets the background threshold.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

28
1.1.24 BarcodeDetection .... Barcode detection
Feature
Sets barcode detection.

Coding Style
[form.] scancontrolname.BarcodeDetection [ = Boolean ]

Value
True Barcode detection is performed.
False Barcode detection is not performed.

Default
False Barcode detection is not performed.

Explanation
Sets barcode detection.
If "True" is set for the BarcodeDetection property, the DetectBarcode, DetectBarcodeDetail
event is issued when a barcode is detected.
Refer to the DetectBarcode, DetectBarcodeDetail event.
For detection conditions on barcodes, refer to the driver help.

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on the device type, this property is set to
"False" and then a scan will be carried out.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

29
1.1.25 BarcodeDirection .... Barcode detection direction setting
Feature
Sets the direction of the barcode that is detected.

Coding Style
[form.] scancontrolname.BarcodeDirection [ = Short ]

Value
0 - Horizontal Horizontal direction
1 - Vertical Vertical direction
2 - Horizontal & Vertical Horizontal and vertical directions

Default
2 - Horizontal & Vertical Horizontal and vertical directions

Explanation
Sets the direction of the barcode that is detected.
This property is enabled only when the BarcodeDetection property is set to "True".
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BarcodeDetection

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

30
1.1.26 BarcodeMaxSearchPriorities .... Barcode maximum detection count setting
Feature
Sets the maximum number of barcodes that are detected.

Coding Style
[form.] scancontrolname.BarcodeMaxSearchPriorities [ = Short ]

Value
Value in the range from 1 to 20

Default
1

Explanation
Sets the maximum number of barcodes that are detected on one page.
This property is enabled only when the BarcodeDetection property is set to "True".
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BarcodeDetection

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

31
1.1.27 BarcodeNotDetectionNotice
.... Barcode detection notification when a barcode is not detected
Feature
Sets whether to send a barcode detection notification even if a barcode is not detected.

Coding Style
[form.] scancontrolname.BarcodeNotDetectionNotice [ = Boolean ]

Value
True Sends a barcode detection notification even if a barcode is not detected.
False Does not send a barcode detection notification if a barcode is not detected.

Default
False Does not send a barcode detection notification if a barcode is not detected.

Explanation
When "True" is set for this property, the barcode detection function works during a scan and
the DetectBarcode and DetectBarcodeDetail events can be received even if a barcode is not
detected.
For the content that you are notified about by the events, refer to the DetectBarcode and
DetectBarcodeDetail events.

Target method
StartScan

Related Properties
BarcodeDetection
BarcodeDirection
BarcodeMaxSearchPriorities
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionTop
BarcodeRegionWidth
BarcodeType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If "False" is set for the BarcodeDetection property, a scan will be executed without regard to
this property.

Compatibility and Restraints

N/A

32
1.1.28 BarcodeRegionLeft .... Barcode detection area left edge position
Feature
Sets the left edge position of the barcode detection area.

Coding Style
[form.] scancontrolname.BarcodeRegionLeft [ = Single ]

Value
Sets the left edge position of the barcode detection area.

Default
0

Explanation
Sets the left edge position of the barcode detection area.
This property is enabled only when the BarcodeDetection property is set to "True".
Set so that the barcode detection area that is set by the BarcodeRegionLeft,
BarcodeRegionLength, BarcodeRegionTop, and BarcodeRegionWidth properties forms a
rectangle.
If the BarcodeRegionLeft, BarcodeRegionLength, BarcodeRegionTop, and
BarcodeRegionWidth properties are all set to "0", the barcode detection area becomes the
entire scanning paper size.
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLength
BarcodeRegionTop
BarcodeRegionWidth
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a negative value is set, the BarcodeRegionLeft, BarcodeRegionTop, BarcodeRegionWidth,
and BarcodeRegionLength properties are all set to "0" when scanning is performed, and the
barcode detection area becomes the entire paper size.

Compatibility and Restraints

N/A

33
1.1.29 BarcodeRegionLength .... Barcode detection area length
Feature
Sets the length of the barcode detection area.

Coding Style
[form.] scancontrolname.BarcodeRegionLength [ = Single ]

Value
Sets the length of the barcode detection area.

Default
0

Explanation
Sets the length (vertical) of the barcode detection area.
This property is enabled only when the BarcodeDetection property is set to "True".
Set so that the barcode detection area that is set by the BarcodeRegionLeft,
BarcodeRegionLength, BarcodeRegionTop, and BarcodeRegionWidth properties forms a
rectangle.
If the BarcodeRegionLeft, BarcodeRegionLength, BarcodeRegionTop, and
BarcodeRegionWidth properties are all set to "0", the barcode detection area becomes the
entire scanning paper size.
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLeft
BarcodeRegionTop
BarcodeRegionWidth
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a negative value is set, the BarcodeRegionLeft, BarcodeRegionTop, BarcodeRegionWidth,
and BarcodeRegionLength properties are all set to "0" when scanning is performed, and the
barcode detection area becomes the entire paper size.

34
Compatibility and Restraints
N/A

35
1.1.30 BarcodeRegionTop .... Barcode detection area top edge position
Feature
Sets the top edge position of the barcode detection area.

Coding Style
[form.] scancontrolname.BarcodeRegionTop [ = Single ]

Value
Sets the top edge position of the barcode detection area.

Default
0

Explanation
Sets the top edge position of the barcode detection area.
This property is enabled only when the BarcodeDetection property is set to "True".
Set so that the barcode detection area that is set by the BarcodeRegionLeft,
BarcodeRegionLength, BarcodeRegionTop, and BarcodeRegionWidth properties forms a
rectangle.
If the BarcodeRegionLeft, BarcodeRegionLength, BarcodeRegionTop, and
BarcodeRegionWidth properties are all set to "0", the barcode detection area becomes the
entire scanning paper size.
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionWidth
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a negative value is set, the BarcodeRegionLeft, BarcodeRegionTop, BarcodeRegionWidth,
and BarcodeRegionLength properties are all set to "0" when scanning is performed, and the
barcode detection area becomes the entire paper size.

Compatibility and Restraints

N/A

36
1.1.31 BarcodeRegionWidth .... Barcode detection area width
Feature
Sets the width of the barcode detection area.

Coding Style
[form.] scancontrolname.BarcodeRegionWidth [ = Single ]

Value
Sets the width of the barcode detection area.

Default
0

Explanation
Sets the width of the barcode detection area.
This property is enabled only when the BarcodeDetection property is set to "True".
Set so that the barcode detection area that is set by the BarcodeRegionLeft,
BarcodeRegionLength, BarcodeRegionTop, and BarcodeRegionWidth properties forms a
rectangle.
If the BarcodeRegionLeft, BarcodeRegionLength, BarcodeRegionTop, and
BarcodeRegionWidth properties are all set to "0", the barcode detection area becomes the
entire scanning paper size.
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionTop
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a negative value is set, the BarcodeRegionLeft, BarcodeRegionTop, BarcodeRegionWidth,
and BarcodeRegionLength properties are all set to "0" when scanning is performed, and the
barcode detection area becomes the entire paper size.

Compatibility and Restraints

N/A

37
1.1.32 BarcodeType .... Barcode type setting
Feature
Sets the type of barcode that is detected.

Coding Style
[form.] scancontrolname.BarcodeType [ = Integer ]

Value
Sets the type of barcode that is detected.
1 - EAN 8
2 - EAN 13
4 - Code 3 of 9
8 - Code 128
16 - ITF
32 - UPC-A
64 - Codabar
128 - PDF417
256 - QR code
512 - Data Matrix

Default
511 All types except "512 - Data Matrix"

Explanation
Sets the type of barcode that is detected.
This property is enabled only when the BarcodeDetection property is set to "True".
If detection of multiple barcodes is set, set the total setting value.
Example:
To detect "1 - EAN8" and "2 - EAN13", set "3".
For detection conditions on barcodes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BarcodeDetection

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

38
1.1.33 Binding .... duplex binding direction

Feature
Sets the binding direction for duplex scanning.

Coding Style
[form.] scancontrolname.Binding [ = Short ]

Value
0 - Side Right and left binding
1 - Height Top and bottom binding

Default
0 - Side Right and left binding

Explanation
If the right and left binding "0 - Side" is specified, both images scanned are output as is.
If the top and bottom binding "1 - Height" is specified, only the scanned image of the back
side is output half-turned.
This property is enabled only when "2 - ADF(Duplex)" is set for the PaperSupply property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
Rotation
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

39
1.1.34 BlankPageIgnoreAreaSize .... Sides undetected during blank page detection

Feature
Sets the sides around a page to be undetected during blank page detection.

Coding Style
[form.]scancontrolname. BlankPageIgnoreAreaSize [=Short]

Value
Value in the range from 0 to 16

Default
16

Explanation
Sets the left, right, top, and bottom sides of the image to be undetected during blank page
detection.
If a value larger than 4 mm is specified for an image with the side length less than 158 mm,
the value is set to 4 mm.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageSkip
BlankPageSkipMode
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
When designed and when implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

40
1.1.35 BlankPageNotice .... Output blank page setting
Feature
Sets whether a blank page is output or not.

Coding Style
[form.]scancontrolname.BlankPageNotice [=Short]

Value
0 - OFF Not Output
1 - ON Output

Default
0 - OFF Not Output

Explanation
Sets whether blank pages are output or not when scanning.
When you specify [1 - ON] for this property, select any value other than [0] for the
BlankPageSkip property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageResult
BlankPageSkip
PaperSupply

Value Setting
When designed and when implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

41
1.1.36 BlankPageResult .... Get blank page detection results
Feature
Gets the blank page detection results.

Coding Style
[form.]scancontrolname.BlankPageResult [=Short]

Value
N/A. Property for value reference purposes only.

Default
0 No blank page was detected.

Explanation
This enables a check of whether the current page is a blank page or not when a notification
is sent for a ScanToFile, ScanToDibEx, or ScanToRawEx event.
0 No blank page was detected.
1 Blank page was detected.
This property is enabled only when "1 -ON" is set for the BlankPageNotice property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageNotice
ScanTo

Related Events
ScanToFile
ScanToDibEx
ScanToRawEx

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

42
1.1.37 BlankPageSkip .... Blank page skip sensitivity
Feature
Sets the sensitivity to scan by skipping blank pages during continuous ADF scanning.

Coding Style
[form.] scancontrolname.BlankPageSkip [ = Short ]

Value
0 - Blank pages are not skipped.
1 - 11 - Higher values result in higher likelihood of skipping.

Default
0 - Blank pages are not skipped.

Explanation
Sets the sensitivity to scan by skipping blank pages during continuous ADF scanning.
Values of the FileCounterEx property and PageCount property are not updated on pages
skipped.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageSkipMode
DivideLongPage
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
This property is ignored when the device does not support this property.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

43
1.1.38 BlankPageSkipMode .... Blank page skip mode
Feature
Sets a criteria for detecting blank pages.

Coding Style
[form.] scancontrolname.BlankPageSkipMode [ = Short ]

Value
0 - Sensitivity Sensitivity
1 - Black & White Dots Ratio Black & white dots ratio

Default
0 - Sensitivity Sensitivity

Explanation
Sets a criteria for detecting blank pages.
When "0 - Sensitivity" is set, the sensitivity set for the BlankPageSkip property is used to
detect blank pages.
When "1 - Black & White Dots Ratio" is set, the black and white dots ratios set for the
SkipBlackPage property and the SkipWhitePage property are used to detect blank pages.
If a value other than black & white is set for the PixelType property, or if a value is set to "0"
for the SkipBlackPage and SkipWhitePage properties, the sensitivity set for the
BlankPageSkip property is used.
Values of the FileCounterEx property and PageCount property are not updated on pages
skipped.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageSkip
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
This property is ignored when the device does not support this property.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

44
1.1.39 BlankPageSkipTabPage .... Blank page skip settings for index-tabbed pages
Feature
Sets whether or not index-tabbed pages are checked during blank page detection.

Coding Style
[form.] scancontrolname.BlankPageSkipTabPage [ = Short ]

Value
0 - All Pages Includes all pages
1 - Skip Tab Pages Excludes index-tabbed pages

Default
0 - All Pages Includes all pages

Explanation
Sets whether or not index-tabbed pages are checked during blank page detection.
If "0 - All pages" is set, all pages are checked.
If "1 - Skip Tab Pages" is set, pages without index tabs are checked.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
BlankPageSkip
BlankPageSkipMode
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

45
1.1.40 Brightness .... brightness
Feature
Specifies the brightness.

Coding Style
[form.] scancontrolname.Brightness [ = Short ]

Value
Between 1 (bright) and 255 (dark).

Default
128

Explanation
Sets the brightness of images when scanning.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBright
AutoSeparation
Gamma
Halftone
PixelType
PaperSupply
SEE
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
And if this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

46
1.1.41 CarrierSheetClippingMode .... Carrier Sheet clipping mode
Feature
Sets the mode for clipping the Carrier Sheet.

Coding Style
[form.] scancontrolname.CarrierSheetClippingMode [ = Short ]

Value
0 - Content Crops the document content
1 - Edge Crops the whole document
2 - Driver Setting Uses the driver settings

Default
2 - Driver Setting Uses the driver settings

Explanation
Sets the mode for clipping the Carrier Sheet.
This property is enabled when one of the values from "14 - ADF(CarrierSheet Clipping All)"
to "49 - ADF(CarrierSheet Clipping Duplex Custom)" is set for the PaperSupply property.
To output an image in the same size as a document, set "30 – ADF(CarrierSheet Clipping
Auto)" or "48 – ADF(CarrierSheet Clipping Duplex Auto)" for the PaperSupply property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

47
1.1.42 CharacterExtraction .... Extracting characters
Feature
Sets whether to extract characters or not.

Coding Style
[form.] scancontrolname.CharacterExtraction [ = Boolean ]

Value
True Extracts characters.
False Does not extract characters.

Default
False Does not extract characters.

Explanation
Processes images in order to improve OCR accuracy.
For details about character extraction, refer to the Help of the driver.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
When "True" is set for this property, the setting for the Filter property is ignored.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
CharacterExtractionMethod
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property is disabled due to the device type, set this property to "False" during scanning
execution to perform the scan. (* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

48
1.1.43 CharacterExtractionMethod .... Setting the type of character extractions
Feature
Sets the type of character extractions.

Coding Style
[form.] scancontrolname. CharacterExtractionMethod [ = Integer ]

Value
Sets the type of character extractions.
1 - ReversedTypeExtraction
Outlined characters (Inverting the color of characters from white to black)
2 - HalftoneRemoval
Shaded characters (Removing shading)
4 - StampRemoval
Characters stamped with a seal (Removing vermilion seal)

Default
7 All types

Explanation
Sets the type of character extractions to process images in order to improve OCR accuracy.
This property is enabled only when the CharacterExtraction property is set to "True".
If you want to set multiple types of character extractions, specify the total number of values
for these types.
Example:
To remove "1 - ReversedTypeExtraction " and "2 - HalftoneRemoval ", specify "3".
For details about the character extraction, refer to the Help of the driver.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
CharacterExtraction

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

49
1.1.44 CharacterThickness
.... Dynamic Threshold (iDTC) binary character thickness setting
Feature
Sets the thickness of the Dynamic Threshold (iDTC) binary character.

Coding Style
[form.] scancontrolname.CharacterThickness [ = Short ]

Value
Value in the range from 0 (narrow) to 10 (wide)

Default
5

Explanation
Sets the thickness of the Dynamic Threshold (iDTC) binary character.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 0 and 10).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

50
1.1.45 CloseSourceUI .... exit setting for the user interface (UI) of the source
Feature
Sets whether or not to close the user interface (UI) of the source after scanning.

Coding Style
[form.] scancontrolname.CloseSourceUI [ = Boolean ]

Value
True Closes the user interface of the source after scanning.
False Does not close the user interface of the source after scanning.

Default
False Does not close the user interface of the source after scanning.

Explanation
If this property is set to "True," automatically closes the user interface of the source after
scanning.
This property is enabled only when the ShowSourceUI property is set to "True."
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ShowSourceUI

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If "False" is set for the ShowSourceUI property, a scan will be executed without regard to this
property.

Compatibility and Restraints

N/A

51
1.1.46 ColorReproduction .... Color reproduction
Feature
Sets the color reproduction.

Coding Style
[form.] scancontrolname.ColorReproduction [ = Short ]

Value
0 - Contrast Prioritizes the contrast of a color
1 - Hue Prioritizes the hue of a color

Default
0 - Contrast Prioritizes the contrast of a color

Explanation
Select the way to correct the color tone when scanning documents in color.
This property is enabled only when "2 - RGB" is set for the PixelType property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow
PaperSupply
PixelType
ScanMode
sRGB

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

52
1.1.47 ColorReproductionBrightness .... Brightness when a color hue is prioritized
Feature
Specifies the brightness when a color hue is prioritized.

Coding Style
[form.] scancontrolname.ColorReproductionBrightness [ = Short ]

Value
Between 1 (bright) and 255 (dark)

Default
128

Explanation
Sets the image brightness when a color hue is prioritized for a scan.
This property is enabled only when "1 - Hue" is set for the ColorReproduction property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

53
1.1.48 ColorReproductionContrast .... Color contrast when a color hue is prioritized
Feature
Specifies the color contrast when a color hue is prioritized.

Coding Style
[form.] scancontrolname.ColorReproductionContrast [ = Short ]

Value
Between 1 (low) and 255 (high)

Default
128

Explanation
Sets the degree of difference between light and dark extremes for the scanned image when
a color hue is prioritized for a scan.
Configurable between 1 and 255.
The greater the value is, the darker the dark area and the lighter the light area of an image
will be scanned.
This property is enabled only when "1 - Hue" is set for the ColorReproduction property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

54
1.1.49 ColorReproductionCustomGamma
.... Gamma value when a color hue is prioritized
Feature
Specifies the gamma value when a color hue is prioritized.

Coding Style
[form.] scancontrolname.ColorReproductionCustomGamma [ = Single ]

Value
Between 0.1 and 10.0

Default
1.0

Explanation
Sets the gamma value when a color hue is prioritized for a scan.
For the the gamma value, refer to the CustomGamma property.
This property is enabled only when "1 - Hue" is set for the ColorReproduction property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionHighlight
ColorReproductionShadow

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 0.1 and 10.0).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

55
1.1.50 ColorReproductionHighlight .... Highlight when a color hue is prioritized
Feature
Specifies a highlight when a color hue is prioritized.

Coding Style
[form.] scancontrolname.ColorReproductionHighlight [ = Short ]

Value
Between 1 and 255

Default
255

Explanation
Sets a highlight when a color hue is prioritized for a scan.
This property is enabled only when "1 - Hue" is set for the ColorReproduction property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionShadow

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

56
1.1.51 ColorReproductionShadow .... Shadow when a color hue is prioritized
Feature
Specifies a shadow when a color hue is prioritized.

Coding Style
[form.] scancontrolname.ColorReproductionShadow [ = Short ]

Value
Between 0 and 254

Default
0

Explanation
Sets a shadow on an image when a color hue is prioritized for a scan.
This property is enabled only when "1 - Hue" is set for the ColorReproduction property.
It is not possible to set a value higher than that specified as the ColorReproductionHighlight
property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 0 and 254) or
the value set for the ColorReproductionHighlight property.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

The applicable value range for this property depends on the current
ColorReproductionHighlight property value. Therefore, the ColorReproductionHighlight
property must be set first.

57
1.1.52 CompressionType .... data compression type
Feature
Sets the data compression type,

Coding Style
[form.] scancontrolname.CompressionType [ = Short ]

Value
0 - No Compress No (not compressing)
1 - CCITT G3(1D) MH compression
2 - CCITT G3(2D) KFactor = 2 MR compression K Factor 2
3 - CCITT G3(2D) KFactor = 4 MR compression K Factor 4
4 - CCITT G4 MMR compression
5 - JPEG JPEG compression
6 - Old JPEG Old JPEG compression (TIFF file only)

Default
4 - CCITT G4 MMR compression

Explanation
Specifies the data compression type.
This property is enabled when the ScanTo property is set to "0 - File" and the FileType
property is set to "1 - TIF," "2 - Multipage TIF," "4 - PDF" or "5 - Multipage PDF" or when the
ScanTo property is set to "2 - Raw Image Handle." Otherwise, it will be disregarded.
When the FileType property is set to "0 - BMP", this property operates as if set to "0 - No
Compress" regardless of the actual setting.
When the FileType property is set to "3 - JPEG", this property operates as if set to "5 -
JPEG" regardless of the actual setting.
When the ScanTo property is set to "2 - Raw Image Handle", and this property is set to "6 -
Old JPEG", this property operates as if set to "5 - JPEG".

For binary (black and white) compression with the PixelType property set to "0 - Black &
White," the suitable values to set for this property include "1 - CCITT G3(1D) ," " 2 - CCITT
G3(2D) KFactor = 2," " 3 - CCITT G3(2D) Kfactor = 4" and "4 - CCITT G4." For color image
compression with the PixelType property set to "2 - RGB," the suitable value to set for this
property is "5 - JPEG."
However, for the compression to be carried out in such case (as the halftone is specified for
the Halftone property - when a value from 1 to 4 is specified for this property) the expected
compression rate cannot be guaranteed. Because the above compression shall be, in
principle, specified for binary (black and white) images.

When the PixelType property is set to "1 - Grayscale" or "2 - RGB" and when it is specified
that the compression is carried out by this property (its value set to "1 - CCITT G3(1D) ," " 2 -
CCITT G3(2D) KFactor = 2," " 3 - CCITT G3(2D) Kfactor = 4" or "4 - CCITT G4"), scanning is
done in binary (black and white) mode.

When set to "2 - CCITT G3(2D) KFactor = 2" or "3 - CCITT G3(2D) Kfactor = 4" in the
PaperStream IP (TWAIN) driver, this property operates as it is set to "3 - CCITT G3(2D)
Kfactor = 4".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

58
Related Properties
FileType
JpegQuality
PaperSupply
PixelType
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
For invalid combinations specified, if the FileType property is set to either 4-PDF or
5-Multipage PDF, scanning will be done with the setting of 4-CCITT G4. Otherwise it will be
done with the setting of 0-No Compress.

Compatibility and Restraints

N/A

59
1.1.53 Contrast .... contrast
Feature
Sets the contrast.

Coding Style
[form.] scancontrolname.Contrast [ = Short ]

Value
Between 1 (low) and 255 (high).

Default
128

Explanation
Sets the degree of difference between light and dark extremes for the scanned image.
Configurable between 1 and 255.
The greater the value is, the darker the dark area and the lighter the light area of an image
will be scanned.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBright
Gamma
PaperSupply
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).

Compatibility and Restraints

N/A

60
1.1.54 CropMarginSize .... Sizes of cropping margins
Feature
Specifies the sizes of cropping margins.

Coding Style
[form.] scancontrolname.CropMarginSize [ = Single ]

Value
Between -5 and 5
(Between -5 and -1: Cropping inside)
(Between 1 and 5: Cropping outside)

Default
0

Explanation
Specifies the sizes of cropping margins.
This property is enabled only when the AutoBorderDetection property is set to "TRUE".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
FrontBackMergingEnabled
SelectOutputSize
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value will not be updated if it is set outside the range (between -5 and 5).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

For future expansion, the coding type is set to [ = Single ]. Make sure that the decimal part is
0.

61
1.1.55 CropPriority .... Priority setting during automatic paper size detection
Feature
Sets the priority during automatic paper size detection.

Coding Style
[form.] scancontrolname.CropPriority [ = Short ]

Value
0 - Speed Speed priority
1 - Accuracy Accuracy priority

Default
0 - Speed Speed priority

Explanation
Sets the priority during automatic paper size detection.
This property is enabled only when the AutoBorderDetection property is set to "TRUE".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
PaperSupply
ScanMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

62
1.1.56 CustomGamma .... custom gamma
Feature
Specifies the gamma value.

Coding Style
[form.] scancontrolname.CustomGamma [ = Single]

Value
Between 0.1 and 10.0.

Default
2.2

Explanation
Sets any gamma value (custom value).
This property is enabled only when the Gamma property is set to "4 - Custom."
<Gamma value>
Value for correcting the nonlinearity of an image, configurable between 0.1 and 10.0.
Linearity needs to be adjusted because while the sensor in the scanner gives linear output in
relation to the density of the light reflected from a document, most output terminals (CRT,
etc.) do not give linear output in relation to the input.
Generally speaking, it is lighter if the gamma value is greater than 1, and darker if the
gamma value is smaller than 1.
(The figure below shows relationship between gamma value () and input/output value.)
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan 255
(dark) <1
Related Properties =1
Gamma
PaperSupply
output
値

Value Setting
>1
When designed and when implemented.

Value Reference 0(light) 255

When implemented. input
(dark)
Error Recovery
Value will not be updated if set beyond the setting range (value not between 0.1 and 10.0).
This property is disregarded if the Gamma property is set to any value other than "4 -
Custom."
And if this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

63
1.1.57 CustomPaperLength .... custom document length
Feature
Sets the length of a custom-sized document.

Coding Style
[form.] scancontrolname.CustomPaperLength [ = Single ]

Value
Sets the length of a custom-sized document.

Default
1

Explanation
Sets the scanning length.
This property is enabled only when the document size is set to "99 - Custom" for the
PaperSize property.
Sets 2 inches (51 mm) and performs a scan when a value smaller than 2 inches (51 mm) is
specified while the PaperSupply property is specified with "7 - ADF(CarrierSheet Clipping)."
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
FrontBackMergingEnabled
LongPage
PaperSize
PaperSupply
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
This property is disregarded if the PaperSize property is set to any value other than "99 -
Custom."
And when long page document is NOT scanned specified by LongPage property, if the value
set is longer than the physical length of the device, the value will be set to the physical length
of the device when scanning to carry out a scan.
When long page document is scanned specified by LongPage property, the document longer
than the physical length of the device can be scanned. But if the length excesses the
maximum value of LongPage, the scanning is carried out with the maximum value of
LongPage.
With the FUJITSU TWAIN32 driver is used, if the value set is smaller than 1 inch (26 mm),
the value will be set to 1 inch (26 mm) during prescan.
With the PaperStream IP (TWAIN) driver is used, if the value set is smaller than 1 inch (25.4
mm), the value will be set to 1 inch (25.4 mm) during prescan.

64
Compatibility and Restraints
At long page documents scanning, if the value set is longer than the maximum value of
LongPage, scanning is carried out with maximum value that is possible to scan. However, it
will not be changed to the maximum value after the property is executed.

65
1.1.58 CustomPaperWidth .... custom document width
Feature
Sets the width of a custom-sized document.

Coding Style
[form.] scancontrolname.CustomPaperWidth [ = Single ]

Value
Sets the width of a custom-sized document.

Default
1

Explanation
Sets the scanning width.
This property is enabled only when the document size is set to "99 - Custom" for the
PaperSize property.
Sets 2 inches (51 mm) and performs a scan when a value smaller than 2 inches (51 mm) is
specified while the PaperSupply property is specified with "7 - ADF(CarrierSheet Clipping)."
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSize
PaperSupply
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
This property is disregarded if the PaperSize property is set to any value other than "99 -
Custom."
And if the value set is longer than the physical width of the device, the value will be set to the
physical width of the device when scanning to carry out a scan.
With the FUJITSU TWAIN32 driver is used, if the value set is smaller than 1 inch (26 mm),
the value will be set to 1 inch (26 mm) during prescan.
With the PaperStream IP (TWAIN) driver is used, if the value set is smaller than 1 inch (25.4
mm), the value will be set to 1 inch (25.4 mm) during prescan.

Compatibility and Restraints

N/A

66
1.1.59 CustomResolution .... custom resolution
Feature
Specifies the scan resolution.

Coding Style
[form.] scancontrolname.CustomResolution [ = Short ]

Value
Between 50 and 600 [dpi].

Default
300

Explanation
Sets the scan resolution.
This property is enabled only when the Resolution property is set to "99 - Custom."
However, even if the resolution is supported by the device, scanning may not be possible
due to the size of a document to scan, etc.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Resolution
PaperSize
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 50 and 600).
And if the resolution not supported by the device is set, the default value will be set when
scanning to carry out a scan.
* Available scan resolution varies with device.
Refer to the User's Guide for your device.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

The default has been changed to 300 instead of 400 since V2.0L10.

67
1.1.60 Deskew .... Skew correction
Feature
Sets the skew correction.

Coding Style
[form.] scancontrolname.Deskew [ = Short ]

Value
0 - Edge Corrects skew of the document edges.
1 - Documents Corrects skew in the document content.
2 - OFF Does not correct skew.

Default
2 - OFF Does not skew correction.

Explanation
Sets the skew correction.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order”.

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
DivideLongPage
FrontBackMergingEnabled
LengthDetection
OverScan
PaperSupply
UndefinedScanning

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

68
1.1.61 DeskewBackground .... Background color used for skew correction
Feature
Sets whether or not to fill in the areas around the scanned image that are produced as a
result of skew correction with the contents deskew function.

Coding Style
[form.] scancontrolname.DeskewBackground [ = Short ]

Value
0 - None No fill in.
1 - Background Background color fill in.

Default
0 - Background Background color fill in.

Explanation
Sets whether to fill in or not to fill in the areas around the scanned image that are produced
as a result of skew correction with the contents deskew function.
When "0 - None" is set for this property, the areas are black for a device that supports a
black background, and the areas are white for a device that does not support a black
background. When "0 - Flatbed" is set for the PaperSupply property, regardless of the device
background specification, the areas are black.
This property is enabled only when the Deskew property is specified with a setting other than
"2 - OFF".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Deskew
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

69
1.1.62 DeskewMode .... Deskew mode
Feature
Sets the driver's deskew setting in [Configuration].

Coding Style
[form.] scancontrolname.DeskewMode [ = Short ]

Value
0 - OFF
1 - ON

Default
1 - ON

Explanation
Sets the deskew setting for [Deskew Method] in the driver's [Configuration] window.
This property is enabled only when the Deskew property is specified with a setting other than
"2 - OFF".
If "1 - ON" is set, a value set in the Deskew property is applied to [Deskew Method] in the
driver's [Configuration] window.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Deskew

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

70
1.1.63 DigitalEndorser .... Digital endorser setting
Feature
Sets whether the digital endorser is used.

Coding Style
[form.] scancontrolname.DigitalEndorser [ = Boolean ]

Value
True Digital endorser is used.
False Digital endorser is not used.

Default
False Digital endorser is not used.

Explanation
Sets whether the digital endorser is used.
Outputting is performed on the front side.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property is disabled due to the device type, set this property to "False" during scanning
execution to perform the scan. (* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

71
1.1.64 DigitalEndorserCountDirection
.... Digital endorser counter step direction setting
Feature
Sets the step direction of the digital endorser counter.

Coding Style
[form.] scancontrolname.DigitalEndorserCountDirection [ = Short ]

Value
0 - Add Increases.
1 - Del Decreases.

Default
0 - Add Increases.

Explanation
Sets the step direction (increase/decrease) of the digital endorser counter.
This property is enabled only when the DigitalEndorser property is set to "True".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

72
1.1.65 DigitalEndorserCounter .... Digital endorser counter default value setting
Feature
Sets the default value of the digital endorser counter.

Coding Style
[form.] scancontrolname.DigitalEndorserCounter [ = Integer ]

Value
Value in the range from -1 and 0 to 99999999
When -1 is set, the digital endorser counter does not operate for outputting.

Default
0

Explanation
Sets the default value of the digital endorser counter.
If -1 is set as the setting value, the digital endorser counter does not output.
If DigitalEndorserString includes the counter character string (such as the 5-digit "%05ud"),
the setting value is 3 to 8 digits (0 to 99999999), and if it does not include the character
string, the setting value is 5 digits (0 to 99999).
This property is enabled only when the DigitalEndorser property is set to "True".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value is not updated if it is set outside the setting range.
The value is shifted if the setting value range is exceeded due to increasing or decreasing of
the digital endorser counter. If the value is 5 digits, 99999 is followed by 0.
If a jam or multifeed occurs during scanning operation where outputting is enabled, the
output counter value may differ from the expected value for subsequent scanning operations.
As a result, when resuming scanning after an error has occurred, be sure to set the default
value of the imprinter counter.

Compatibility and Restraints

To determine whether the setting value of this property is beyond the setting range,
DigitalEndorserString value at the time is referred to. Therefore, set the
DigitalEndorserString before setting the DigitalEndorserCounter.

73
1.1.66 DigitalEndorserCountStep .... Digital endorser counter step value setting
Feature
Sets the step value of the digital endorser counter.

Coding Style
[form.] scancontrolname.DigitalEndorserCountStep [ = Short ]

Value
0 - None No step count
1 - 1 Step In increments of one step count.
2 - 2 Step In increments of two step counts.

Default
1 - 1 Step In increments of one step count.

Explanation
Sets the step value of the digital endorser counter.
This property is enabled only when the DigitalEndorser property is set to "True".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".
Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

74
1.1.67 DigitalEndorserDirection .... Digital endorser output direction setting
Feature
Sets the output direction for the digital endorser.

Coding Style
[form.] scancontrolname.DigitalEndorserDirection [ = Short ]

Value
0 - Top to Bottom Outputs from top to bottom.
1 - Left to Right Outputs from left to right.

Default
0 - Top to Bottom Outputs from top to bottom.

Explanation
Sets the output direction for the digital endorser.
This property is enabled when the DigitalEndorser property is set to "True".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

75
1.1.68 DigitalEndorserString .... Digital endorser character string setting
Feature
Sets the digital endorser character string.

Coding Style
[form.] scancontrolname.DigitalEndorserString [ = String ]

Value
For details about values, refer to the Explanatory materials for the driver.
250 alphanumeric characters or less
Alphabets : A - Z, a - z
Numbers : 0, 1 - 9
Symbols : !”#$%&’()*+,-./:;<=>?@[\]^_`{|}~
Other characters : (space)
If you output "%", you must specify it as "%%".

Default
"" (empty character string)

Explanation
Sets the digital endorser character string.
Appends 5 digit string "%05ud" to the end of the specified string, when 0 or more is specified
for the DigitalEndorserCounter property and a counter character string is not included in this
property.
This property is enabled only when the DigitalEndorser property is set to "True".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Characters that exceed the maximum number of characters for the digital endorser (including
the counter) are not outputted.

Compatibility and Restraints

N/A

76
1.1.69 DigitalEndorserXOffset
.... Digital endorser output start position (X offset) setting
Feature
Sets the digital endorser output start position (X offset).

Coding Style
[form.] scancontrolname.DigitalEndorserXOffset [ = Single ]

Value
Sets the digital endorser output start position (X offset).

Default
0

Explanation
Sets the digital endorser output start position (X offset).
This property is enabled only when the DigitalEndorser property is set to "True".
For details on the output enable area for the digital endorser, refer to the Help for
PaperStream IP (TWAIN) driver.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserYOffset
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
Even if a value except a output enable range is set, outputting will be done the maximum of a
output possibility range.

Compatibility and Restraints

N/A

77
1.1.70 DigitalEndorserYOffset
.... Digital endorser output start position (Y offset) setting
Feature
Sets the digital endorser output start position (Y offset).

Coding Style
[form.] scancontrolname.DigitalEndorserYOffset [ = Single ]

Value
Sets the digital endorser output start position (Y offset).

Default
0

Explanation
Sets the digital endorser output start position (Y offset).
This property is enabled only when the DigitalEndorser property is set to "True".
For details on the output enable area for the digital endorser, refer to the Help for
PaperStream IP (TWAIN) driver.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
Even if a value except a output enable range is set, outputting will be done the maximum of a
output possibility range.

Compatibility and Restraints

N/A

78
1.1.71 DivideLongPage .... Dividing long pages
Feature
Sets whether or not to divide long pages.

Coding Style
[form.] scancontrolname.DivideLongPage [ = Boolean]

Value
True Divides long pages
False Does not divide long pages

Default
False Does not divide long pages

Explanation
Sets whether or not to divide a long page into multiple images.
Specify the length of each page in the PaperSize property.
- When "True" is set for this property:
・ If "4 - ADF(CarrierSheet Spread A3)" - "49 - ADF(CarrierSheet Clipping Duplex
Custom)" has been set for the PaperSupply property, the operation is not guaranteed.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
MultiStreamMode
PaperSize

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Some setting values are not supported depending on the specific device.
(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

79
1.1.72 DoubleFeed .... double feed detection
Feature
This property ceased to be supported after V2.0L10.

Compatibility and Restraints

This property is provided for compatibility.
Provided as a compatible for recompiling the source program created by a version of SDK
older than V2.0L10 as is using an SDK version V2.0L10 or later. Note that compiling may
become impossible in the future, should a major update of the version be conducted. Use
the MultiFeed property rather than this property to newly create applications or modify
existing programs.

80
1.1.73 DTCSensitivity .... Dynamic Threshold (iDTC) binary sensitivity setting
Feature
Sets the Dynamic Threshold (iDTC) binary sensitivity.

Coding Style
[form.] scancontrolname.DTCSensitivity [ = Short ]

Value
Value in the range from 0 (low) to 100 (high)

Default
50

Explanation
Sets the Dynamic Threshold (iDTC) binary sensitivity.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 0 and 100).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

81
1.1.74 EdgeFiller .... Edge filler
Feature
Sets the edge filler.

Coding Style
[form.] scancontrolname.EdgeFiller [ = Short ]

Value
0 - Off Edge is not filled.
1 - Black Edge is filled with black.
2 - White Edge is filled with white.

Default
0 - Off Edge is not filled.

Explanation
The excess data for the document shadow and other sections that appear at the edge of the
scanned image are filled with a specified color for improving the appearance.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

82
1.1.75 EdgeFillerBottom .... Edge filler bottom edge area setting
Feature
Sets the edge filler area at the bottom edge of the paper size.

Coding Style
[form.] scancontrolname.EdgeFillerBottom [ = Single ]

Value
Sets the edge filler area at the bottom edge of the paper size.

Default
0

Explanation
Sets how much of the area is filled from the bottom edge of the paper size.
This property is enabled only when the EdgeFiller property is specified with a setting other
than "0 - OFF".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a value larger than 1 cm (0.394 in) is set, 1 cm (0.394 in) is set during scanning, and the
edge filler process is performed.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

83
1.1.76 EdgeFillerLeft .... Edge filler left edge area setting
Feature
Sets the edge filler area at the left edge of the paper size.

Coding Style
[form.] scancontrolname.EdgeFillerLeft [ = Single ]

Value
Sets the edge filler area at the left edge of the paper size.

Default
0

Explanation
Sets how much of the area is filled from the left edge of the paper size.
This property is enabled only when the EdgeFiller property is specified with a setting other
than "0 - OFF".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a value larger than 1 cm (0.394 in) is set, 1 cm (0.394 in) is set during scanning, and the
edge filler process is performed.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

84
1.1.77 EdgeFillerRight .... Edge filler right edge area setting
Feature
Sets the edge filler area at the right edge of the paper size.

Coding Style
[form.] scancontrolname.EdgeFillerRight [ = Single ]

Value
Sets the edge filler area at the right edge of the paper size.

Default
0

Explanation
Sets how much of the area is filled from the right edge of the paper size.
This property is enabled only when the EdgeFiller property is specified with a setting other
than "0 - OFF".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a value larger than 1 cm (0.394 in) is set, 1 cm (0.394 in) is set during scanning, and the
edge filler process is performed.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

85
1.1.78 EdgeFillerTop .... Edge filler top edge area setting
Feature
Sets the edge filler area at the top edge of the paper size.

Coding Style
[form.] scancontrolname.EdgeFillerTop [ = Single ]

Value
Sets the edge filler area at the top edge of the paper size.

Default
0

Explanation
Sets how much of the area is filled from the top edge of the paper size.
This property is enabled only when the EdgeFiller property is specified with a setting other
than "0 - OFF".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If a value larger than 1 cm (0.394 in) is set, 1 cm (0.394 in) is set during scanning, and the
edge filler process is performed.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

86
1.1.79 EdgeRepair .... Edge filler repair
Feature
Sets the edge filler repair.

Coding Style
[form.] scancontrolname.EdgeRepair [ = Boolean ]

Value
True Edge filler is repaired.
False Edge filler is not repaired.

Default
False Edge filler is not repaired.

Explanation
This repairs bends of the document and other problems that appear on the edge of the
scanned image.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
DivideLongPage
FrontBackMergingEnabled
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

87
1.1.80 Endorser .... Endorser / Imprinter setting
Feature
Sets whether or not to use the endorser/imprinter.

Coding Style
[form.] scancontrolname.Endorser [ = Boolean ]

Value
True Uses the endorser/imprinter.
False Does not use the endorser/imprinter.

Default
False Does not use the endorser/imprinter.

Explanation
Sets whether or not to use the endorser/imprinter.
Enabled for scanners with an endorser/imprinter option.
Some scanners support both the Pre-imprinter (Pre-endorser) and Post-imprinter
(Post-endorser).If these two types of imprinters (endorsers) are installed together, the
Post-imprinter (Post-endorser) has higher priority than the Pre-imprinter (Pre-endorser) for
printing; if either of these imprinters (endorsers) is installed, and the installed one is used for
printing.
Some scanners support both the Post-imprinter front (Post-endorser front) and
Post-imprinter back (Post-endorser back).If these two types of imprinters (endorsers) are
installed together, the Post-imprinter front (Post-endorser front) has higher priority than the
Post-imprinter back (Post-endorser back) for printing.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
And if this property cannot be enabled depending on device type, sets it to "False" when
scanning to carry out a scan. (* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

88
1.1.81 EndorserCountDirection
.... Endorser / Imprinter counter step direction setting
Feature
Sets the step direction of the endorser/imprinter counter.

Coding Style
[form.] scancontrolname.EndorserCountDirection [ = Short ]

Value
0 - Add Adds.
1 - Del Deletes.

Default
0 - Add Adds.

Explanation
Sets the step direction (increase/decrease) of the endorser/imprinter counter.
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserFont
EndorserOffset
EndorserString

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

89
1.1.82 EndorserCounter .... Endorser / Imprinter counter default setting
Feature
Sets the default of the endorser/imprinter counter.

Coding Style
[form.] scancontrolname.EndorserCounter [ = Integer ]

Value
Values in the range of -1 and 0 to 99999999 (when the PaperStream IP (TWAIN) driver is
used)
Values in the range of -1 and 0 to 16777215 (when the FUJITSU TWAIN32 driver is used)
When -1 is set, the endorser/imprinter counter does not operate for printing.

Default
0

Explanation
Sets the default of the endorser/imprinter counter.
When -1 is set as the setting value, the endorser/imprinter counter does not operate for
printing.
With the PaperStream IP (TWAIN) driver, 3 to 8 digits (0 to 99999999) can be set for the
value if a counter character string (such as a 5 digit string "%05ud") is included in
EndorserString. If it is not included, a 5 digit value (0 to 99999) can be set.
With the FUJITSU TWAIN32 driver, 8 digits (0 to 16777215) or 3 to 7 digits (0 to 99999) can
be set for the value if a counter character string is included in EndorserString. If it is not
included, a 5 digit value (0 to 99999) can be set.
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCountDirection
EndorserCountStep
EndorserDirection
EndorserFont
EndorserOffset
EndorserString

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
The imprinter/endorser counter is reset to zero when the setting range (either in increment or
decrement mode) is exceeded. For example, if the counter is of five digits, it is reset to zero
when the maximum count (99999) is reached. Note that the counting results with an
eight-digit counter vary depending on the scanner model to use. For details, refer to the

90
Explanatory materials for the TWAIN driver.
If a paper jam or multifeed occurs during a scan with printing enabled, the printing counter
value for the following scan may differ from the expected value. Therefore, before restarting
the scan that was interrupted by an error, make sure to set the initial value of the printing
counter.

Compatibility and Restraints

To determine whether the setting value of this property is beyond the setting range, Endorser
String value at the time is referred to. Therefore, set the Endorser String before setting the
Endorser Counter.

91
1.1.83 EndorserCountStep .... Endorser / Imprinter counter step count setting
Feature
Sets the step count of the endorser/imprinter counter.

Coding Style
[form.] scancontrolname.EndorserCountStep [ = Short ]

Value
0 - None No step count
1 - 1 Step In increments of one step count.
2 - 2 Step In increments of two step counts.

Default
1 - 1 Step In increments of one step count.

Explanation
Sets the step count of the endorser/imprinter counter.
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCountDirection
EndorserCounter
EndorserDirection
EndorserFont
EndorserOffset
EndorserString

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

92
1.1.84 EndorserDialog .... Endorser / Imprinter print settings window
Feature
Sets whether or not to display the endorser/imprinter print settings window when scanning
starts.

Coding Style
[form.] scancontrolname.EndorserDialog [ = Short ]

Value
0 - OFF The endorser/imprinter print settings window is not displayed.
1 - ON The endorser/imprinter print settings window is displayed.

Default
0 - OFF The endorser/imprinter print settings window is not displayed.

Explanation
Sets whether or not to display the endorser/imprinter print settings window when scanning
starts.
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
For details on the displayed window, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

93
1.1.85 EndorserDirection .... Endorser / Imprinter print direction setting
Feature
Sets the print direction of the endorser/imprinter.

Coding Style
[form.] scancontrolname.EndorserDirection [ = Short ]

Value
1 - ToUnder Prints from top to bottom.
3 - ToUpper Prints from bottom to top.

Default
1 - ToUnder Prints from top to bottom.

Explanation
Sets the print direction of the endorser/imprinter,
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCountDirection
EndorserCounter
EndorserCountStep
EndorserFont
EndorserOffset
EndorserString

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

94
1.1.86 EndorserFont .... Endorser / Imprinter print font setting
Feature
Sets the print font of the endorser/imprinter.

Coding Style
[form.] scancontrolname.EndorserFont [ = Short ]

Value
0 - Horizontal Horizontal standard font
1 - Vertical Vertical standard font
2 - Horizontal-Narrow Horizontal narrow font
3 - Horizontal-Bold Horizontal bold font
4 - Vertical-Bold Vertical bold font

Default
0 - Horizontal Horizontal standard font

Explanation
Sets the print font of the endorser/imprinter.
This property is enabled only when the Endorser property is set to "True".
This is enabled only for scanners that include the endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCountDirection
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserOffset
EndorserString

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

95
1.1.87 EndorserOffset .... Endorser / Imprinter start print position setting
Feature
Sets the print start position of the endorser/imprinter.

Coding Style
[form.] scancontrolname.EndorserOffset [ = Single ]

Value
Sets the print start position of the endorser/imprinter.
Default
0

Explanation
Sets the print start position of the endorser/imprinter.
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
For the printable area of the endorser/imprinter, refer to the User's Guide for your device.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCountDirection
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserFont
EndorserString
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Even if a value except a printable range is set, printing will be done the maximum of a print
possibility range.

Compatibility and Restraints

N/A

96
1.1.88 EndorserString .... Endorser / Imprinter string setting
Feature
Sets the string for the endorser/imprinter.

Coding Style
[form.] scancontrolname.EndorserString [ = String ]

Value
For details about values, refer to the Explanatory materials for the driver.
40 alphanumeric characters or less
Alphabets : A - Z, a - z
Numbers : 0, 1 - 9
Symbols : !"#$%&'()*+,-./:;<=>?@[ 〵 ]^_`{|}~
Others : (space)
If you print "%", you must specify it as "%%".

Default
"" (empty character string)

Explanation
Sets the string for the endorser/imprinter.
The specified character string is printed on the document by the endorser/imprinter.
Appends 5 digit string "%05ud" to the end of the specified string, when 0 or more is specified
for the EndorserCounter property and a counter character string is not included in this
property.
This property is enabled only when the Endorser property is set to "True."
Enabled for scanners with an endorser/imprinter option.
(* Refer to "Reference Manual (Separate Volume).")
For the maximum number of characters for the endorser/imprinter, refer to the User's Guide
for your device.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Endorser
EndorserCountDirection
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserFont
EndorserOffset

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The number of characters (including the Counter) printable with endorser/imprinter is limited,
and those exceed the maximum number are not printed.

97
Compatibility and Restraints
N/A

98
1.1.89 ErrorCode .... Error information acquisition
Feature
Gets error information.

Coding Style
[form.] scancontrolname.ErrorCode [ = Long]

Value
N/A Property only for value reference purpose.

Default
0x00000000 : EC_SUCCESS No error

Explanation
Property to get error information when methods end abnormally.
Initialized to EC_SUCCESS when methods are called.
See the Error List in section "3.1 Error code and how to fix error."

Target method
All methods except AboutBox.

Related Properties
SilentMode

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

-Includes errors displayed by the TWAIN driver.
-Depending on the specifications of the scanner, a paper jam (0x00000003:EC_JAM) may
be reported at the next scan, not at the completion of the target document processing.
Specifically, it is the case where the document does not pass the top sensor after the leading
end of the document reaches the top sensor inside the scanner.

99
1.1.90 FadingCompensation
.... Dynamic Threshold (iDTC) binary fading compensation
Feature
Sets the compensation of the fading section of the image during Dynamic Threshold (iDTC)
binary scanning.

Coding Style
[form.] scancontrolname.FadingCompensation [ = Short ]

Value
0 - No compensation is performed.
1-5 - Higher values result in higher likelihood of compensation.

Default
0 - No compensation is performed.

Explanation
Sets the compensation of the fading section of the image during Dynamic Threshold (iDTC)
binary scanning.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
This property is ignored when the device does not support this property.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

100
1.1.91 FileCounter .... file serial number setting

Feature
Sets the serial numbers of files.
This is a compatible property. Use the FileCounterEx property.

Coding Style
[form.] scancontrolname.FileCounter [ = Integer ]

Value
Value in the range from -1 and 0 to 65535
If -1 is set, the serial number setting is not used.

Default
1

Explanation
Sets the beginning of a "serial number" for the file name when saving.
The file actually created will be "FileName property" plus "serial number.” extension. (For
"Multipage TIFF" and "Multipage PDF," the value of the FileCounter property when the
StartScan method is called will be used for the file name, and the filename remains the same
until a scan is complete (until the StartScan call ends).
This property is incremented (increased by 1 count) every time a sheet (page) is scanned.
(For "Multipage TIFF" and "Multipage PDF," too, the number of scanned sheets (pages) will
be increased from when the StartScan method is called until a scan is complete (until the
StartScan call ends).
If the scan count exceeds 65535, it will be reset to 1 to continue scanning.
If duplex scanning is specified, this property is incremented by 2 per sheet (face and back - 2
pages).
If "-1" is set for this property, a serial number is not set for the file name, and only the file
name is used.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
FileCounterEx
FileName
FileType
MultiStreamFileNameMode
MultiStreamMode
ScanCount

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value is not updated if it is set to a value outside the range (outside the range of -1 and
0 to 65535).

101
Compatibility and Restraints
- This is a compatible property which can be re-compiled when using SDK V2.3L40 or later.
However, you cannot compile this property after a major version upgrade that may occur in
the future. When creating a new application or when fixing a program, use the
FileCounterEx property instead of FileCounter.

102
1.1.92 FileCounter1, FileCounter2, FileCounter3
.... file serial number settings for files created from each output image

Feature
Sets an initial value for each serial number that will be added to a file name when a file
created from each output image is saved.
This is a compatible property. Use the FileCounterEx1, FileCounterEx2, FileCounterEx3
property.

Coding Style
[form.] scancontrolname.FileCounter1 [ = Integer ]
[form.] scancontrolname.FileCounter2 [ = Integer ]
[form.] scancontrolname.FileCounter3 [ = Integer ]

Value
Value in the range from -1 and 0 to 65535
If -1 is set, the serial number setting is not used.

Default
1

Explanation
Sets an initial value for each serial number that will be added to a file name for each image
when multiple images created from a side of a document that is scanned are output.
Files that are actually created have the following names.
“FileName1 property“＋“Serial number“ (The initial value is FileCounter1).extension
“FileName2 property“＋“Serial number“ (The initial value is FileCounter2).extension
“FileName3 property“＋“Serial number“ (The initial value is FileCounter3).extension
Every time a sheet (one page) is scanned, the value for this property is incremented by 1.
If the scan count exceeds 65535, it will be reset to 1 to continue scanning.
If duplex scanning is specified, this property is incremented by 2 per sheet (face and back - 2
pages).
When "-1" is set for this property, the serial number is not added to the file name.
This property is enabled when "1 - 2 MultiImage" or "2 - 3 MultiImage" is set for the
MultiStreamMode propety and "1 – ON" is set for the MultiStreamFileNameMode property.
This property cannot be used together with the FileName property.
Do not configure this property in the MultiStreamPropertySetting event of the
MultiStreamMode property. Configure this property before the StartScan method instead.
This property cannot be configured in the MultiStreamPropertySetting event.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
FileCounterEx1, FileCounterEx2, FileCounterEx3
FileName1, FileName2, FileName3
FileType
MultiStreamFileNameMode
MultiStreamMode
ScanCount

103
Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value is not updated if it is set to a value outside the range (outside the range of -1 and
0 to 65535).
Compatibility and Restraints
- This property does not support Java.
- This is a compatible property which can be re-compiled when using SDK V2.3L40 or later.
However, you cannot compile this property after a major version upgrade that may occur in
the future. When creating a new application or when fixing a program, use the
FileCounterEx1, FileCounterEx2, FileCounterEx3 property instead of FileCounter1,
FileCounter2, FileCounter3.

104
1.1.93 FileCounterEx .... file serial number setting

Feature
Sets the serial numbers of files.

Coding Style
[form.] scancontrolname.FileCounterEx [ = Integer ]

Value
Value in the range from -2, -1 and 0 to 99999999
If -2 is set, the file serial number setting is not used.
If -1 is set, the file serial number is set based on a value for the FileCounter property.

Default
-1

Explanation
Sets the beginning of a "serial number" for the file name when saving.
The file actually created will be "FileName property" plus "serial number.” extension. (For
"Multipage TIFF" and "Multipage PDF," the value of the FileCounterEx property when the
StartScan method is called will be used for the file name, and the filename remains the same
until a scan is complete (until the StartScan call ends).
This property is incremented (increased by 1 count) every time a sheet (page) is scanned.
(For "Multipage TIFF" and "Multipage PDF," too, the number of scanned sheets (pages) will
be increased from when the StartScan method is called until a scan is complete (until the
StartScan call ends).
If the scan count exceeds 99999999, it will be reset to 1 to continue scanning.
If duplex scanning is specified, this property is incremented by 2 per sheet (face and back - 2
pages).
If "-2" is set for this property, a file serial number is not set for the file name, and only the file
name is used.
If “-1” is set for this property, a file seria number is set by the FileCounter property.
If “0” to “99999999” is set for this property, the FileCounter property value is not used.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
FileCounter
FileName
FileType
MultiStreamFileNameMode
MultiStreamMode
ScanCount

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value is not updated if it is set to a value outside the range (outside the range of -2, -1

105
and 0 to 99999999).
Compatibility and Restraints
N/A

106
1.1.94 FileCounterEx1, FileCounterEx2, FileCounterEx3
.... file serial number settings for files created from each output image

Feature
Sets an initial value for each serial number that will be added to a file name when a file
created from each output image is saved.

Coding Style
[form.] scancontrolname.FileCounterEx1 [ = Integer ]
[form.] scancontrolname.FileCounterEx2 [ = Integer ]
[form.] scancontrolname.FileCounterEx3 [ = Integer ]

Value
Value in the range from -2, -1 and 0 to 99999999
If -2 is set, the file serial number setting is not used.
If -1 is set, the file serial number is set based on a value for the FileCounter1 property, the
FileCounter2 property, and the FileCounter3 property.

Default
-1

Explanation
Sets an initial value for each serial number that will be added to a file name for each image
when multiple images created from a side of a document that is scanned are output.
Files that are actually created have the following names.
“FileName1 property“＋“Serial number“ (The initial value is FileCounterEx1).extension
“FileName2 property“＋“Serial number“ (The initial value is FileCounterEx2).extension
“FileName3 property“＋“Serial number“ (The initial value is FileCounterEx3).extension
Every time a sheet (one page) is scanned, the value for this property is incremented by 1.
If the scan count exceeds 99999999, it will be reset to 1 to continue scanning.
If duplex scanning is specified, this property is incremented by 2 per sheet (face and back - 2
pages).
When "-2" is set for this property, the serial number is not added to the file name.
If “-1” is set for this property, a file seria number is set by the FileCounter1 property, the
FileCounter2 property, and the FileCounter3 property.
If “0” to “99999999” is set for this property, the FileCounter1 property, the FileCounter2
property, and the FileCounter3 property value is not used.
This property is enabled when "1 - 2 MultiImage" or "2 - 3 MultiImage" is set for the
MultiStreamMode propety and "1 – ON" is set for the MultiStreamFileNameMode property.
This property cannot be used together with the FileName property.
Do not configure this property in the MultiStreamPropertySetting event of the
MultiStreamMode property. Configure this property before the StartScan method instead.
This property cannot be configured in the MultiStreamPropertySetting event.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
FileCounter1, FileCounter2, FileCounter3
FileName1, FileName2, FileName3
FileType
MultiStreamFileNameMode

107
MultiStreamMode
ScanCount

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value is not updated if it is set to a value outside the range (outside the range of -2, -1
and 0 to 99999999).

Compatibility and Restraints

- This property does not support Java.

108
1.1.95 FileName .... file name
Feature
Sets the file name for storing the image. (Extension not included)

Coding Style
[form.] scancontrolname.FileName [ = String ]

Value
The file name for storing the image (string that ends with NULL, including the absolute path
name).
Extension does not need to be included because it will be given by the Control (OCX).

Default
"" (empty character string)

Explanation
Sets the file name to be output (does not need to set extension).
This property is enabled only when the ScanTo property is set to "0 - File."
In addition, the file name to be actually created will include the file name set with this
property, a 3-digit serial number, and the extension of the image data format set for the
FileType.
For example:
FileType = "1-TIFF"
if set to FileName = "C:〵 IMAGE 〵 IMG" and when three pages are scanned,
the three image files - IMG001.tif, IMG002.tif, and IMG003.tif - will be created in the
C:〵 IMAGE 〵 folder.
In case files with such names are already present, the files will be handled according to what
is specified for the Overwrite property.
〵 * ? " < > | If any of these characters is included, files cannot be created.
It is possible to add a serial number with the specified number of digits to the specified
position by specifying # for the file name.
1 - 8 digits can be specified using #.
Example)
img# → img1
img###vvv → img001vvv
img#####v → img00001v
If the serial number is advanced by one place, the places totally required for it are
automatically secured.
For example:
If set to FileName = "C:〵 IMAGE 〵 IMG#"
and when ten pages are scanned, the file named IMG10 will be created for the tenth page.
If "-2" is set for the FileCounterEx property, a serial number is not added. If # is added, the #
also becomes part of the file name.
Example)
img → img
img# → img#
img###vvv → img###vvv
img#####v → img#####v

Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

109
Related Properties
ScanTo
FileCounterEx
FileType
MultiStreamFileNameMode
MultiStreamMode
Overwrite

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
When scanning, checks whether or not it is possible to create the file using the file name
actually set. Sets the error code like EC_CANNOT_MAKE and returns RC_FAILURE when
the file name set is not correct (like when files cannot be created).
If "" (empty character string) is set, displays the file name input dialog (Windows shared
dialog) when scanning.

Compatibility and Restraints

Do not use # for folder names. Otherwise, files will not be created correctly.

110
1.1.96 FileName1, FileName2, FileName3
.... file names used for each output image
Feature
Sets the file names used for saving files for each output image. (excluding extensions).

Coding Style
[form.] scancontrolname.FileName1 [ = String ]
[form.] scancontrolname.FileName2 [ = String ]
[form.] scancontrolname.FileName3 [ = String ]

Value
File names used for saving files for each output image (string that ends with NULL, including
the absolute path name).
Extension does not need to be included because it will be given by the Control (OCX).

Default
"" (empty character string)

Explanation
Sets a file name for each image when multiple images created from a side of a document
that is scanned are output. (does not need to set extension.)
This property is enabled when "1 - 2 MultiImage" or "2 - 3 MultiImage" is set for the
MultiStreamMode propety and "1 – ON" is set for the MultiStreamFileNameMode property.
Actual file names are created in the following steps: (1) The 3-digit serial numbers are added
to file names that are set in this property. (2) Extensions that are set in FileType for each
scanning side are added to the file names created in step (1).
The FileCounterEx property cannot be used together with this property. To set the file
numbers, use the FileCounterEx1 property, the FileCounterEx2 property, and the
FileCounterEx3 property.
In case files with such names are already present, the files will be handled according to what
is specified for the Overwrite property.
In addition, if some file names from among the file names FileName1, FileName2, and
FileName3 are the same, the file that is output later will be handled according to what is
specified for the Overwrite property.
〵 * ? " < > | If any of these characters is included, files cannot be created.
It is possible to add a serial number with the specified number of digits to the specified
position by specifying # for the file name. 1 - 8 digits can be specified using #.
Do not configure this property in the MultiStreamPropertySetting event of the
MultiStreamMode property. Configure this property before the StartScan method instead.
This property cannot be configured in the MultiStreamPropertySetting event.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FileCounterEx1, FileCounterEx2, FileCounterEx3
FileType
MultiStreamFileNameMode
MultiStreamMode
Overwrite
ScanTo

Value Setting
When designed and when implemented.

111
Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
When scanning, checks whether or not it is possible to create the file using the file name
actually set. Sets the error code like EC_CANNOT_MAKE and returns RC_FAILURE when
the file name set is not correct (like when files cannot be created).
When "1 - 2 MultiImage" or "2 - 3 MultiImage" is set for the MultiStreamMode propety, "1 –
ON" is set for the MultiStreamFileNameMode property, and "" (empty character string) is set
for this property, an "EC_ERROR_UNSETING_FILENAME" error occurs.

Compatibility and Restraints

- Do not use # for folder names. Otherwise, files will not be created correctly.
- This property does not support Java.

112
1.1.97 FileType .... file format (image data format)
Feature
Sets the file format .

Coding Style
[form.] scancontrolname.FileType [ = Short ]

Value
0 - BMP Bitmap file
1 - TIFF TIFF file
2 - Multipage TIFF Multipage TIFF file
3 - JPEG JPEG file
4 - PDF PDF file
5 - Multipage PDF Multipage PDF file
6 - Multi Image Output Multi-image output(Black and white: TIFF file, Others: JPEG
file)
7 - Auto Color Detection Auto color detection(Black and white: TIFF file, Others: JPEG
file)

Default
1 - TIFF TIFF file

Explanation
Sets the image data format of a file to output.
This property is enabled only when the ScanTo property is set to "0 - File."
(This property will be disregarded if any value other than the above is set.)
-To set "1 - TIF" and "2 - Multipage TIFF" for this property and "1 - Grayscale" or "2 - RGB"
for the PixelType property, be sure to set "0 - No Compress", "5 - JPEG" or "6 - Old JPEG"
for the CompressionType property.
-To set "3 - JPEG" for this property, be sure to set "1 - Grayscale" or "2 - RGB" for the
PixelType property.
-To set "4 - PDF" and "5 - Multipage PDF" for this property:
- If the PixelType property is set to "0 - Black&White," set any value other than "5 -
JPEG" for the CompressionType property. (Unconditionally saved using MMR
compression if "5 - JPEG" is specified.)
- If the PixelType property is set to "1 - Grayscale," be sure to set "0 - No Compress" for
the CompressionType property.
- If the PixelType property is set to "2 - RGB," be sure to set "0 - No Compress" or "5 -
JPEG" for the CompressionType property. (Unconditionally saved using JPEG
compression if other value is specified.)
-When setting "6 - Multi Image Output" for this property
- Binary (black and white) and non-binary two images must be output in the same page.
Set "True" for the SourceCurrentScan property and enable Multi Image Output in the
FUJITSU TWAIN32 driver, Multi Image in the PaperStream IP (TWAIN) driver, or select
"Generate B&W and Color images simultaneously" in the Image Processing Software
Operation.
- The CompressionType property is disabled. For TIFF files, the compression format will
be CCITT G4, and for JPEG files, it will be JPEG.
- The same file name will be used for the TIFF and JPEG files from the identical page
(only the extensions will be different).
- If you want to set properties for each image, use "1 - 2 MultiImage" or "2 - 3
MultiImage" in the MultiStreamMode property.
-When setting "7 - Auto Color Detection" for this property
- Set "True" for the SourceCurrentScan property and enable "Auto Color Detection" in
the TWAIN driver.

113
 - The CompressionType property is disabled. For TIFF files, the compression format will
be CCITT G4, and for JPEG files, it will be JPEG.
- TIFF files and JPEG files are counted separately by the page counter.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoProfile
CompressionType
JpegQuality
PixelType
ScanCount
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

114
1.1.98 Filter .... dropout color
Feature
Sets the dropout color.

Coding Style
[form.] scancontrolname. Filter [ = Short ]

Value
0 - Green Drops out green.
1 - Red Drops out red.
2 - Blue Drops out blue.
3 - None No dropout.
4 - White Drops out white.
5 - Saturation Drops out chromatic colors.
6 - Specified by device Specified by device (Dropout color specified by the device)
99 - Custom1 Specify the Pattern 1, which is configured using the user interface of the source.
100 - Custom2 Specify the Pattern 2, which is configured using the user interface of the source.
101 - Custom3 Specify the Pattern 3, which is configured using the user interface of the source.
102 - Custom4 Specify the Pattern 4, which is configured using the user interface of the source.

Default
0 - Green Drops out green.

Explanation
Of green, red, blue, and white, capable of scanning by removing any of the color information
you have selected. For example, when scanning black letters with red outlines, it is possible
to scan only black letters by selecting red for this property to scan.
For chromatic colors, scanning can be performed by excluding any color information such as
green, red, or blue. Set the sensitivity of the chromatic color by specifying the
FilterSaturationSensitivity property.
For scanner with the custom pattern option, you can specify custom patterns that have been
configured through the user interface of the source.
For information about the custom pattern, see the Explanatory materials for the TWAIN
driver.
This property is enabled only when the PixelType property is set to "0 - Black & White" or "1 -
Grayscale." Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ScanTo
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

115
Error Recovery
If a value is specified beyond the range, the value will not be updated.
Depending on the scanners, some setting values are not supported.
(* See section "Reference Manual (Separate Volume).")
If an unsupported value on the scanner is specified, the TWAIN driver changes the setting
value to another valid one when scanning is performed.
For scanning with a specified custom pattern using the TWAIN32 driver, if the StartScan
method is issued before the custom pattern is specified, an error such as RC_CANCEL or
RC_FAILURE occurs. The value obtained from the ErrorCode property is indefinite.

Compatibility and Restraints

N/A

116
1.1.99 FilterSaturationSensitivity .... Chromatic dropout color sensitivity setting
Feature
Sets the chromatic dropout color sensitivity.

Coding Style
[form.] scancontrolname.FilterSaturationSensitivity [ = Short ]

Value
Value in the range from 0 (low) to 100 (high)

Default
50

Explanation
This property is enabled only when "5 - Saturation" is set for the Filter property.
For chromatic colors, scanning can be performed by excluding any color information such as
green, red, or blue.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Filter

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Some setting values are not supported depending on the specific device.
(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

117
1.1.100 FrontBackDetection .... ID card automatic detection
Feature
Sets the ID card automatic detection setting.

Coding Style
[form.] scancontrolname.FrontBackDetection [ = Short ]

Value
0 - None Do not detect
1 - Swap Detect (Swap if incorrect)
2 - Swap and Remove Back Side Detect (Swap if incorrect and remove back side)

Default
0 - None Do not detect

Explanation
Swap the front and back side images of an ID card so that the side with the photo of a face is
the front side. This property is enabled only when "2 - ADF(Duplex)" is set as the
PaperSupply property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Some setting values are not supported depending on the specific device.
(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

118
1.1.101 FrontBackMergingEnabled
.... Setting for merging the front and back side images
Feature
Sets whether or not to merge the front and back side images. .

Coding Style
[form.] scancontrolname.FrontBackMergingEnabled [ = Boolean ]

Value
True Merges the front and back sides.
False Does not merge the front and back sides.

Default
False Does not merge the front and back sides.

Explanation
Sets whether or not to merge the front and back side images.
- When "True" is set for this property:
・If "23 - 8.5 x 106.3 inch" - "27 - 8.5 x 220 inch", "32 - 12 x 125 inch", "34 - 12 x
106.3inch" - "39 - 12 x 240 inch" has been set for the PaperSize property, the
PaperSize property will be set to the default paper size.
・If "9 - 1200x1200 [dpi]" has been set for the Resolution property, the Resolution
property will be set to "2 - 300x300 [dpi]".
・If "0 - Flatbed", "1 - ADF", or "3 - ADF(BackSide)" has been set for the PaperSupply
property, the PaperSupply property operates as if set to "2 - ADF(Duplex)".
・ If "4 - ADF(CarrierSheet Spread A3)" - "49 - ADF(CarrierSheet Clipping Duplex
Custom)" has been set for the PaperSupply property, the operation is not guaranteed.
・If "4 - Automatic " has been set for the Rotation property, the Rotation property will be
set to "0 - None".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
MultiStreamMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
IIf this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.(* Refer to "Reference Manual (Separate
Volume)".)

Compatibility and Restraints

N/A

119
1.1.102 FrontBackMergingLocation
.... Setting for the way of merging the front and back side images
Feature
Sets the way of merging the front and back side images..

Coding Style
[form.] scancontrolname.FrontBackMergingLocation [ = Short ]

Value
0 - Upper Places the back side above the front side.
1 - Lower Places the back side below the front side.
2 - Left Places the back side to the left of the front side.
3 - Right Places the back side to the right of the front side.
Default
3 - Right Places the back side to the right of the front side.

Explanation
Sets the way of merging the front and back side images.
This property is enabled only when the FrontBackMergingEnabled property is set to "True".
The back side is positioned in each merged image as shown below.
“0 - Upper” “1 - Lower”
Back Front
Front Back

“2 - Left” Back Front “3 - Right” Front Back

Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingRotation

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out with
this property set to "3 - Right".(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

120
1.1.103 FrontBackMergingRotation
.... Setting for the angle to rotate the back side when merging the front and
back side images
Feature
Sets the angle to rotate the back side when merging the front and back side images. .

Coding Style
[form.] scancontrolname.FrontBackMergingRotation [ = Short ]

Value
0 - None Does not rotate the back side.
2 - R180 Rotates the back side 180 degrees.

Default
0 - None Does not rotate the back side.

Explanation
Sets the angle to rotate the back side when merging the front and back side images.
This property is enabled only when the FrontBackMergingEnabled property is set to "True".
The back side is rotated in each merged image as shown below.
“0 - None“ “2 - R180“
Front Back Front

Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingLocation

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out with
this property set to "0 - None". (* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

121
1.1.104 FrontBackMergingTarget
.... Setting a type of document whose front and back side images are to be
merged
Feature
Sets a type of document whose front and back side images are to be merged.

Coding Style
[form.] scancontrolname.FrontBackMergingTarget [ = Short ]

Value
0 - All All types of documents
1 - Short Documents with a length that is equal to or shorter than the criteria
2 - Long Documents with a length that is equal to or longer than the criteria

Default
0 - All All types of documents

Explanation
Sets a type of document whose front and back side images are to be merged based on the
criteria that is specified for the FrontBackMergingTargetSize property.
This property is enabled only when the FrontBackMergingEnabled property is set to "True".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingTargetMode
FrontBackMergingTargetSize

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on the device type, a scan will be carried out
with this property set to "0 - All" when a scanning operation is performed.
(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

122
1.1.105 FrontBackMergingTargetMode
.... Setting the criteria for determining a type of document whose front and
back side images are to be merged
Feature
Sets the criteria for determining a type of document whose front and back side images are to
be merged. .

Coding Style
[form.] scancontrolname.FrontBackMergingTargetMode [ = Short ]

Value
1 - Custom Sets custom size.
2 - CardSize Sets card size or a size smaller as the criteria.

Default
1 - Custom Sets custom size.

Explanation
Sets the criteria for determining a type of document whose front and back side images are to
be merged.
This property is enabled only when "True" is specified for the FrontBackMergingEnabled
property and a value other than "0 - All" is specified for the FrontBackMergingTarget
property.
When "1 - Custom " is set for this property, based on the criteria that is specified for the
FrontBackMergingTargetSize property, if "1 - Short" is specified for the
FrontBackMergingTarget, the front and back side images of a document that is equal to or
shorter than the criteria are merged, and if "2 - Long" is specified for the
FrontBackMergingTarget, the front and back side images of a document that is equal to or
longer than the criteria are merged.
When "2 - CardSize" is set for this property, the front and back side images of a document
that is equal to or shorter than card size are merged regardless of whether "1 - Short" or "2 -
Long" is specified for the FrontBackMergingTarget.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingTarget
FrontBackMergingTargetSize

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on the device type, a scan will be carried out
with this property set to "1 - Custom" when a scanning operation is performed. (* Refer to
"Reference Manual (Separate Volume)".)

123
Compatibility and Restraints
N/A

124
1.1.106 FrontBackMergingTargetSize
.... Setting the length for the criteria for determining a type of document
whose front and back images are to be merged
Feature
Sets the length for the criteria for determining a type of document whose front and back side
images are to be merged.

Coding Style
[form.] scancontrolname.FrontBackMergingTargetSize [ = Single]

Value
Sets the length for the criteria for determining a type of document whose front and back side
images are to be merged.
1 inch (2.54cm) or longer

Default
1 inch (2.54cm)

Explanation
Sets the length for the criteria for determining a type of document whose front and back side
images are to be merged.
This property is enabled only when "True" is specified for the FrontBackMergingEnabled
property, a value other than "0 - All" is specified for the FrontBackMergingTarget property,
and "1 - Custom" is specified for the FrontBackMergingTargetMode property.
The length selected for the PaperSize property is the maximum length.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingTarget
FrontBackMergingTargetMode
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.

Compatibility and Restraints

N/A

125
1.1.107 Gamma .... gamma adjustment
Feature
Sets the gamma adjustment mode.

Coding Style
[form.] scancontrolname. Gamma [ = Short ]

Value
0 - None N/A or Standard
1 - Soft Soft
2 - Sharp Sharp
3 - Gamma Pattern File Download (Specifies the gamma pattern file.)
4 - Custom Custom (Specifies the gamma value.)
5 - Bright Bright
6 - Standard Standard

Explanation
Sets the nonlinearity correction for images.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Default
0 - None

Target method
StartScan

Related Properties
AutoBright
Brightness
CustomGamma
Contrast
GammaFile
Highlight
PaperSupply
PixelType
Shadow
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
And because some values are not supported depending on devices, in such a case, a scan
will be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

In V1.0, the value 2-Sharp is described as 2-Hard. Note that both are the same value.

126
1.1.108 GammaFile .... gamma pattern file name
Feature
Specifies the gamma pattern file.

Coding Style
[form.] scancontrolname.GammaFile [ = String ]

Value
Gamma pattern file name (string that ends with NULL, including the absolute path name).

Default
"" (empty character string)

Explanation
Sets any gamma pattern file.
For pattern files, refer to the Explanatory materials for the TWAIN driver.

Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Gamma

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
When the Gamma property is set to value other than "3 - Gamma Pattern File," this property
is ignored.
If specified character strings are null, or if no configured files exist, set the Gamma property
to "0 - None" and scan the document.

Compatibility and Restraints

N/A

127
1.1.109 Halftone .... halftone
Feature
Sets the halftone pattern.

Coding Style
[form.] scancontrolname.Halftone [ = Short ]

Value
0 - None N/A
1 - Dither Pattern 0 For dark photo images
2 - Dither Pattern 1 For a mixture of dark letters and photos
3 - Dither Pattern 2 For light photo images
4 - Dither Pattern 3 For a mixture of light letters and photos
5 - Dither Pattern File Download (Specifies the halftone pattern file.)
6 - Error Diffusion Error diffusion method

Default
0 - None N/A

Explanation
This property sets a pattern to be used for halftone.
Halftone expresses grayscale images in pseudo gradation using halftone dots (pattern). It is
possible to select the dither pattern (1-4) incorporated in the device, download (5), or error
diffusion method (6).
Halftone is suitable for scanning images with shading like photos.
This property is enabled only when "0 - Black & White" is set for the PixelType property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order".

Target method
StartScan

Related Properties
CompressionType
PixelType
HalftoneFile

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If "1 - Grayscale" or "2 - RGB" has been set for the PixelType property, a scan will be
executed without regard to this property.
And because some values are not supported depending on devices, in such a case, a scan
will be carried out by setting this property as "1 - Dither Pattern 0" when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

128
1.1.110 HalftoneFile .... halftone pattern file
Feature
Specifies the halftone pattern file.

Coding Style
[form.] scancontrolname.HalftoneFile [ = String ]

Value
Halftone pattern file name (string that ends with NULL, including the absolute path name).

Default
"" (empty character string)

Explanation
Specifies any halftone pattern file.
For pattern files, refer to the Explanatory materials for the TWAIN driver.
This property is enabled only when "0 - Black & White" is set for the PixelType property and
"5 - Dither Pattern File" is set for the Halftone property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
PixelType
Halftone

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
This property is disregarded when "0 - Black & White" is set for the PixelType property and
any value other than "5 - Dither Pattern File" is set for the Halftone property.
If an empty string is set, or if there is no file set, sets the Halftone property as "0 - None"
when scanning to carry out a scan.
If the setting for the Halftone property as "5 - Dither Pattern File" (which specifies halftone
pattern file) is not supported depending on devices, sets the Halftone property as "1 - Dither
Pattern 0 " when scanning to carry out a scan.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

129
1.1.111 Highlight .... highlight
Feature
Sets highlights.

Coding Style
[form.] scancontrolname.Highlight [ = Short ]

Value
Between 1 and 255.

Default
230

Explanation
Sets highlighting for images when scanning.
This property is enabled only when either "1 - Grayscale" or "2 - RGB" is set as the
PixelType property.
This property is invalid when the PaperSupply property is set as "4 - ADF(CarrierSheet
Spread A3)", "5 - ADF(CarrierSheet Spread DL)", "6 - ADF(CarrierSheet Spread B4)", or "7 -
ADF(CarrierSheet Clipping)".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBright
Gamma
PaperSupply
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 255).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

130
1.1.112 HwAutomaticDeskew.... Automatic Skew Correction
Feature
Specify whether to have document skew automatically corrected when documents are fed.

Coding Style
[form.] scancontrolname.HwAutomaticDeskew [ = Short ]

Value
0 - OFF Disabled
1 - ON Enabled
2 - Hardware Setting Uses the scanner settings

Default
1 - ON Enabled

Explanation
Configure this setting to correct the orientation of a skewed document and feed the
document straight.

Target method
StartScan

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

131
1.1.113 HwCompression .... Transfer mode of the hardware
Feature
Sets the transfer mode of the hardware.

Coding Style
[form.] scancontrolname.HwCompression [ = Boolean ]

Value
False JPEG transfer
True Uncompressed transfer

Default
False JPEG transfer

Explanation
Sets the transfer mode of the hardware.

Target method
StartScan

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

132
1.1.114 HwMoireReductionMode.... Moire Reduction(Advanced)
Feature
Specify whether to adjust the scanning speed of the scanner to reduce moire (vertical
streaks)pattern appearing on the images.

Coding Style
[form.] scancontrolname.HwMoireReductionMode [ = Short ]

Value
0 - Disable Disabled
1 - Speed Suppresses moire (vertical streaks)
2 - Image Quality This option is more effective for suppressing moire
(vertical streaks) than [Speed] (However, the scanning
speed will slow down)
3 - Hardware Setting Uses the scanner settings

Default
3 - Hardware Setting Uses the scanner settings

Explanation
Adjusts the image quality when scanning documents (such as magazines or photographs) to
prevent moire (vertical streaks) appearing.
- When "1 - Speed" is set for this property:
・If "36 - 12 x 215inch" has been set for the PaperSize property, and more than "1 -
200×200 [dpi]" has been set for the Resoluton property, the PaperSize property will be
set to the default paper size.
- When "2 - Image Quality" is set for this property:
・If "36 - 12 x 215inch" - "39 - 12 x 240inch" has been set for the PaperSize property, the
PaperSize property will be set to the default paper size.
・If "32 - 12 x 125inch" or "35 - 12 x 160inch" has been set for the PaperSize property,
and more than "1 - 200×200 [dpi]" has been set for the Resoluton property, the
PaperSize property will be set to the default paper size.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties

Target method
StartScan

Related Properties
PaperSize
Resolution

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

133
1.1.115 ImageScanner .... image scanner name acquisition
Feature
Gets the product name of the image scanner.

Coding Style
[form.] scancontrolname.ImageScanner [ = String]

Value
N/A Property only for value reference purpose.

Default
"" (empty character string)

Explanation
Gets the product name of the RICOH fi Series image Scanner connected.
(Example: "fi-7160dj")

Target method
OpenScanner
OpenScanner2

Related Properties
N/A

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

Reference this property after calling the OpenScanner method or OpenScanner2 method.
(This property is set using the OpenScanner method or OpenScanner2 method.)

134
1.1.116 Indicator .... progress indicator setting
Feature
Sets whether to show the progress indicator while scanning.

Coding Style
[form.] scancontrolname.Indicator [ = Boolean]

Value
True Show the progress indicator.
False Do not show the progress indicator.

Default
True Show the progress indicator.

Explanation
Sets whether to show the progress indicator while scanning.
This property is enabled only when the ShowSourceUI property is "False".
If the ShowSourceUI property is set to "True", the Indicator property operates as if set to
"True" regardless of its actual setting.

Target method
StartScan

Related Properties
ShowSourceUI

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

135
1.1.117 IsExistsFB .... image scanner's flatbed (FB) support
Feature
Gets the device information regarding whether flatbed (FB) is supported.

Coding Style
[form.] scancontrolname.IsExistsFB [ = Boolean]

Value
N/A Property only for value reference purpose.

Default
True Supported.
False Unsupported.

Explanation
Gets the device information regarding whether the image scanner currently connected
supports flatbed (FB).

Target method
OpenScanner
OpenScanner2

Related Properties
PaperSupply

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

Obtain the value after calling the OpenScanner method or OpenScanner2 method.
(This property is set by the OpenScanner method or OpenScanner2 method.)

136
1.1.118 JobControl .... job control setting
Feature
Sets the job control.
* Job control refers to the process control when a special document (document with a
specific shape) or patch code document is detected.

Coding Style
[form.] scancontrolname.JobControl [ = Short ]

Value
0 - None Does not detect special documents or patch code documents.
1 - Include and Continue Scans special documents and patch code documents, and
operation continues.
2 - Include and Stop Scans special documents and patch code documents, and
operation is aborted.
3 - Exclude and Continue Skips special documents and patch code documents, and
operation continues.
4 - Exclude and Stop Skips special documents and patch code documents, and
operation is aborted.

Default
0 - None Does not detect special documents or patch code documents.

Explanation
Sets the job control.
When a special document or patch code document is detected during continuous scanning
using an ADF, a DetectJobSeparator event is issued to perform control based on the above
setting value (1 to 4).
(When the setting has been made with the UI of the TWAIN driver, the above event is issued
without regard to this property.)
Set the job control type using the JobControlMode property.
For details, refer to the DetectJobSeparator event.
Note: If the first document to be scanned is a special document or patch code document, the
document type is not correctly identified and the job control does not work properly. Do not
place a special document or patch code document for the first document.

* The special document refers to the document with A4 width or greater, and its front end
being shaped as shown in the figure below, having a cutout of 15mm per side in the middle.

Target method
StartScan
← →
Related Properties 15mm
DivideLongPage ｍm
JobControlMode
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Because this property is not supported depending on devices, it may be disabled.

137
(* Refer to "Reference Manual (Separate Volume).")
* For the details of special documents, refer to the User's Guide for your device.

Compatibility and Restraints

N/A

138
1.1.119 JobControlMode .... Job control type setting
Feature
Sets the type of job control document.

Coding Style
[form.] scancontrolname.JobControlMode [ = Short ]

Value
0 - Special Document
1 - Patch Code Document

Default
0 - Special Document

Explanation
Sets the type of job control document.
This property is enabled only when a setting other than "0 - None" is set for the JobControl
property.

Target method
StartScan

Related Properties
JobControl

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Because this property is not supported depending on devices, it may be disabled.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

139
1.1.120 JpegQuality .... Jpeg data compression level
Feature
Specifies the JPEG data compression level.

Coding Style
[form.] scancontrolname.JpegQuality [ = Short ]

Value
0 - Level1 Compression level 1 (Size given top priority)
1 - Level2 Compression level 2
2 - Level3 Compression level 3
3 - Level4 Compression level 4
4 - Level5 Compression level 5
5 - Level6 Compression level 6
6 - Level7 Compression level 7 (Image quality given top priority)

Default
3 - Level4 Compression level 4

Explanation
Specifies the JPEG data compression level.
This property is enabled when the ScanTo property is set to "0 - File," and the FileType
property is set to "3 - JPEG," "4 - PDF" or "5 - Multipage PDF" and when the PixelType
property is set to any value other than "0 - Black & White." In addition, it is also enabled
when the ScanTo property is set to "2 - Raw Image Handle." Otherwise, it will be
disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ScanTo
FileType
PixelType
CompressionType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

140
1.1.121 LengthDetection
.... Simultaneous setting of paper end detection / background color /
overscan
Feature
Sets paper end detection, background color, and overscan simultaneously.

Coding Style
[form.] scancontrolname.LengthDetection [ = Short ]

Value
0 - None No setting
1 - LengthBlack paper end detection
2 - LengthBlackOVS paper end detection+overscan

Default
0 - None No setting

Explanation
Sets paper end detection, background color, and overscan simultaneously.
When a value other than "0 - None" is set for this property, the background color will be
black for a device that supports a black background and will be white for a device that does
not support a black background.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
BackgroundColor
Deskew
DivideLongPage
FrontBackMergingEnabled
OverScan
PaperSupply
UndefinedScanning

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

141
1.1.122 LongPage .... Long document (long page) scan setting

Feature
Sets the scanning of paper with a length greater than the maximum specifiable length (long
page).

Coding Style
[form.] scancontrolname. LongPage [ = Boolean]

Value
True Scans long documents (long page).
False Does not scan long documents (long page).
Default
False Does not scan long documents (long page).
Explanation
Enables the scanning of long paper (long page) that cannot be scanned with the setting for
regular sizes (A4, A3, etc.).
This property is enabled only when "99 - Custom" is set for the PaperSize property, and the
settings of the CustomPaperWidth property and the CustomPaperLength property will be
referenced for the length and width of a long page.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
FrontBackMergingEnabled
PaperSize
PaperSupply
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Disregarded when any value other than "99 - Custom" is specified for the PaperSize property,
"3 - ADF(Back Side)" (FUJITSU TWAIN32 driver only) is specified for the PaperSupply
property.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
* Scannable length varies with device.
Refer to "Reference Manual (Separate Volume)."

Compatibility and Restraints

N/A

142
1.1.123 ManualFeedMode .... Manual Feed Mode
Feature
Switches to Manual Feed Mode.

Coding Style
[form.] scancontrolname.ManualFeedMode [ = Short ]

Value
1 - ON Sets the method for feeding documents to Manual Feed Mode.
2 - Hardware Setting Feeds documents in Manual Feed Mode when the Manual Feed
button on the panel of the scanner is pressed.

Default
2 - Hardware Setting Feeds documents in Manual Feed Mode when the Manual Feed
button on the panel of the scanner is pressed.
Explanation
Sets Manual Feed Mode.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
MultiFeed
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

143
1.1.124 Mirroring .... mirror image (flip horizontal)
Feature
Sets Flip Horizontal.

Coding Style
[form.] scancontrolname.Mirroring [ = Boolean ]

Value
True Uses Flip Horizontal.
False Does not use Flip Horizontal.

Default
False Does not use Flip Horizontal.

Explanation
Sets whether or not to use Flip Horizontal.
This property is enabled only when "0 - Black & White" is set for the PixelType property.
Because this property is not supported in devices without an image processing board, in
such a case, a scan will be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Target method
StartScan

Related Properties
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If "1 - Grayscale" or "2 - RGB" has been set for the PixelType property, a scan will be
executed without regard to this property.

Compatibility and Restraints

N/A

144
1.1.125 MultiFeed .... multifeed detection
Feature
Detects multifeed (two or more sheets of document feed at one time).

Coding Style
[form.] scancontrolname. MultiFeed [ = Short ]

Value
0 - None Disabled.
1 - Mode0 Device setting.
2 - Mode1 Detects difference in thickness/detects overlapping.
3 - Mode2 Detects difference in length.
4 - Mode3 Detects difference in length and thickness/detects overlapping and
difference in length.

Default
0 - None Disabled.

Explanation
Detects multifeed (two or more sheets of document feed at one time). When any value other
than disabled is specified for this property, if multifeed is detected the device will stop and
the error message "Multifeed detected (Code: DS32006)" coming from the TWAIN driver will
be displayed.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DivideLongPage
ManualFeedMode
PaperSupply
SilentMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
And because this property is not supported depending on devices, in such a case, a scan will
be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

Multiple documents that feed at the same time may be scanned as an image.

145
1.1.126 MultiFeedModeChangeSize
.... Specifying the paper length to disable multifeed detection
Feature
Specifies the paper length to disable multifeed detection.

Coding Style
[form.] scancontrolname.MultiFeedModeChangeSize [ = Single ]

Value
Specifies the paper length to disable multifeed detection.
0 (Disabled), 1 inch (2.54cm) or longer

Default
0 Disabled

Explanation
Specifies the paper length to disable multifeed detection.
This property is enabled only when the MultiFeed property is set to a value other than " 0 -
None" and "3- Mode2".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
MultiFeed
PaperSupply
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.
Error Recovery
No error check is done at the time of setting.

Compatibility and Restraints

N/A

146
1.1.127 MultiFeedNotice .... Multifeed notification setting
Feature
Sets whether or not to use the multifeed notification function.

Coding Style
[form.]scancontrolname.MultiFeedNotice [=Boolean]

Value
True Uses the multifeed notification function.
False Does not use the multifeed notification function.

Default
False Does not use the multifeed notification function.

Explanation
Sets whether or not to use the multifeed notification function when scanning.
For FUJITSU TWAIN32 driver
To use this function, a value other than "0 - None" or "1 - Mode0" must be set for the
MultiFeed property.
For PaperStream IP (TWAIN) driver
To use this function, a value other than "0 - None" must be set for the MultiFeed property.
When "True" is set for this property, scanning does not stop even if multifeeds are detected.
The results are notified by using the MultiFeedResult property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
MultiFeed
MultiFeedResult

Value Setting
When designed and when implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

147
1.1.128 MultiFeedResult .... Getting the multifeed result
Feature
Gets the result of the multifeed notification function.

Coding Style
[form.]scancontrolname.MultiFeedResult [=Boolean]

Value
N/A. Property only for value reference purpose.

Default
False Multifeed was not detected.

Explanation
The multifeed result for the current page can be checked when a notification is sent for a
ScanToFile, ScanToDibEx, or ScanToRawEx event.
FALSE Multifeed was not detected.
TRUE Multifeed was detected.
This property is enabled when [True] is set for the MultiFeedNotice property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
MultiFeed
MultiFeedNotice
ScanTo

Related Events
ScanToFile
ScanToDibEx
ScanToRawEx

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

148
1.1.129 MultiStreamDefaultValueMode
.... Mode for keeping the default value for each image
Feature
For properties that can be specified for each output image, this function enables the
properties with a default value to be kept for each image.

Coding Style
[form.]scancontrolname.MultiStreamDefaultValueMode [=Short]

Value
0 - OFF Does not keep the default value for each output image
1 - ON Keeps the default value for each output image

Default
0 - OFF Does not keep the default value for each output image

Explanation
For properties that can be specified for each output image, specify whether to enable the
properties with a default value to be kept for each image. This property is enabled when an
option other than "0 - OFF" is set for the MultiStreamMode property.

This property works for the following properties:

AdjustRGB, AdjustRGBB, AdjustRGBG, AdjustRGBR, ADTCThreshold, AutoBright,
Background, BackgroundSmoothing, BackgroundSmoothness, BackgroundThreshold,
Brightness, CharacterExtraction, CharacterExtractionMethod, CharacterThickness,
ColorReproduction, ColorReproductionBrightness, ColorReproductionContrast,
ColorReproductionCustomGamma, ColorReproductionHighlight, ColorReproductionShadow,
CompressionType, Contrast, CustomGamma, CustomResolution, DTCSensitivity,
FadingCompensation, FileType, Filter, FilterSaturationSensitivity, Gamma, GammaFile,
Halftone, HalftoneFile, Highlight, NoiseRejection, PatternRemoval, PixelType, Resolution,
Reverse, SDTCSensitivity, SEE, Shadow, Sharpness, SimpleSlicePatternRemoval, sRGB,
Threshold

Example: Specifying "2 - 3 MultiImage" for this property and "3 - 400×400 [dpi]" for the
Resolution property before the StartScan method and specifying "0 - 200×200
[dpi]" for Resolution property in the MultiStreamPropertySetting event for the 2nd
image
MultiStreamDefaultValueMode:OFF
Before the StartScan 1st image 2nd image 3rd image
method
Value specified for the 3 - 400×400 Has not been 0 - 200×200 Has not been
Resolution property specified specified
Scanning outcome - 400 dpi 200 dpi 200 dpi
MultiStreamDefaultValueMode:ON
Before the StartScan 1st image 2nd image 3rd image
method
Value specified for the 3 - 400×400 Has not been 0 - 200×200 Has not been
Resolution property specified specified
Scanning outcome - 300 dpi 200 dpi 300 dpi

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB

149
AdjustRGBG
AdjustRGBR
ADTCThreshold
AutoBright
Background
BackgroundSmoothing
BackgroundSmoothness
BackgroundThreshold
Brightness
CharacterExtraction
CharacterExtractionMethod
CharacterThickness
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow
CompressionType
Contrast
CustomGamma
CustomResolution
DTCSensitivity
FadingCompensation
FileType “0 – BMP”, “1 - TIFF”, “2 - Multipage TIFF“, “3 - JPEG”, “4 - PDF” , “5 - Multipage
PDF”
Filter
FilterSaturationSensitivity
Gamma
GammaFile
Halftone
HalftoneFile
Highlight
MultiStreamMode
NoiseRejection
PatternRemoval
PixelType “0 - Black & White”, “1 - Grayscale”, “2 - RGB”
Resolution
Reverse
SDTCSensitivity
SEE
Shadow
Sharpness
SimpleSlicePatternRemoval
sRGB
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.
Error Recovery
N/A

Compatibility and Restraints

- This property does not support Java.

150
1.1.130 MultiStreamFileNameMode
.... File name and file counter settings for a file created from each output
image
Feature
Sets a file name and file counter for a file created from each output image.

Coding Style
[form.]scancontrolname.MultiStreamFileNameMode [=Short]

Value
0 - OFF Does not set a file name and file counter for a file created from each
output image
1 - ON Sets a file name and file counter for a file created from each output image

Default
0 - OFF Does not set a file name and file counter for a file created from each
output image

Explanation
It is possible to set a file name and file counter for a file created from each output image.
This property is enabled when an option other than "0 - OFF" is set for the MultiStreamMode
property.
The FileCounterEx property and the FileName property are disabled when "1 - 2 MultiImage"
or "2 - 3 MultiImage" is set for the MultiStreamMode property and "1 – ON" is set for this
property. Use the FileCounterEx1, FileCounterEx2, and FileCounterEx3 properties and the
FileName1, FileName2, and the FileName3 properties.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FileCounterEx1, FileCounterEx2, FileCounterEx3
FileName1, FileName2, FileName3
MultiStreamMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.
Error Recovery
N/A

Compatibility and Restraints

- This property does not support Java.

151
1.1.131 MultiStreamMode .... Settings for outputting multiple images
Feature
Outputs multiple images for each page that is scanned.
You can set properties for each image that is output.

Coding Style
[form.]scancontrolname.MultiStreamMode [=Short]

Value
0 - OFF Not carried out
1 – 2 MultiImage Multi image output (two images)
2 – 3 MultiImage Multi image output (three images)

Default
0 - OFF Not carried out

Explanation
Outputs multiple images for each page.
When "1 - 2 MultiImage" is set, two images are output.
When "2 - 3 MultiImage" is set, three images are output.
To specify a value other than "0 - OFF" for this property, be sure to specify "0 - File" or "1 -
Dib Handle" for the ScanTo property.
When a value other than "0 - OFF" is specified, the MultiStreamPropertySetting event is
issued for setting the property for each image.

The following properties can be set in the MultiStreamPropertySetting event.

AdjustRGB, AdjustRGBB, AdjustRGBG, AdjustRGBR, ADTCThreshold, AutoBright,
Background, BackgroundSmoothing, BackgroundSmoothness, BackgroundThreshold,
Brightness, CharacterExtraction, CharacterExtractionMethod, CharacterThickness,
ColorReproduction, ColorReproductionBrightness, ColorReproductionContrast,
ColorReproductionCustomGamma, ColorReproductionHighlight, ColorReproductionShadow,
CompressionType, Contrast, CustomGamma, CustomResolution, DTCSensitivity,
FadingCompensation, FileType, Filter, FilterSaturationSensitivity, Gamma, GammaFile,
Halftone, HalftoneFile, Highlight, NoiseRejection, PatternRemoval, PixelType, Resolution,
Reverse, SDTCSensitivity, SEE, Shadow, Sharpness, SimpleSlicePatternRemoval, sRGB,
Threshold

Do not use any properties other than the properties above in the MultiStreamPropertySetting
event. Configure such properties before the StartScan method. If such properties are
configured in the MultiStreamPropertySetting event, the operation is not guaranteed.
To set a file name and file counter for a file created from each output image, set "1 - ON" for
the MultiStreamFileNameMode property and use the FileName1, FileName2, and FileName3
properties and the FileCounterEx1, FileCounterEx2, and FileCounterEx3 properties.

152
If there is a property that is not set for a certain image, a value that is specified for a property
for the previous image is applied instead. For the 1st image, a value that is specified for a
property which is set before the StartScan method is applied.

Example: Specifying "2 - 3 MultiImage" for this property and "3 - 400×400 [dpi]" for the
Resolution property before the StartScan method and specifying "0 - 200×200
[dpi]" for Resolution property in the MultiStreamPropertySetting event for the 2nd
image
Before the StartScan 1st image 2nd image 3rd image
method
Value specified for the 3 - 400×400 Has not been 0 - 200×200 Has not been
Resolution property specified specified
Scanning outcome - 400 dpi 200 dpi 200 dpi

The Resolution property is not set for the 1st The Resolution property is not set for the 3rd
image. So, the value that is specified for the image. So, the value that is specified for the
property which is set before the StartScan method property for 2nd image is applied to the 3rd image
is applied instead and scanning will be performed instead and scanning will be performed at 200 dpi.
at 400 dpi.

If you want to set the default value for properties that are not set for a certain image, specify
"1 – ON" for the MultiStreamDefaultValueMode property.

When a value other than "0 - OFF" is specified for this property
- When "1 - 2 MultiImage" is specified, the maximum value that can be specified for the
ScanCount property is 16,383. When "2 - 3 MultiImage" is specified, the maximum value
that can be specified for the ScanCount property is 10,922. Do not specify a value that
exceeds the maximum value.
- The counter value for the DigitalEndorserString property increases every time an image is
output.
- Specifying "True" for the ShowSourceUI property allows you to display the User Interface
(UI) of the source, check the value specified in the SDK, and check the preview image, but
does not allow you to perform a scan. Specify "False" for the ShowSourceUI property to
perform a scan.
- When the values for the CompressionType property, the FileType property, and the
PixelType property, which is specified for each image contradict each other when
combined, the following operation will be taken.
- When " 0 - Black&White" is specified for the PixelType property and "3 - JPEG" is
specified for the FileType property in the MultiStreamPropertySetting event, a scanned
image is output as a TIFF file.
- When "1 - Grayscale" or "2 - RGB" is specified for the PixelType property and the
value for compression ("1 - CCITT G3(1D)", "2 - CCITT G3(2D) KFactor = 2", "3 -
CCITT G3(2D) Kfactor = 4", or "4 - CCITTG4") is specified for the CompressionType
property in the MultiStreamPropertySetting event, the CompressionType property will
be set to "0 - NoCompress" for the operation.
- When "0 – Black&White" is specified for the PixelType property, "1 - TIFF" is specified
for the FileType property, and "5 - JPEG" or "6 - Old JPEG" is specified for the
CompressionType property, the CompressionType property will be set to "0 -
NoCompress" for the operation.
Note: The operation when "0 – OFF" is specified for this property, refer to the Explanation
for the CompressionType property, Filetype property, and PixelType property.

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB

153
AdjustRGBG
AdjustRGBR
ADTCThreshold
AutoBright
Background
BackgroundSmoothing
BackgroundSmoothness
BackgroundThreshold
Brightness
CharacterExtraction
CharacterExtractionMethod
CharacterThickness
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow
CompressionType
Contrast
CustomGamma
CustomResolution
DTCSensitivity
FadingCompensation
FileCounterEx1, FileCounterEx2, FileCounterEx3
FileName1, FileName2, FileName3
FileType “0 – BMP”, “1 - TIFF”, “2 - Multipage TIFF“, “3 - JPEG”, “4 - PDF” , “5 - Multipage
PDF”
Filter
FilterSaturationSensitivity
Gamma
GammaFile
Halftone
HalftoneFile
Highlight
MultiStreamDefaultValueMode
MultiStreamFileNameMode
NoiseRejection
PatternRemoval
PixelType “0 - Black & White”, “1 - Grayscale”, “2 - RGB”
Resolution
Reverse
ScanCount
ScanTo “0 - File”, “1 - Dib Handle”
SDTCSensitivity
SEE
Shadow
Sharpness
SimpleSlicePatternRemoval
sRGB
Threshold

Related Events
ScanToFile

Value Setting
When designed and when implemented.

154
Value Reference
When implemented.
Error Recovery
- Value will not be updated if set beyond the setting range.
- If a value other than "0 - OFF" is specified for this property and a value other than "0 - File"
or "1 - Dib Handle" is specified for the ScanTo property, an
"EC_UNSUPPORTED_XFERMECH" error occurs. Be sure to specify "0 - File" or "1 - Dib
Handle".
- If a value other than "0 - OFF" is specified for this property and "6 - Multi Image Output", or
"7 - Auto Color Detection" is specified for the FileType property in the
MultiStreamPropertySetting event, an "EC_ERROR_BAD_PARAMETER" error occurs.
Be sure to specify "0 - BMP", "1 - TIFF", “2 - Multipage TIFF”, "3 - JPEG", "4 - PDF" or “5 -
Multipage PDF”.
- If a value other than "0 - OFF" is specified for this property and a value (other than a value
ranging from "0 - Black & White" to "2 - RGB") is specified for the PixelType property in the
MultiStreamPropertySetting event, an "EC_ERROR_BAD_PARAMETER" error occurs.
Be sure to specify a value ranging from "0 - Black & White" to "2 - RGB".

Compatibility and Restraints

- If the related properties are not enabled, a scan is performed without applying the values
specified for those properties.
- This property does not support Java.

155
1.1.132 NoiseRejection .... Dynamic Threshold (iDTC) binary noise removal
Feature
Sets the sensitivity for Dynamic Threshold (iDTC) binary noise removal.

Coding Style
[form.] scancontrolname.NoiseRejection [ = Short ]

Value
0 - Disabled
1 to 20 - Higher values result in more noise removal.

Default
0 (Disabled)

Explanation
Sets the sensitivity for Dynamic Threshold (iDTC) binary noise removal.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 0 and 20).
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

156
1.1.133 NoiseRemoval .... dust removal mode
Feature
Function to automatically remove tiny dots in images by regarding them as dust.

Coding Style
[form.] scancontrolname.NoiseRemoval [ = Short ]

Value
0 - None Disabled.
1 - Matrix2 Removes dust of 2 x 2 dot matrix or smaller.
2 - Matrix3 Removes dust of 3 x 3 dot matrix or smaller.
3 - Matrix4 Removes dust of 4 x 4 dot matrix or smaller.
4 - Matrix5 Removes dust of 5 x 5 dot matrix or smaller.

Default
0 - None Disabled.

Explanation
Regards small black dots on the white area of an image or small white dots on the black
area of an image as dust to automatically remove.
This property is enabled only when the PixelType property is set to "0 - Black & White" and
"0" is specified for the Threshold property. Otherwise, it will be disregarded.
Because this property is not supported in devices without an image processing board, in
such a case, a scan will be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

157
1.1.134 Orientation .... document orientation setting
Feature
Sets the orientation of a document.

Coding Style
[form.] scancontrolname.Orientation [ = Short ]

Value
0 - Portrait Portrait
1 - Landscape Landscape

Default
0 - Portrait Portrait

Explanation
Sets the orientation (portrait/landscape) of a document.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSize
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
"1 - Landscape" cannot be set depending on document size or scanner to use.
Example) PaperSize "0 - A3(297 x 420mm)"
In addition, there is the case that the image data which I read of is chipped off.
Example) fi-65F, PaperSize "11 - PostCard (100 x 149mm) ","12 - Photo(89 x 127mm)"

Compatibility and Restraints

N/A

158
1.1.135 Outline .... outline correction
Feature
Sets the outline correction function.

Coding Style
[form.] scancontrolname.Outline [ = Short ]

Value
When PixelType is binary (black and white):
0 - None N/A
1 - Outline Emphasis Low Low (Outline emphasis)
2 - Outline Emphasis Mid Medium (Outline emphasis)
3 - Outline Emphasis High High (Outline emphasis)
4 - Outline Smooth Outline smoothing
5 - Edge Extract Edge extraction

When PixelType is RGB color:

0 - None N/A
1 - Outline Emphasis Low Low (Outline emphasis)
2 - Outline Emphasis Mid Medium (Outline emphasis)
3 - Outline Emphasis High High (Outline emphasis)
5 - De-Screen Level 1 De-Screen level 1
6 - De-Screen Level 2 De-Screen level 2
7 - De-Screen Level 3 De-Screen level 3
8 - De-Screen Level 4 De-Screen level 4

When PixelType is Grayscale:

0 - None N/A

Default
0 - None N/A

Explanation
Sets the outline correction function by making a selection from the above list.
Outline emphasis: Outputs the scanned image with its outline emphasized.
Three levels (low/medium/high) are selectable.
Outline smoothing: Smoothes the jagged edges.
Edge extraction: Outputs the edges of an image.
De-Screen Level: Smoothes the inside of an image and carries out de-screening.
The higher the level, the smoother the image.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

159
Error Recovery
Value will not be updated if set beyond the setting range.
And if this property cannot be enabled due to the setting for the PixelType property, a scan
will be carried out without regard to this property when scanning. And if this property cannot
be enabled depending on device type, a scan will be carried out without regard to this
property when scanning. (* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

This property depends on the value specified as the PixelType property. Follow the
procedure below to use this property.
1. Before setting the PixelType property, set this property to "0 - None".
2. Set the PixelType property.
3. Set this property as necessary.
For PaperStream IP (TWAIN) driver, it is recommended to use the Sharpness property. The
value set for the Outline property is also applied to the Sharpness property. The value is
applied as shown below.
The value is not applied if it is set when designed.
This property Sharpness property
When PixelType is Binary (black and white)
0 - None 0 - None
1 - Outline Emphasis Low 1 - Emphasis Low
2 - Outline Emphasis Mid 2 - Emphasis Mid
3 - Outline Emphasis High 3 - Emphasis High
4 - Outline Smooth 5 - Smoothing Level 1
5 - Edge Extract 4 - Edge Extract

When PixelType is not Binary (black and white)

0 - None 0 - None
1 - Outline Emphasis Low 1 - Emphasis Low
2 - Outline Emphasis Mid 2 - Emphasis Mid
3 - Outline Emphasis High 3 - Emphasis High
5 - De-Screen Level 1 5 - De-Screen Level 1
6 - De-Screen Level 2 6 - De-Screen Level 2
7 - De-Screen Level 3 7 - De-Screen Level 3
8 - De-Screen Level 4 8 - De-Screen Level 4

Property setting process to enable the value of this property for the PaperStream IP (TWAIN)
driver.
Example: // The property setting process
AxFiScn1.Sharpness = 3
AxFiScn1.Outline = 1 → Since the Outline value is set after the Sharpness,
// Starting the process of scanning the Outline value is applied to the Sharpness, and
… then the function is work.

160
1.1.136 OverScan .... overscan setting
Feature
Sets overscan.

Coding Style
[form.] scancontrolname.OverScan [ = Short ]

Value
0 - OFF Perform overscan.
1 - ON Do not perform overscan.

Default
0 - OFF Perform overscan.

Explanation
Sets overscan.
Scans in a size slightly larger than that of actual document.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
BackgroundColor
Deskew
DivideLongPage
FrontBackMergingEnabled
LengthDetection
PaperSupply
UndefinedScanning

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
And if this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

161
1.1.137 Overwrite .... file overwrite setting
Feature
Sets whether or not to overwrite files.

Coding Style
[form.] scancontrolname.Overwrite [ = Short ]
Value
0 - OFF(Mode0) Does not overwrite
(When file type is TIFF, JPEG or BMP without using “Image
Processing Software Option “, processes the number of sheets
specified for the ScanCount property up to the last sheet even if
a file with the same name exists.)
1 - ON Overwrites.
2 - Confirm(Mode0) Displays the confirmation message box. (Displayed even in
SilentMode.)
3 - OFF(Mode1) Does not overwrite. (If a file with the same name exists, aborts
scanning.)
4 - Confirm(Mode1) Displays the confirmation message box.
(Turned to the same operation as "3 - OFF(Mode1)" in
SilentMode.)

Default
2 - Confirm(Mode0) Displays the confirmation message box.

Explanation
Sets whether or not to overwrite a file when saving, if a file with the same name exists.
- If a file with the same name exists when the property is set to "0 - OFF(Mode0)" or "3 -
OFF(Mode1)", scanning will be aborted and the file will not be overwritten. (Data will be
destroyed.)
- If a file with the same name exists when the property is set to "1 - ON," the file will be
overwritten.
- If a file with the same name exists when the property is set to "2 - Confirm(Mode0)" or "4 -
Confirm(Mode1)", the overwriting confirmation message box will appear. If you press the
[Yes] button, the file will be overwritten. If you press the [No] button, scanning will be aborted
and the file will not be overwritten. (Data will be destroyed.)
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".
Target method
StartScan

Related Properties
ScanTo "0 - File"
SilentMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value not updated if set to other than the specified range.
Compatibility and Restraints
- Mode0 and Mode1 were introduced in V2.0L10. Mode1 is recommended. Mode0 is a
compatible mode that enables applications developed using V1.0 to behave in the same
way.

162
1.1.138 PageCount .... scan page count acquisition
Feature
Gets the scan page count.

Coding Style
[form.] scancontrolname.PageCount [ = Short ]

Value
N/A Property only for value reference purpose.
Default
0

Explanation
Gets the scan page count.
Initializes PageCount to 0 when calling StartScan to get the page count (number of pages)
scanned.
Only one page (with one page image) is scanned when the PaperSupply property is
specified with "4 - ADF(CarrierSheet Spread A3)", "5 - ADF(CarrierSheet Spread DL)", or "6
- ADF(CarrierSheet Spread B4).” One page (with two individual page images on it) is
scanned when the property is specified with "7 - ADF(CarrierSheet Clipping)."”

Target method
StartScan

Related Properties
ScanTo

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

163
1.1.139 PageNumber .... Getting a page number
Feature
Gets the number of the page that is currently being scanned.

Coding Style
[form.] scancontrolname.PageNumber [ = Short ]

Value
N/A. Property only for value reference purpose.
Default
-1

Explanation
Gets the number of the page that is currently being scanned when a notification is sent for a
ScanToFile, ScanToDibEx, or ScanToRawEx event.
Even when blank pages are skipped for the setting of the BlankPageSkip, SkipBlackPage, or
SkipWhitePage properties, the page number accumulates. When the PaperSupply property
is specified with "2 - ADF(Duplex)", it is possible to determine which side of a document it is,
by looking at page numbers (that is, if it is an odd number, it is the front side, and if it is an
even number, it is the back side).

Target method
StartScan

Related Events
ScanToFile
ScanToDibEx
ScanToRawEx

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

164
1.1.140 PaperProtection .... Paper Protection
Feature
Detects document feeding errors.

Coding Style
[form.] scancontrolname.PaperProtection [ = Short ]

Value
0 - OFF Disabled
1 - ON Enabled
2 - Hardware Setting Uses the scanner settings
3 - Driver Setting Uses the driver settings

Default
3 - Driver Setting Uses the driver settings

Explanation
Detects document feeding errors. When any value other than disabled is specified for this
property, if a feeding error is detected, the device will stop and the error message "Paper
jammed in the ADF. (Code: DS32002)" coming from the TWAIN driver will be displayed.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Events
ManualFeedMode
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

165
1.1.141 PaperSize .... document size
Feature
Sets the document size.

Coding Style
[form.] scancontrolname.PaperSize [ = Short ]

Value
0 - A3 (297 x 420mm)
1 - A4 (210 x 297mm)
2 - A5 (148 x 210mm)
3 - A6 (105 x 148mm)
4 - B4(JIS) (257 x 364mm)
5 - B5(JIS) (182 x 257mm)
6 - B6(JIS) (128 x 182mm)
7 - Letter (8.5 x 11 inch) (= 215.9 x 279mm)
8 - Legal (8.5 x 14 inch) (= 215.9 x 355.6mm)
9 - Executive (7.25 x 10.5 inch) (= 184 x 266.7mm)
10 - Double Letter (11 x 17 inch) (= 279 x 431.8mm)
11 - PostCard (100 x 149mm) Postcard size
12 - Photo (89 x 127mm) 4 x 6 inch photo size
13 - Card (55 x 91mm) Business card size
15 - C4 (229 x 324mm)
16 - C5 (162 x 229mm)
17 - C6 (114 x 162mm)
18 - B4(ISO) (250 x 353mm)
19 - B5(ISO) (176 x 250mm)
20 - B6(ISO) (125 x 176mm)
21 - 8.5 x 17 inch
22 - 8.5 x 34 inch
23 - 8.5 x 106.3 inch
24 - 8.5 x 125 inch
25 - 8.5 x 160 inch
26 - 8.5 x 215 inch
27 - 8.5 x 220 inch
28 - 11.693 x 17 inch
29 - 11.693 x 34 inch
30 - 12 x 17 inch
31 - 12 x 34 inch
32 - 12 x 125 inch
33 - Maximum Size
34 - 12 x 106.3inch
35 - 12 x 160inch
36 - 12 x 215inch
37 - 12 x 220inch
38 - 8.5 x 240inch
39 - 12 x 240inch
99 - Custom

Default
1 - A4 (210 x 297mm)

Explanation
Sets the document size to scan by making a selection from the above list.
When the value is set to "33 - Maximum Size", the document size is set to the device's
maximum document size for non-long pages.

166
Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
FrontBackMergingEnabled
HwMoireReductionMode
LongPage
Orientation
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Also when the settings of "11-PostCard”, “12-Photo” and “13-Card" are not supported, sets
"99 - Custom" when scanning to carry out a scan.
And because some values are not supported depending on devices, in such a case, a scan
will be carried out by setting this property as "1 - A4 (210 x 297mm)" when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

Only TWAIN compliant document sizes are supported.
The document orientation specified for business cards was changed from portrait to
landscape in V2.0L10.
When Custom is selected, even if you can enter a standard paper size (e.g. 55x91mm), the
user interface of the source may display the paper size as Custom with a standard paper
size.

167
1.1.142 PaperSupply .... paper feed method
Feature
Sets the paper feed method.

Coding Style
[form.] scancontrolname.PaperSupply [ = Short ]

Value
0 - Flatbed Flatbed
1 - ADF ADF(Face scan)
2 - ADF(Duplex) ADF(Duplex scan)
3 - ADF(BackSide) ADF(Back scan)
4 - ADF(CarrierSheet Spread A3) A3 double-page spread images scanned using the
Carrier Sheet
5 - ADF(CarrierSheet Spread DL) Double-letter double-page spread images scanned
using the Carrier Sheet
6 - ADF(CarrierSheet Spread B4) B4 double-page spread images scanned using the
Carrier Sheet
7 - ADF(CarrierSheet Clipping) Separate outputs of front and back side images
scanned using the Carrier Sheet
10 - ADF(CarrierSheet Spread A3) A3 double-page spread images scanned using the
Carrier Sheet
11 - ADF(CarrierSheet Spread DL) Double-letter double-page spread images scanned
using the Carrier Sheet
12 - ADF(CarrierSheet Spread B4) B4 double-page spread images scanned using the
Carrier Sheet
13 - ADF(CarrierSheet Spread Auto) Automatic detection double-page spread images
scanned using the Carrier Sheet
14 - ADF(CarrierSheet Clipping All) Carrier Sheet Size Clipping Front images scanned
using the Carrier Sheet
15 - ADF(CarrierSheet Clipping A4) A4 Clipping Front images scanned using the Carrier
Sheet
16 - ADF(CarrierSheet Clipping A5) A5 Clipping Front images scanned using the Carrier
Sheet
17 - ADF(CarrierSheet Clipping A6) A6 Clipping Front images scanned using the Carrier
Sheet
18 - ADF(CarrierSheet Clipping POST) POST Card Clipping Front images scanned using the
Carrier Sheet
19 - ADF(CarrierSheet Clipping B5) B5 Clipping Front images scanned using the Carrier
Sheet
20 - ADF(CarrierSheet Clipping B6) B6 Clipping Front images scanned using the Carrier
Sheet
21 - ADF(CarrierSheet Clipping LT) Letter Clipping Front images scanned using the
Carrier Sheet
22 - ADF(CarrierSheet Clipping CARD_T) Card Clipping Front images scanned using the
Carrier Sheet
23 - ADF(CarrierSheet Clipping CARD_Y) Card landscape Clipping Front images scanned
using the Carrier Sheet
24 - ADF(CarrierSheet Clipping PHOTO_ET) Photo E portrait Clipping Front images
scanned using the Carrier Sheet
25 - ADF(CarrierSheet Clipping PHOTO_EY) Photo E landscape Clipping Front images
scanned using the Carrier Sheet
26 - ADF(CarrierSheet Clipping PHOTO_LT) Photo L portrait Clipping Front images
scanned using the Carrier Sheet
27 - ADF(CarrierSheet Clipping PHOTO_LY) Photo L landscape Clipping Front images
scanned using the Carrier Sheet

168
28 - ADF(CarrierSheet Clipping PHOTO_LLT) Photo LL portrait Clipping Front images
scanned using the Carrier Sheet
29 - ADF(CarrierSheet Clipping PHOTO_LLY) Photo LL landscape Clipping Front images
scanned using the Carrier Sheet
30 - ADF(CarrierSheet Clipping Auto) Automatic detection Clipping Front images
scanned using the Carrier Sheet
31 - ADF(CarrierSheet Clipping Custom) Custom Clipping Front images scanned
using the Carrier Sheet
32 - ADF(CarrierSheet Clipping Duplex All) Carrier Sheet Size Clipping Duplex images
scanned using the Carrier Sheet
33 - ADF(CarrierSheet Clipping Duplex A4) A4 Clipping Duplex images scanned using
the Carrier Sheet
34 - ADF(CarrierSheet Clipping Duplex A5) A5 Clipping Duplex images scanned using
the Carrier Sheet
35 - ADF(CarrierSheet Clipping Duplex A6) A6 Clipping Duplex images scanned using
the Carrier Sheet
36 - ADF(CarrierSheet Clipping Duplex POST) POST Card Clipping Duplex images
scanned using the Carrier Sheet
37 - ADF(CarrierSheet Clipping Duplex B5) B5 Clipping Duplex images scanned using
the Carrier Sheet
38 - ADF(CarrierSheet Clipping Duplex B6) B6 Clipping Duplex images scanned using
the Carrier Sheet
39 - ADF(CarrierSheet Clipping Duplex LT) Letter Clipping Duplex images scanned
using the Carrier Sheet
40 - ADF(CarrierSheet Clipping Duplex CARD_T) Card Clipping Duplex images
scanned using the Carrier Sheet
41 - ADF(CarrierSheet Clipping Duplex CARD_Y) Card landscape Clipping Duplex
images scanned using the Carrier
Sheet
42 - ADF(CarrierSheet Clipping Duplex PHOTO_ET) Photo E portrait Clipping Duplex
images scanned using the Carrier
Sheet
43 - ADF(CarrierSheet Clipping Duplex PHOTO_EY) Photo E landscape Clipping Duplex
images scanned using the Carrier
Sheet
44 - ADF(CarrierSheet Clipping Duplex PHOTO_LT) Photo L portrait Clipping Duplex
images scanned using the Carrier
Sheet
45 - ADF(CarrierSheet Clipping Duplex PHOTO_LY) Photo L landscape Clipping Duplex
images scanned using the Carrier
Sheet
46 - ADF(CarrierSheet Clipping Duplex PHOTO_LLT) Photo LL portrait Clipping Duplex
images scanned using the Carrier
Sheet
47 - ADF(CarrierSheet Clipping Duplex PHOTO_LLY) Photo LL landscape Clipping Duplex
images scanned using the Carrier
Sheet
48 - ADF(CarrierSheet Clipping Duplex Auto) Automatic detection Clipping Duplex
images scanned using the Carrier
Sheet
49 - ADF(CarrierSheet Clipping Duplex Custom) Custom Clipping Duplex images
scanned using the Carrier Sheet

Default
1 - ADF ADF (Face scan)

Explanation
Selects the paper feed method for scanning.
Flatbed: Fixes the document on the document table to scan one at

169
 a time.
ADF (Auto Document Feeder): Places multiple documents on the ADF, feeds them one by
one to carry out a continuous scan. This makes it possible
to scan only one side (face or back) and simultaneously
scan both sides according to the setting.
CarrierSheet: Load a single document inserted inside the Carrier Sheet
onto the ADF and scan it in duplex scan mode. Only one
page (two facing spread pages combined as one entire
image, or two different pages on one image) is scanned.
Depending on the detection error around the folded part of
the document, some part of the image may be lacked. In
such case, place the document about 1mm inside from the
edge of the Carrier Sheet. Note this is not recommended
for scanning that requires image accuracy.
When "2 - ADF (Duplex)" (ADF duplex scan) is specified, if the ScanCount property is set to
1 (1-page scan), only the face of a document will be scanned.
Specify "2 - RGB" for the PixelType property for scanning when "4 - ADF(CarrierSheet
Spread A3)", "5 - ADF(CarrierSheet Spread DL)", "6 - ADF(CarrierSheet Spread B4)" , or "7 -
ADF(CarrierSheet Clipping)" is specified.
To set "10 - ADF(CarrierSheet Spread A3)" - "49 - ADF(CarrierSheet Clipping Duplex
Custom)" for this property, be sure to set "0 - File" or "1 - Dib Handle" for the ScanTo
property.
Note: Settings of other properties may not be effective (i.e., settings are ignored) depending
on the value specified for this property. Refer to "3.2 Relationships Between Properties" and
"3.3 Property Priority Order."

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
FrontBackMergingEnabled
IsExistsFB
ManualFeedMode
PageCount
PaperSize
ScanCount

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If some devices do not support "0 - Flatbed," "1 - ADF" will be set when scanning to carry out
a scan.
If "2 - ADF (Duplex)," is not supported depending on devices, "1 - ADF" will be set when
scanning to carry out a scan.
And if "3 - ADF (BackSide)," is not supported depending on devices, "1 - ADF" will be set
when scanning to carry out a scan.
If an error occurs in the middle of ADF scanning, some devices may go to the scanning of a
next page.
Depending on the scanner you are using, the scanning operation is NOT guaranteed if
parameters "4 - ADF(CarrierSheet Spread A3)" - "49 - ADF(CarrierSheet Clipping Duplex
Custom)" are not supported.
(* Refer to "Reference Manual (Separate Volume).")

170
Compatibility and Restraints
If the "ShowSourceUI" property is set to "True", and this property is set from "24 -
ADF(CarrierSheet Clipping PHOTO_ET)" to "29 - ADF(CarrierSheet Clipping PHOTO_LLY)"
or "42 - ADF(CarrierSheet Clipping Duplex PHOTO_ET)" to "47 - ADF(CarrierSheet Clipping
Duplex PHOTO_LLY" on a non-Japanese operating system, "Letter" is shown for the paper
size of the source user interface.
* Refer to "Reference Manual (Separate Volume)".

171
1.1.143 ParentAppName .... specifying the parent application name
Feature
This property ceased to be supported after V1.0L22.

Compatibility and Restraints

This property is provided for compatibility.
Provided as a compatible for recompiling the source program created by a version of SDK
older than V1.0L22 as is using an SDK version V1.0L22 or later. Note that compiling may
become impossible in the future, should a major update of the version be conducted. Do not
use this property when newly developing applications.

172
1.1.144 PatchCodeDetection .... Patch code detection
Feature
Sets patch code detection.

Coding Style
[form.] scancontrolname.PatchCodeDetection [ = Boolean ]

Value
True Patch code detection is performed.
False Patch code detection is not performed.

Default
False Patch code detection is not performed.

Explanation
Sets patch code detection.
If "True" is set for the patch code detection property, the DetectPatchCode event is issued
when a patch code is detected.
Refer to the DetectPatchCode event.
For detection conditions on patch codes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property is disabled due to the device type, set this property to "False" during scanning
execution to perform the scan. (* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

173
1.1.145 PatchCodeDirection .... Patch code detection direction setting
Feature
Sets the direction of the patch code that is detected.

Coding Style
[form.] scancontrolname.PatchCodeDirection [ = Short ]

Value
0 - Horizontal Horizontal direction
1 - Vertical Vertical direction
2 - Horizontal & Vertical Horizontal and vertical directions

Default
1 - Vertical Vertical direction

Explanation
Sets the direction of the patch code that is detected.
This property is enabled only when the PatchCodeDetection property is set to "True".
For detection conditions on patch codes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PatchCodeDetection

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

If "1 - PatchCode" is set for the JobControlMode property, the value of this property is set for
the patch code detection direction of PaperStream IP (TWAIN) driver UI job control.

174
1.1.146 PatchCodeType .... Patch code type setting
Feature
Sets the type of patch code that is detected.

Coding Style
[form.] scancontrolname.PatchCodeType [ = Integer ]

Value
Sets the type of patch code that is detected.
1 - Patch 1
2 - Patch 2
4 - Patch 3
8 - Patch 4
32 - Patch 6
256 - Patch T

Default
303 All types

Explanation
Sets the type of patch code that is detected.
This property is enabled only when the PatchCodeDetection property is set to "True".
If detection of multiple patch codes is set, set the total setting value of the types.
Example:
To detect "1 - Patch 1" and "2 - Patch 2", set "3".
For detection conditions on patch codes, refer to the driver help.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PatchCodeDetection

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

If "1 - PatchCode" is set for the JobControlMode property, the value of this property is set for
the patch code type of PaperStream IP (TWAIN) driver UI job control.

175
1.1.147 PatternRemoval
.... Dynamic Threshold (iDTC) binary pattern removal setting
Feature
Sets the removal of the Dynamic Threshold (iDTC) binary pattern.

Coding Style
[form.] scancontrolname.PatternRemoval [ = Short ]

Value
0 - OFF Pattern is not removed.
1 - Standard Pattern is removed (standard).
2 - Advanced Pattern is removed (advanced).
3 - Strong Pattern is removed (Strong).

Default
1 - Standard Pattern is removed (standard).

Explanation
Sets whether the Dynamic Threshold (iDTC) binary pattern is removed.
This property is enabled only when "0 - Black & White" is specified for the PixelType property
and "-2" is specified for the Threshold property. Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

176
1.1.148 PixelType .... pixel type
Feature
Sets the pixel type.

Coding Style
[form.] scancontrolname.PixelType [ = Short ]

Value
0 - Black & White Binary (Black and White)
1 - Grayscale Grayscale
2 - RGB RGB color
3 - Automatic Auto color detection
4 - SwitchByCodeSheet Switching by code sheets

Default
0 - Black & White Binary (Black and White)

Explanation
Sets the scan pixel type.
To scan by setting Grayscale for the PixelType property:
- When the data is output to file (ScanTo property is set to "0- File"), or when data is
passed via memory (ScanTo property is set to "2 - RawImageHandle")
-Set the FileType property as "0 - BMP" or "3 - JPEG"
-Set "1 - TIF," "2 - Multipage TIFF," "4 - PDF" or "5 - Multipage PDF" for the FileType
property and then set "0 - No Compress" for the CompressionType property.
- Pass by DIB handle (if "1 - Dib Handle" is set for the ScanTo property)
There is no property in particular to set.

Note that at the time of output to file or pass by memory, this property may be forcibly set to
"0 - Black & White."
(If the CompressionType property is set to "1 - CCITT G3(1D)," " 2 - CCITT G3(2D) KFactor
= 2," " 3 - CCITT G3(2D) Kfactor = 4" or "4 - CCITT G4," that setting is given higher priority
and a scan will be carried out by setting this property as "0 - Black & White.")
Also, the setting for this property cannot be enabled depending on the setting for the Outline
property.
- If the Outline property is set to "0-3" or "5," PixelType=binary(black and white) and
PixelType=RGB are enabled. If not enabled, the value will not be updated.
- When the Outline property is set to "4," and when PixelType=binary(black and white)
is enabled, if this property cannot be enabled, the value will not be updated.
- When the Outline property is set to "6-8," and when PixelType=RGB is enabled, if
this property cannot be enabled, the value will not be updated.
- When the Outline property is set to 0, PixelType = RGB/Black & White Automatic
Detection is enabled. The value is not updated if this property is disabled.
Therefore, if you want to change the status when the Outline property is set to "4" and
PixelType=binary (black and white) to the status of PixelType=RGB, set the Outline
parameter as "0" once, then change the PixelType to RGB.

If this property is set to "4 - SwitchByCodeSheet", the scan settings are changed everytime a
patch code is detected.
For details on the items to be set, refer to the driver help.

Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

177
Target method
StartScan

Related Properties
AutoProfile
CompressionType
DivideLongPage
FileType
FrontBackMergingEnabled
JobControl
JpegQuality
Outline
PaperSupply
PatchCodeDetection
ScanMode
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

In V1.0, at the time of pass by memory (when "2 - Raw Image Handle" is set for the ScanTo
property), "0 - No Compress" is set for the CompressionType property, while in V2.0L10 or
later, the above setting does not need to be made.
This property depends on the value specified as the Outline property. To specify this
property, set the Outline property to "0 - None" in advance.
If this property is set to "3 - Automatic" or "4 - SwitchByCodeSheet", the CompressionType
property and FileType property may not always be the expected value.

178
1.1.149 PreFiltering .... ballpoint pen filtering

Feature
Sets the ballpoint pen filtering mode.

Coding Style
[form.] scancontrolname.PreFiltering [ = Boolean ]

Value
True Enables the ball point pen filtering mode.
False Disables the ball point pen filtering mode.

Default
False Disables the ball point pen filtering mode.

Explanation
When scanning documents written with a ballpoint pen, because the reflected light of
ballpoint pen ink is not homogeneous, part of a letter may drop out. If this setting is enabled,
filtering will be carried out to correct broken and thin lines.
This property is enabled only when the PixelType property is set to "0 - Black & White" and
"0" is specified for the Threshold property. Otherwise, it will be disregarded.
Because this property is not supported in devices without an image processing board, in
such a case, a scan will be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume)." )
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

179
1.1.150 PunchHoleRemoval .... Punch hole removal
Feature
Sets removal of punch holes.

Coding Style
[form.] scancontrolname.PunchHoleRemoval [ = Short ]

Value
0 - Do not remove Punch holes are not removed.
1 - White Punch holes are filled with white.
2 - Background color Punch holes are filled with the background color.

Default
0 - Do not remove

Explanation
Sets removal of punch holes.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoBorderDetection
BackgroundColor
OverScan
PaperSupply
UndefinedScanning

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

180
1.1.151 PunchHoleRemovalMode .... Punch hole removal mode
Feature
Sets the type of punch holes to be removed.

Coding Style
[form.] scancontrolname.PunchHoleRemovalMode [ = Short ]

Value
0 - Standard Standard holes
1 - Advanced Holes larger than standard holes

Default
0 - Standard Standard holes

Explanation
Sets the type of punch holes to be removed.
This property is enabled only when the PunchHoleRemoval property is set to "1 - White" or
"2 - Background color".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PunchHoleRemoval

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

181
1.1.152 RegionLeft .... Left Edge of the Scanning Area
Feature
Configures the left edge of the scanning area.

Coding Style
[form.] scancontrolname.RegionLeft [ = Single ]

Value
The left edge of the scanning area.

Default
0

Explanation
Specify the left edge of the scanning area.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionTop
RegionWidth
RegionLength
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
When a negative value is specified for the RegionLeft, RegionTop, RegionWidth, and
RegionLength properties, these four properties are set to "0" and the whole document is
scanned.
Also, the scanning area specified by the RegionLeft property does not fit into the document
size (area) specified by either the PaperSize property or the CustomPaperWidth property,
this property is set to "0" at scanning.

Compatibility and Restraints

N/A

182
1.1.153 RegionLength .... Length of the Scanning Area
Feature
Configures the length of the scanning area.

Coding Style
[form.] scancontrolname.RegionLength [ = Single ]

Value
The length of the scanning area.

Default
0

Explanation
Specify the length of the scanning area.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionLeft
RegionTop
RegionWidth
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
When the RegionWidth and RegionLength properties are set to "0,” the scan is performed on
the document size specified by the PaperSize, CustomPaperWidth, and
CustomPaperLength properties.
When a negative value is specified for the RegionLeft, RegionTop, RegionWidth, and
RegionLength properties, these four properties are set to "0" and the whole document is
scanned.
If the length of the scanning area is set to less than one inch, the length is rounded up to one
inch at scanning.
With the FUJITSU TWAIN32 driver is used, if the length of the scanning area is set to less
than one inch (26 mm), the length is rounded up to one inch (26 mm) at scanning.
With the PaperStream IP (TWAIN) driver is used, if the length of the scanning area is set to
less than one inch (25.4 mm), the length is rounded up to one inch (25.4 mm) at scanning.
Also, the scanning area specified by the RegionLength property does not fit into the
document size specified by either the PaperSize property or the CustomPaperLength

183
property, this property is adjusted to fit into the document size (area) at scanning.

Compatibility and Restraints

N/A

184
1.1.154 RegionTop .... Top Edge of the Scanning Area
Feature
Configures the top edge of the scanning area.

Coding Style
[form.] scancontrolname.RegionTop [ = Single ]

Value
The top edge of the scanning area.

Default
0

Explanation
Specify the top edge of the scanning area.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
CustomPaperLength
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionLeft
RegionWidth
RegionLength
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
When a negative value is specified for the RegionLeft, RegionTop, RegionWidth, and
RegionLength properties, these four properties are set to "0" and the whole document is
scanned.
Also, the top edge of the scanning area specified by the RegionTop property does not fit into
the document size (area) specified by either the PaperSize property or the
CustomPaperLength property, this property is set to "0" at scanning.

Compatibility and Restraints

N/A

185
1.1.155 RegionWidth .... Width of the Scanning Area
Feature
Configures the width of the scanning area.

Coding Style
[form.] scancontrolname.RegionWidth [ = Single ]

Value
The width of the scanning area.

Default
0

Explanation
Specify the width (horizontal direction) of the scanning area.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionLeft
RegionTop
RegionLength
Unit

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
No error check is done at the time of setting.
When the RegionWidth and RegionLength properties are set to "0,” the scan is performed on
the document size specified by the PaperSize, CustomPaperWidth, and
CustomPaperLength properties.
When a negative value is specified for the RegionLeft, RegionTop, RegionWidth, and
RegionLength properties, these four properties are set to "0" and the whole document is
scanned.
With the FUJITSU TWAIN32 driver is used, if the width of the scanning area is set to less
than one inch (26 mm), the width is rounded up to one inch (26 mm) at scanning.
With the PaperStream IP (TWAIN) driver is used, if the width of the scanning area is set to
less than one inch (25.4 mm), the width is rounded up to one inch (25.4 mm) at scanning.
Also, the scanning area specified by the RegionWidth property does not fit into the document
size specified by either the PaperSize property or the CustomPaperWidth property, this
property is adjusted to fit into the document size (area) at scanning.

186
Compatibility and Restraints
N/A

187
1.1.156 Report .... Report Output
Feature
Configures the output method of the scan result.

Coding Style
[form.] scancontrolname.Report [ = Short ]

Value
0 - OFF No reporting of the result
1 - Display Output the result on the screen (dialog box display)
2 - File Output the result to a file
3 - Display+File Output the result to the screen and a file

Default
0 - OFF No reporting of the result

Explanation
Specify the output method of the scan result.
Duration from when the scan start button is pressed till the completion of the scan in
ppm/ipm units, and scan attributes (resolution, document size, image type, etc.) are output.
The output is produced after the driver is closed. If another scan is performed without closing
the driver screen, the result is output immediately before closing the driver.

Target method
StartScan

Related Properties
MultiStreamMode
ReportFile

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
The value is not updated when any value outside the range is specified.
The result is not output when the number of scanned pages is 0 (no scanning has been
performed) or an error occurred during the scan.

Compatibility and Restraints

N/A

188
1.1.157 ReportFile .... Report File Name
Feature
Configures the file name for the scan result.

Coding Style
[form.] scancontrolname.ReportFile [ = String ]

Value
The file name for storing the scan result (a character string which includes the absolute path
and terminates with a null).

Default
"" (empty character string)

Explanation
Specify a file name when outputting the scan result into a file.
This property is valid only when the Report property is set to "2 - File" or "3 - Display+File."
Duration from when the scan start button is pressed till the completion of the scan in
ppm/ipm units, and scan attributes (resolution, document size, image type, etc.) are output.
The output is produced after the driver is closed. If another scan is performed without closing
the driver screen, the result is output immediately before closing the driver.
Note: Specification of this property is enabled or disabled (ignored) depending on the setting
values of other properties. Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
Report

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
This property is ignored at scanning if the Report property is set to anything other than "2 -
File" or "3 - Display+File."
The file name is checked at the execution. The process terminates without writing the result
to the file if the file name is invalid or a write error occurred.
A file without the scan result may be created when the disk space is insufficient.
The operation is not guaranteed if a relative path is specified. The file may be created in an
unintended location.
Also, the result is not output when the number of scanned pages is 0 (no scanning has been
performed) or an error occurred during the scan.

Compatibility and Restraints

N/A

189
1.1.158 Resolution .... Standard Resolution
Feature
Specifies the scan resolution.

Coding Style
[form.] scancontrolname.Resolution [ = Short ]

Value
0 - 200x200 [dpi]
1 - 240x240 [dpi]
2 - 300x300 [dpi]
3 - 400x400 [dpi]
4 - 500x500 [dpi]
5 - 600x600 [dpi]
6 - 700x700 [dpi]
7 - 800x800 [dpi]
9 - 1200x1200 [dpi]
99 - Custom

Default
2 - 300x300 [dpi]

Explanation
Select and configure the resolution for scanning from the above settable values.
Scanning may not be possible in relation to the document size even if the resolution is
supported by the device.
Example) "7 - 800 x 800" is specified on the document size A3 for a scan.

Target method
StartScan
Related Properties
CustomResolution
FrontBackMergingEnabled
PaperSize

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If the specified resolution is not supported by the device, the default value is applied at
scanning.
Note: Supported resolutions vary by devices.
Refer to "Operator Guide" included in your device.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

The default has been changed to 2 instead of 3 since V2.0L10.

190
1.1.159 Reverse .... Black and White Inversion / Color Inversion
Feature
Configures whether to invert black and white or invert color.

Coding Style
[form.] scancontrolname.Reverse [ = Boolean ]

Value
True Apply the black and white inversion / color inversion process
False Do not apply the black and white inversion / color inversion process

Default
False Do not apply the black and white inversion / color inversion process

Explanation
Specify whether to apply the black and white inversion / color inversion process.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
This property may not be valid in relation to the PixelType property depending on devices. In
such cases, the PixelType property takes precedence and the scan process is performed
with the default value of the Reverse property.

Compatibility and Restraints

N/A

191
1.1.160 Rotation .... Rotation Angle
Feature
Configures the rotation angle of the scanned image.

Coding Style
[form.] scancontrolname.Rotation [ = Short ]

Value
0 - None No rotation
1 - R90 Rotate 90 degrees to the right
2 - R180 Rotate 180 degrees to the right
3 - R270 Rotate 270 degrees to the right
4 - Automatic Automatic

Default
0 - None No rotation

Explanation
Rotate the scanned image by the specified degree and output the image.
Specify the degree to rotate the scanned image.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
FrontBackMergingEnabled
PaperSupply
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

192
1.1.161 ScanContinue .... Setting Continuous Scanning
Feature
Sets continuous scanning.

Coding Style
[form.] scancontrolname.ScanContinue [ = Boolean ]

Value
True Continue scanning
False Do not continue scanning

Default
False Do not continue scanning

Explanation
Specify whether to finish scanning, or to load another document and continue scanning after
the document that is currently loaded on the scanner is scanned.
To set the continuous scanning method, use the ScanContinueMode property.

Target method
StartScan

Related Properties
DivideLongPage
ScanContinueMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
None

Compatibility and Restraints

None

193
1.1.162 ScanContinueMode .... Setting Continuous Scanning Method
Feature
Sets the continuous scanning method.

Coding Style
[form.] scancontrolname.ScanContinueMode [ = Short ]

Value
0 - Manual Manual
1 - Automatic Automatic

Default
0 - Manual Manual

Explanation
Sets the continuous scanning method.
This property is enabled only when the ScanContinue property is set to "True".
If "0 - Manual" is specified, the scanner enters a standby state with the preview window
displayed after the loaded documents are scanned. To continue scanning, load the
additional documents and click the [Scan] button. To end a scan, click the [Finish] button.
Specifying "1 - Automatic" is useful for scanning with the ADF. The scanner enters a standby
state with the preview window displayed after the loaded documents are scanned. To
continue scanning, load the additional documents. Scanning starts automatically. To end a
scan, click the [Finish] button. When you scan a document with the flatbed, the scanner
operation is the same as in the case where "0 - Manual" is specified.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
ScanContinue

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

None

194
1.1.163 ScanCount .... Number of Pages to be Scanned
Feature
Configures the number of pages to scan.

Coding Style
[form.] scancontrolname.ScanCount [ = Short ]

Value
-1 or any value between 1 and 32767 (number of pages)
All pages on the ADF are scanned if "-1" is specified.
("0" is not valid)

Default
"-1" (all pages on the ADF)

Explanation
Specify the number of pages to be scanned in once when performing a continuous scan
from the ADF.
This property is valid only when the PaperSupply property is set to "1 - ADF," "2 - ADF
(Duplex)," or "3 - ADF (BackSide)."
The scan is performed only once if "0 - Flatbed" is specified.
Also, if "2 - ADF (Duplex)" is specified whilst this property is set to "1," only the front side of
the page is scanned. Specify "2" to this property (total of the front and reverse sides is 2
pages) when both sides of the document should be scanned.
When "6 - Multi Image Output" is specified for the FileType property, the maximum value that
can be specified for this property is 16,383. Do not specify a value that exceeds the
maximum value.
Note: Specification of this property is enabled or disabled (ignored) depending on the setting
values of other properties. Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
FileType
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
When the number of pages loaded on the ADF is fewer than the number specified in this
property, RC_FAILURE is returned after scanning all pages from the ADF. At this time, the
ErrorCode property is set with a value "EC_NOT_ENOUGH_PAPER." Reload the document
and call the StartScan method to continue scanning.

Compatibility and Restraints

When the number of pages loaded on the ADF is more than the number specified in this
property, the last page specified in ScanCount property is not completely ejected by the
device.
If Cache mode of the FUJITSU TWAIN32 driver is set to a value other than "None",
documents exceeding the quantity specified by this property may be fed.

195
1.1.164 ScanMode .... Scan mode
Feature
Sets the scan mode.

Coding Style
[form.] scancontrolname.ScanMode [ = Short ]

Value
0 - Normal Scan A normal scan is performed.
1 - Assist Scan An assist scan is performed.

Default
0 - Normal Scan A normal scan is performed.

Explanation
Sets the scan mode.
If "1 - Assist Scan" is set for this property, after scanning, the Assist Scan window of the
source is displayed.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
FrontBackMergingEnabled
MultiStreamMode
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restrictions

N/A

196
1.1.165 ScanTo .... Output Method of Scanned Data
Feature
Configures the output method of scanned data.

Coding Style
[form.] scancontrolname.ScanTo [ = Short ]

Value
One of the following methods to output scanned data.
0 - File File
1 - Dib Handle DIB handle (Unsupported in Java)
2 - Raw Image Handle Memory (Unsupported in Java)

Default
0 - File File

Explanation
Specify the output method of data scanned by an image scanner.
- Data is output as a file when "0 - File" is specified.
Specify the FileName property and FileType property.
- A ScanToDibEx event is issued and the DIB handle is passed when "1 - Dib Handle" is
specified.
For details, refer to the ScanToDibEx event.
- A ScanToRaw event is issued and the memory handle is passed when "2 - Raw Image
Handle" is specified. For details, refer to the ScanToRawEx event.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".
Target method
StartScan

Related Properties
MultiStreamMode
When "0 - File" is specified.
FileName
FileType
When "2 - Raw Image Handle " is specified.
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

- For Java, only the value "0 - File" is available.
- Point to note when "2 - Raw Image Handle" is specified
"TWAIN driver" is a driver that conforms to the TWAIN standards, and generates image
data aligned on 4-byte boundaries. The SDK passes image data generated by the "TWAIN
driver" to the application as it is. When the application handles the image data, make sure
that the image data is aligned on 4-byte boundaries.

197
1.1.166 SDTCSensitivity .... Automatic (simple) binary dispersion value
Feature
Sets the automatic (simple) binary dispersion value.

Coding Style
[form.] scancontrolname.SDTCSensitivity [ = Short ]

Value
Value in the range from 1 (low) to 3 (high)

Default
2

Explanation
Sets the automatic (simple) binary dispersion value.
This property is enabled only when the Threshold property is set to "0".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between 1 and 3).

Compatibility and Restrictions

N/A

198
1.1.167 SEE .... Selectable Edge Enhancement

Feature
Configures whether to apply selectable edge enhancement.

Coding Style
[form.] scancontrolname.SEE [ = Short ]

Value
0 - OFF Do not apply selectable edge enhancement
1 - ON Apply selectable edge enhancement

Default
0 - OFF Do not apply selectable edge enhancement

Explanation
Specify the selectable edge enhancement processing (SEE: Selectable Edge
Enhancement).
Line drawings (characters) and photo images are scanned at half tone and the edge
enhancement process is applied on the line drawing sections.
This process is suitable to emphasize characters in a document containing characters and
photos.
This property is valid only when the PixelType property is set to "0 - Black & White", the
AutoSeparation property is set to "0 - OFF" and the Halftone property is set to any value
other than "0 - None".
Note: Specification of this property is enabled or disabled (ignored) depending on the setting
values of other properties. Refer to "3.2 Relationships Between Properties" and "3.3 Property
Priority Order."

Target method
StartScan

Related Properties
AutoSeparation
CompressionType
Halftone
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
This property is ignored at scanning if the PixelType property is set to "1 - Grayscale" or "2 -
RGB" or the AutoSeparation property is set to "1 - ON."
If the Halftone property is set to "0 - None," change it to "1 - Dither Pattern 0" (for dark
images).

On the scanner that does not support this property, if it is set to "1 - ON," the Halftone effect
may be produced on the scanned image.

Compatibility and Restraints

N/A

199
1.1.168 SelectOutputSize .... Selecting output size

Feature
Select the method for specifying the output size used for automatic cropping.

Coding Style
[form.] scancontrolname.SelectOutputSize [ = Short ]

Value
0 - Margin Margin
1 - ScanningArea Scanning area

Default
0 - Margin Margin

Explanation
Select the method for specifying the output size used for automatic cropping.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Some setting values are not supported depending on the specific device.
(* Refer to "Reference Manual (Separate Volume)".)

Compatibility and Restraints

N/A

200
1.1.169 Shadow .... shadow
Feature
Sets shadows.

Coding Style
[form.] scancontrolname.Shadow [ = Short ]

Value
Between 0 and 254.

Default
10

Explanation
Specify shadowing for images when scanning.
This property is enabled only when either "1 - Grayscale" or "2 - RGB" is set for the
PixelType property.
It is not possible to set a value higher than that specified as the Highlight property.
This property is invalid when the PaperSupply property is set as "4 - ADF(CarrierSheet
Spread A3)", "5 - ADF(CarrierSheet Spread DL)", "6 - ADF(CarrierSheet Spread B4)", or "7 -
ADF(CarrierSheet Clipping)".
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBright
Gamma
Highlight
PaperSupply
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if the specified value exceeds the available range (0 to 254) or the
value set for the Highlight property.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

The applicable value range for this property depends on the current Highlight property value.
Therefore, the Highlight property must be set first.

201
1.1.170 Sharpness .... Sharpness
Feature
Sets the sharpness.

Coding Style
[form.] scancontrolname.Sharpness [ = Short ]

Value
When PixelType is Simple slice binary (black and white)
0 - None N/A
1 - Emphasis Low Low (Emphasis)
2 - Emphasis Mid Medium (Emphasis)
3 - Emphasis High High (Emphasis)
4 - Edge Extract Edge extraction
5 - Smoothing Level 1 Smoothing level 1
6 - Smoothing Level 2 Smoothing level 2
7 - Smoothing Level 3 Smoothing level 3
8 - Smoothing Level 4 Smoothing level 4

When PixelType is Grayscale/RGB

0 - None N/A
1 - Emphasis Low Low (Emphasis)
2 - Emphasis Mid Medium (Emphasis)
3 - Emphasis High High (Emphasis)
5 - De-Screen Level 1 De-Screen level 1
6 - De-Screen Level 2 De-Screen level 2
7 - De-Screen Level 3 De-Screen level 3
8 - De-Screen Level 4 De-Screen level 4

Default
0 - None N/A

Explanation
Sets the sharpness of images when scanning.
Emphasis: Outputs the scanned image with its outline emphasized.
Three levels (low/medium/high) are selectable.
Smoothing: Smoothes the jagged edges.
Edge extraction: Outputs the edges of an image.
De-Screen Level: Smoothes the inside of an image and carries out de-screening.
The higher the level, the smoother the image.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

202
Error Recovery
Value will not be updated if set beyond the setting range.
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

203
1.1.171 ShowSourceUI .... Source User Interface (UI) Display
Feature
Configures whether to display the source user interface (UI).

Coding Style
[form.] scancontrolname.ShowSourceUI [ = Boolean ]

Value
True Display the source user interface
False Do not display the source user interface

Default
True Display the source user interface

Explanation
Specify whether to display the source user interface (UI) at scanning.
This should be set to "False" when performing an automatic scanning process.

Example of a FUJITSU TWAIN32 driver user interface display

204
 Example of a PaperStream IP(TWAIN) driver user interface display

If the source user interface (UI) is closed using either the close box or the [Close] button
without scanning, the StartScan method reports RC_SUCCESS in the return value.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

205
1.1.172 SilentMode .... Silent Mode
Feature
Configures whether to execute the source in silent mode.

Coding Style
[form.] scancontrolname.SilentMode [ = Boolean ]

Value
True Silent mode
False Normal mode

Default
False Normal mode

Explanation
Specify whether to execute the source in silent mode (the mode without any notifications
such as error messages).
No error messages are output if "True" is specified.
Error messages are output as of normal mode if "False" is specified.

Target method
StartScan

Related Properties
ErrorCode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Error message display should be handled by applications. Refer to the ErrorCode property
about details on errors.

Compatibility and Restraints

Errors at opening the source may be output even if this property is set to "True."
Example) "Please wait for the scanner lamp to warm up."
"A general fault of the MSG_OPENDS response. (Internally) There has been a
sharing violation. Twain source may be in use. (Code: DS50171)”
"Communication failed.
Make sure that the power is on, the cable is firmly connected, and the scanner
is not used by another application.
Note that some scanners may turn off automatically. In case the scanner is
turned off, turn the power back on and then try again.(Code: DS42019)”

206
1.1.173 SimpleSlicePatternRemoval .... Simple slice binary pattern removal setting

Feature
Sets the removal of the simple slice binary pattern.

Coding Style
[form.] scancontrolname.SimpleSlicePatternRemoval [ = Boolean ]

Value
True Pattern is removed.
False Pattern is not removed.

Default
False Pattern is not removed.

Explanation
Sets whether the simple slice binary pattern is removed.
This property is enabled when "0 - Normal Scan" is specified for the ScanMode property,
"0 - Black & White" is specified for the PixelType property, and "1" to "255" is specified for
the Threshold property. Note, however, that any value specified between "1" and "255" does
not affect the quality of the image.
When "True" is specified for this property, the settings for the following properties are
ignored: AutoBright, Background, Brightness, Contrast, Filter, Gamma and Sharpness.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
ScanMode
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

207
1.1.174 SkipBlackPage .... Skip Black Pages

Feature
Configures whether to skip blank pages (black pages) when scanning continuously from an
ADF.

Coding Style
[form.] scancontrolname.SkipBlackPage [ = Short ]

Value
0 - Do not skip
For FUJITSU TWAIN32 driver
1 – 15 - Specify the ratio of white dots on a black page by increments of 0.2%. The
maximum value that can be specified is 3.0%.
For PaperStream IP (TWAIN) driver
1 – 50 - Specify the ratio of white dots on a black page by increments of 0.1%. The
maximum value that can be specified is 5.0%.

Default
0 - Do not skip

Explanation
Specify whether to skip blank pages (black pages) when scanning continuously from an
ADF.
A page is recognized as a blank page when the ratio of white dots is equal or less than the
specified value.
Values of the FileCounterEx property and PageCount property are not updated on pages
skipped.
This property is valid only when the PixelType property is set to "0 - Black & White."
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageSkipMode
PaperSupply
PixelType
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
This property is ignored when the device does not support this property.
(* Refer to "Reference Manual (Separate Volume).")

208
Compatibility and Restraints
Enabling this function makes the scanner to change the Cache Mode to [Ram cache] or [Use
Both Memory] if the source (FUJITSU TWAIN32 driver) UI for cache settings is other than
[Ram cache] or [Use Both Memory].
For the PaperStream IP (TWAIN) driver, it is recommended to use the BlankPageSkip
property. The value set for the SkipBlackPage property is also applied to the BlankPageSkip
property. The value is applied as shown below.
The value is not applied if it is set when designed.

This property BlankPageSkip property

"1, 2" → "1"
"3, 4" → "2"
"5" → "3"
"6" → "4"
"7" → "5"
"8" → "6"
"9" → "7"
"10" → "8"
"11" → "9"
"12, 13" → "10"
"14 -50" → "11"

The property setting process to enable the value of this property for the PaperStream IP
(TWAIN) driver.
Example: // The property setting process
AxFiScn1. BlankPageSkip = 3
AxFiScn1. SkipBlackPage = 10 → Since the SkipBlackPage value is set after
// Starting the process of scanning the BlankPageSkip, the SkipBlackPage
… value is applied to the BlankPageSkip.

209
1.1.175 SkipWhitePage .... Skip White Pages
Feature
Configures whether to skip blank pages (white pages) when scanning continuously from an
ADF.

Coding Style
[form.] scancontrolname.SkipWhitePage [ = Short ]

Value
0 - Do not skip
For FUJITSU TWAIN32 driver
1 – 15 - Specify the ratio of black dots on a white page by increments of 0.2% when the
PixelType property is set to "0 - Black & White". The maximum value that can be
specified is 3.0%.
When the PixelType property is grayscale or RGB, the specified value between 1
and 15 is re-evaluated into five levels. Skipping is more likely as a larger value is
specified.
For PaperStream IP (TWAIN) driver
1 – 50 - Specify the ratio of black dots on a white page by increments of 0.1% when the
PixelType property is set to "0 - Black & White". The maximum value that can be
specified is 5.0%.

Default
0 - Do not skip

Explanation
Specify whether to skip blank pages (white pages) when scanning continuously from an
ADF.
A page is recognized as a blank page when the ratio of black dots is equal or less than the
specified value.
Values of the FileCounterEx property and PageCount property are not updated on pages
skipped.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
BlankPageSkipMode
PaperSupply
PixelType
ScanTo

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
This property is ignored when the device does not support this property.
(* Refer to "Reference Manual (Separate Volume).")

210
Compatibility and Restraints
Enabling this function makes the scanner to change the Cache Mode to [Ram cache] or [Use
Both Memory] if the source (FUJITSU TWAIN32 driver) UI for cache settings is other than
[Ram cache] or [Use Both Memory].
For the PaperStream IP (TWAIN) driver, it is recommended to use the BlankPageSkip
property. The value set for the SkipWhitePage property is also applied to the BlankPageSkip
property. The value is applied as shown below.
The value is not applied if it is set when designed.

This property BlankPageSkip property

"1, 2" → "1"
"3, 4" → "2"
"5" → "3"
"6" → "4"
"7" → "5"
"8" → "6"
"9" → "7"
"10" → "8"
"11" → "9"
"12, 13" → "10"
"14 -50" → "11"

The property setting process to enable the value of this property for the PaperStream IP
(TWAIN) driver.
Example: // The property setting process
AxFiScn1. BlankPageSkip = 3
AxFiScn1. SkipWhitePage = 10 → Since the SkipWhitePage value is set after
// Starting the process of scanning the BlankPageSkip, the SkipWhitePage
… value is applied to the BlankPageSkip.

211
1.1.176 Smoothing .... OCR Smoothing Mode / Background Removal
Feature
Configures the function smoothing rough lines and removes unevenness from the
background.

Coding Style
[form.] scancontrolname.Smoothing [ = Boolean ]

Value
True Enable smoothing mode
False Disable smoothing mode

Default
False Disables smoothing mode

Explanation
This function will smooth rough lines and removes unevenness from the background.
This property is enabled only when the PixelType property is set to "0 - Black & White" and
"0" is specified for the Threshold property. Otherwise, it will be disregarded.
Because this property is not supported in devices without an image processing board, in
such a case, a scan will be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")
Note: Specification of this property is enabled or disabled (ignored) depending on the setting
values of other properties. Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

212
1.1.177 SourceCurrentScan .... Scan with the Source Current Value
Feature
Configures whether to scan with the source current value.

Coding Style
[form.] scancontrolname.SourceCurrentScan [ = Boolean ]

Value
True Scan with the source current value
False Scan with the value set in the OCX property

Default
False Scan with the value set in the OCX property

Explanation
Specify whether to use the value currently set on the source at scanning.
When this property is set to "True," the scan process is performed with the value currently
set on the source.
The following properties are valid when this property is set to "True." (Any other properties
except the followings are invalid.)
AIQCNotice
ScanTo
FileType
FileName
CompressionType
ScanCount
ShowSourceUI
SilentMode
FileCounterEx
JpegQuality
Indecator
Overwrite
MultiFeedNotice

If this property is set False, this control changes the following source parameter to execute
a scan task.
・Multi Image setting ->The setting is disabled temporarily, but the source parameter is not
changed.
*For information about the Multi Image setting, see the Explanatory materials for the
TWAIN driver.

Target method
StartScan

Related Properties
AIQCNotice
CompressionType
FileCounterEx
FileName
FileType
Indicator
JpegQuality
MultiFeedNotice
Overwrite
ScanCount
ScanTo

213
ShowSourceUI
SilentMode

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

214
1.1.178 sRGB .... sRGB output
Feature
Sets the sRGB output.

Coding Style
[form.] scancontrolname.sRGB [ = Boolean ]

Value
True sRGB is output.
False sRGB is not output.

Default
False sRGB is not output.

Explanation
This sets the sRGB output.
This property is enabled only when "2 - RGB" is specified for the PixelType property.
Otherwise, it will be disregarded.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PaperSupply
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

215
1.1.179 StapleDetection.... Stapled Documents Detection
Feature
Specify whether to stop the scan when stapled documents are detected during scanning by
feeder.

Coding Style
[form.] scancontrolname.StapleDetection [ = Short ]

Value
0 - OFF Disabled
1 - ON Enabled
2 - Hardware Setting Uses the scanner settings

Default
1 - ON Enabled

Explanation
Automatically detects that stapled documents are being accidentally fed one by one and
stops feeding to prevent the damage from spreading.

Target method
StartScan

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

216
1.1.180 SynchronizationDigitalEndorser
.... Endorser / Imprinter and Digital Endorser synchronization function setting
Feature
Sets the endorser/imprinter and digital endorser synchronization function.

Coding Style
[form.] scancontrolname.SynchronizationDigitalEndorser [ = Boolean ]

Value
True Endorser/imprinter and digital endorser synchronization function is enabled.
False Endorser/imprinter and digital endorser synchronization function is disabled.

Default
False Endorser/imprinter and digital endorser synchronization function is disabled.

Explanation
Sets the endorser/imprinter and digital endorser synchronization function.
This property is enabled only when the Endorser property is set to "True" and the
DigitalEndorser property is set to "True".
When synchronization is performed, the properties of the endorser/imprinter below are
applied to the corresponding properties of the digital endorser.
EndorserCountDirection property → DigitalEndorserCountDirection property
EndorserCounter property → DigitalEndorserCounter property
EndorserCountStep property → DigitalEndorserCountStep property
EndorserString property → DigitalEndorserString property
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
DigitalEndorser
Endorser
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

217
1.1.181 Threshold .... Threshold
Feature
Configures the threshold.

Coding Style
[form.] scancontrolname.Threshold [ = Short ]

Value
Value in the range from -2 to 255
0 Automatic (simple) binary mode
-1 Automatic (advanced) binary mode
-2 Dynamic Threshold (iDTC) binary mode
1 to 255 Simple slice binary threshold value

Default
128

Explanation
Specify the threshold value for the binarization process.
This property is valid only when the PixelType property is set to "0 - Black & White" and the
Halftone property is set to "0 - None."
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
CompressionType
Halftone
PixelType

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range (value not between -2 and 255).
This property is ignored at scanning unless the PixelType property is set to "0 - Black &
White" and the Halftone property is set to "0 - None."

Compatibility and Restraints

N/A

218
1.1.182 ThresholdCurve .... Density Curve in Automatic Binarization
Feature
Configures the density curve while in automatic binarization.

Coding Style
[form.] scancontrolname.ThresholdCurve [ = Short ]

Value
0 - Curve1 Very light (for OCR)
1 - Curve2 Light (for OCR)
2 - Curve3 Normal 1 (for OCR)
3 - Curve4 Normal 2 (for OCR)
4 - Curve5 Dark (for OCR)
5 - Curve6 Very dark (for OCR)
6 - Curve7 Normal (for images)
7 - Curve8 Darkest (for images)

Default
0 - Curve1 Very light (for OCR)

Explanation
Specify the density curve when scanning in automatic binarization mode.
This property is valid only when the PixelType property is set to "0 - Black & White" and the
Threshold property is set to "0." Otherwise, it will be disregarded.
Because this property is not supported in devices without an image processing board, in
such a case, a scan will be carried out without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")
Note: Specification of this property is enabled or disabled (ignored) depending on the setting
values of other properties. Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.

Compatibility and Restraints

N/A

219
1.1.183 TwainDS .... Data Source
Feature
Configures the TWAIN data source.

Coding Style
[form.] scancontrolname.TwainDS [ = String ]

Value
The product name of the TWAIN data source.
(The source name which is displayed on the TWAIN data source selection screen)
The default TWAIN data source is used at scanning if "" (empty character string) is specified.

Default
"" (empty character string)

Explanation
Specify the TWAIN data source for scanning.
This is useful for defining a data source.
The TWAIN data source specified in this property does not affect the TWAIN default data
source.

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
TwainDSAnyPort

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
An error occurs if the specified data source does not exist.
When using the scanner connected via a USB port, if you change the current USB port to the
other, the TWAIN data source name will be changed as in the example below.
Example:
Before changing the USB port: RICOH fi-8040
After changing the USB port: RICOH fi-8040 #2
This means that an error still occurs when you specify a desired data source in this property
and change the USB port.
To avoid such an error, select one of the following ways:
- When using the PaperStream (TWAIN) driver and the SDK V2.2L95 or later
Set the TwainDSAnyPort property to "1- ON".
If the fiscn.ini file under the Windows directory (with C:\Windows as the default) has
already been used, change the description in the file to the default as follows:
[Mode]
AnyPort=0
- When using the FUJITSU TWAIN32 driver or an SDK that is older than V2.2L95
Change the description in the fiscn.ini file under the Windows directory (with C:\Windows
as the default) as follows:
(Default after the installation)
[Mode]

220
 AnyPort=0
(Settings after the changes)
[Mode]
AnyPort=1
With the settings above, this function automatically searches for any numbered TWAIN data
sources like #2, #3, etc., even if you have specified to search for unnumbered data sources.
Note the character string is case-sensitive.

Compatibility and Restraints

Set this property before calling the OpenScanner method or OpenScanner2 method. (The
OpenScanner method or OpenScanner2 method refers to this property.)
Call the TwainDSAnyPort property before calling this property.

221
1.1.184 TwainDSAnyPort .... Locking the Data Source Name
Feature
Sets whether or not to lock the TWAIN data source name that is to be used.

Coding Style
[form.] scancontrolname.TwainDSAnyPort [ = Short ]

Value
0 - OFF Does not lock the data source name
1 - ON Locks the data source name

Default
0 - OFF Does not lock the data source name

Explanation
When you use a scanner by connecting it to a USB port, "#n" is added to the TWAIN data
source name after you disconnect it from the USB port and connect it to a different port.
Whether or not to add "#n" to the TWAIN data source name is carried out by this property.
This function is useful when you want to restrict the TWAIN data source that is to be used.
When "0 - OFF" is set, "#n" is added to the TWAIN data source name after you disconnect
the scanner from the USB port and connect it to a different port. Below is an example that
shows the change in the TWAIN data source name.
(Example)
Before changing the USB port: RICOH fi-8040
After changing the USB port: RICOH fi-8040 #2
In the case that "1 - ON" is set, "#n" is not added to the TWAIN data source name even after
you disconnect the scanner from the USB port and connect it to a different port. Below is an
example that shows no change in the data source name.
(Example)
Before changing the USB port: RICOH fi-8040
After changing the USB port: RICOH fi-8040
This property must be set before the TwainDS property.

Target method
StartScan

Related Properties
TwainDS

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

When this property is set to "1 - ON", two or more scanners that are the same model cannot
be connected to the same computer.
When this property is set to "1 - ON", restart the computer if you disconnect the scanner from
the USB port and connect it to a different port.
Set this property before calling the OpenScanner method or the OpenScanner2 method.
(This property will be referenced by the OpenScanner method or the OpenScanner2
method.)

222
1.1.185 UndefinedScanning
.... Scanning an Undefined Length (Paper End Detection)
Feature
Configures whether to scan an undefined length (paper end detection).

Coding Style
[form.] scancontrolname.UndefinedScanning [ = Boolean ]

Value
True Scan an undefined length
False Do not scan an undefined length

Default
False Do not scan an undefined length

Explanation
Specify whether to scan an undefined length (paper end detection).
The scanner scans through the length of the document by detecting the paper end when
scanning from an ADF.
Therefore, the output corresponding to each document can be produced when continuously
scanning multiple documents with different lengths from an ADF.
This function is useful when scanning pages with various lengths.
However, scanning is not possible beyond the length specified in the PaperSize property.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties" and "3.3
Property Priority Order."

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
BackgroundColor
Deskew
DivideLongPage
FrontBackMergingEnabled
LengthDetection
OverScan
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restraints

N/A

223
1.1.186 Unit .... unit of size (inch / centimeter / pixel)
Feature
Sets the unit of size (inch/centimeter/pixel).

Coding Style
[form.] scancontrolname.Unit [ = Short ]

Value
0 - Inches Inches (inch)
1 - Centimeters Centimeters (cm)
2 - Pixels Pixels (Pixel)

Default
0 - Inches Inches (inch)

Explanation
Sets the unit of size (inch/centimeter/pixel).

Target method
StartScan

Related Properties
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionTop
BarcodeRegionWidth
CustomPaperLength
CustomPaperWidth
DigitalEndorserXOffset
DigitalEndorserYOffset
EndorserOffset
EdgeFillerBottom
EdgeFillerLeft
EdgeFillerRigth
EdgeFillerTop
FrontBackMergingTargetSize
MultiFeedModeChangeSize
RegionLeft
RegionLength
RegionTop
RegionWidth

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Depending on the setting value of this property, the valid range of setting values for the
related properties varies.
0 - Inches Up to three decimal places are valid
1 - Centimeters Up to one decimal place is valid
2 - Pixels Only integers are valid

224
Compatibility and Restraints
N/A

225
1.1.187 VerticalLineReduction .... Vertical line reduction setting
Feature
Sets whether the vertical lines are reduced.

Coding Style
[form.] scancontrolname.VerticalLineReduction [ = Boolean ]

Value
True Vertical lines are reduced.
False Vertical lines are not reduced.

Default
False Vertical lines are not reduced.

Explanation
Sets vertical line reduction.
Note: The value in this property can be enabled by the settings of other properties. Or it may
not be enabled (disregarded). Refer to "3.2 Relationships Between Properties".

Target method
StartScan

Related Properties
AutoBorderDetection
DivideLongPage
PaperSupply

Value Setting
When designed and when implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, a scan will be carried out
without regard to this property when scanning.
(* Refer to "Reference Manual (Separate Volume).")

Compatibility and Restrictions

N/A

226
1.2 Methods

1.2.1 List of Methods

The following describes methods supported by RICOH Scanner Control SDK.
PaperStream IP(TWAIN) driver : PSIP
FUJITSU TWAIN32 driver : TWAIN

Method Name Description PSIP TWAIN

AboutBox Displays a dialog box for this Control's version ○ ○

information.
CancelScan Stops scanning an image. ○ ○
This method is not supported by Java.
ClearPage Ejects the document loaded on the ADF. ○ ○
CloseScanner Performs the termination process after scanning. ○ ○
FeederLoaded Notifies whether or not the document is loaded on the ○ ○
ADF.
GetCapability Acquires the capability of the TWAIN data source from an ○ ○
application.
GetSerialNumber Obtains a scanner serial number. ○ ○

GetSIpcTemplateCount Acquires the total number of templates created by the N/A ○

"Image Processing Software Option."
GetSIpcTemplateName Acquires the template name corresponding to the N/A ○
template number specified by the "Image Processing
Software Option."
GetSIpcTemplateSelect Acquires the template number currently selected by the N/A ○
"Image Processing Software Option."
GetSourceCount Gets the total number of data source. ○ ○

GetSourceName Gets a data source name. ○ ○

GetSourceSelect Gets an index of the data source currently selected. ○ ○

GetTWAINTemplateCount Acquires the total number of setting files / profiles created ○ ○

in the TWAIN driver.
GetTWAINTemplateName Acquires the setting file / profile name corresponding to ○ ○
the setting file / profile number specified in the TWAIN
driver.
GetTWAINTemplateSelect Acquires the number of the setting file / profile currently ○ ○
selected in the TWAIN driver.
OpenScanner Performs the initialization process before scanning. ○ ○

OpenScanner2 Performs initialization process before scanning and ○ ○

assumes control of the scanner.
ScannerAvailable Checks if the scanner is in the ready status. ○ ○

SelectSource Performs the selection process of the data source. ○ ○

SelectSourceName Selects a data source name that is used for scanning. ○ ○

SetCapability Configures the capability on the TWAIN data source from ○ ○

an application.

227
 Method Name Description PSIP TWAIN
SetSIpcTemplateSelect Configures the template number which is used by the N/A ○
"Image Processing Software Option" for selection.
SetTWAINTemplateSelect Configures numbers for setting files / profiles stored in ○ ○
the TWAIN driver.
SetupDataSourcePropertie Displays the user interface with the configurable sources. ○ ○
s
StartScan Starts scanning an image according to the specified ○ ○
properties.

228
1.2.2 Examples and Notation Conventions in This Chapter
Feature
Describes the outline of the method.

Coding Style
Describes the usage and syntax of the method when coding a program.
Describes codes in accordance with the conventions of Visual Basic.
Example) [form.] scancontrolname.AboutBox
The part between square brackets ([ ]) can be omitted.

Parameters
Describes arguments to be passed to the method.

Explanation
Describes the use and function of the property. In addition, notes and restraints regarding
correlated properties are also described if necessary.

Target method
Shows the list of methods that, when processed, change the state of the property.

Related Properties
Gives all properties affecting each other.

Return Values
Describes return values from the method.

Error Recovery
Describes the handling in the event of invalid setting or processing.

Compatibility and Restraints

Describes differences in functionality between versions, or restraints on functionality, should
such be the case.

Sample
Describes simple program samples where necessary.

229
1.2.3 AboutBox .... Version Information Dialog Box Display
Feature
Displays a dialog box for this Control's version information.

Coding Style
[form.] scancontrolname.AboutBox

Parameters
N/A

Target method
N/A

Related Properties
N/A

Return Values
N/A

Sample
Displays a dialog box for this Control's version information.

[Visual Basic]
Private Sub Command5_Click()
' Display the version information dialog box
AxFiScn1.AboutBox()
End Sub

[Java]
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Display the version information dialog box
aboutBox();
} catch (FiScnException e) {
// Fix error
} finally {
// Internal End Process
unInitialize();
}

230
1.2.4 CancelScan .... Stopping an Image Scanning
Feature
Stops scanning an image.

Coding Style
[form.] scancontrolname. CancelScan() [ = Integer]

Parameters
N/A

Return Values
0 : RC_SUCCESS Normal end
-3 : RC_SEQUENCE_ERROR Sequence error

Explanation
Stops a scan that is started by the StartScan method.
This method must be called from either the ScanToDibEx, ScanToRawEx, or ScanToFile
event hander.

Target method
StartScan

Related Properties
N/A

Error Recovery
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

This method is not supported by Java.

231
1.2.5 ClearPage .... Document Ejection
Feature
Ejects the document.

Coding Style
[form.] scancontrolname. ClearPage(hWnd As Integer) [ =Integer ]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Ejects one page of the document loaded on the ADF. If there is already a page fed in the
image scanner device, the method ejects the page, and ejects another page from the
document loaded on the ADF.
The device memorizes the status of the page already fed even if the page is removed
manually. In such cases, the device will eject two pages from the ADF.

Target method
StartScan

Related Properties
ErrorCode

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

If RC_SEQUENCE_ERROR is returned, it indicates the method is being executed by
another form. The method can be retried after the execution. However, it is not
recommended to design an application which executes the CloseScanner method while
another form is executing the StartScan method. We strongly recommend that you issue
such methods from the same form.
The ClearPage method is invalid on devices which do not support the function. (Example
fi-65F)

232
Sample
Ejects the document loaded on the ADF.
[Visual Basic]
Private Sub Command6_Click()
' Document ejection process
PrivateAxFiScn1.ClearPage(Me.Handle.ToInt32)
Sub Command6_Click()
'Document
End Sub ejection process
FiScn1.ClearPage (Me.hWnd)
End Sub
[Java]
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Document ejection process
clearPage();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Fix error
unInitialize();
}

233
1.2.6 CloseScanner .... Closing the Scanner
Feature
Performs a termination process.

Coding Style
[form.] scancontrolname.CloseScanner(hWnd As Integer) [ = Integer]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Performs the termination process after scanning.

Target method
OpenScanner
OpenScanner2
StartScan

Related Properties
ErrorCode

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

If the OpenScanner method or OpenScanner2 method has been called, be sure to always
call this method when exiting the application or when otherwise required. (This method must
be paired with the OpenScanner method or OpenScanner 2 method.)
Also, if calling the StartScan method after this method was called, the OpenScanner method
or OpenScanner2 method should be called again.
If RC_SEQUENCE_ERROR is returned, it indicates the method is being executed by
another form. The method can be retried after the execution. However, it is not
recommended to design an application which executes the CloseScanner method while
another form is executing the StartScan method. We strongly recommend that you issue
such methods from the same form.

Sample
Refer to the sample for the StartScan method.

234
1.2.7 FeederLoaded
.... Notifying Whether or Not a Document Is Loaded on the ADF
Feature
Notifies whether or not the document is loaded on the ADF.

Coding Style
[form.] scancontrolname.FeederLoaded(hWnd As Integer) [ = Boolean]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
True Papers are loaded
False Papers are not loaded

Target method
N/A

Related Properties
ErrorCode

Error Recovery
Even if papers are loaded on the ADF, it does not mean that scanning is immediately
possible. Scanning may not be possible, for example, when the cover is open.
When "False" is returned, refer to the ErrorCode property since it may contain an error.

Compatibility and Restraints

Return value is False while other methods are being performed.

235
1.2.8 GetCapability .... Capability Acquisition
Feature
Acquires the capability

Coding Style
[form.] scancontrolname. GetCapability(nCap As Short, nMsg As Short, nItemType As Short,
ByRef lpItemValue As Integer) [ = Integer]

Parameters
nCap Capability type ex)ICAP_PIXELTYPE
nMsg Message type ex)MSG_GETCURRENT
nItemType Capability data type ex)TWTY_UINT16
lpItemValue The address where the capability value is stored.

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error

Explanation
Knowledge of the TWAIN convention is required for calling this method. Refer to
http://www.twain.org/ for the TWAIN protocol.
Acquires the capability directly of the TWAIN data source from an application.
Call this method when receiving the NegotiateCapabilities event.
The supported message type which can be specified by nMsg is limited to
MSG_GET/MSG_GETCURRENT/MSG_GETDEFAULT. Also, lpItemValue must be
specified.

Target method
StartScan

Related Properties
ErrorCode

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

Acquisition of TWAIN data is not available when using the Image Processing Software
Option.

236
1.2.9 GetSerialNumber .... Obtaining a scanner serial number
Feature
Obtains a scanner serial number.

Coding Style
[form.] scancontrolname. GetSerialNumber(hWnd As Integer) [ = BSTR]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
Character string: Other than "" Serial number
Character string: "" Failed to obtain a serial number

Explanation
Obtains a scanner serial number.

Target method
N/A

Related Properties
ErrorCode

Error Recovery
If a serial number cannot be obtained, refer to the ErrorCode property because errors may
be indicated.

Compatibility and Restraints

This method cannot be called while other methods are being performed. After other methods
that are being performed are finished, this method can be called.

237
1.2.10 GetSlpcTemplateCount .... Total Number of Templates Acquisition
Feature
Acquires the total number of templates of the "Image Processing Software Option."

Coding Style
[form.] scancontrolname. GetSIpcTemplateCount() [ = Integer]
Parameters
N/A

Return Values
0 – : The number of templates of the Image Processing Software Option
-1 : RC_FAILURE Acquisition failed
-2 : RC_SIPC_NOTINSTAL The Image Processing Software Option is not installed

Explanation
Acquires the total number of templates created (prepared in advance) by the "Image
Processing Software Option."

Target method
GetSIpcTemplateName
GetSIpcTemplateSelect
SetSIpcTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

238
Sample
Displays a dialog box with a list of templates of the Image Processing Software Option to
allow a template selection.
[Visual Basic]
Private Sub FormSoftIPC_Load(ByVal sender As System.Object, ByVal e As
System.EventArgs) Handles MyBase.Load
Dim count As Short
Dim Index As Short
Dim strName As String
' Notify the number of templates of SoftIPC
count = FormScan.CurrentInstance.AxFiScn1.GetSIpcTemplateCount
' Template list is not created when no template is present
If count < 1 Then
ButtonOK.Enabled = False
lstTemplate.Enabled = False
Exit Sub
End If

' Create a template list for SoftIPC

For Index = 0 To count - 1
strName =
FormScan.CurrentInstance.AxFiScn1.GetSIpcTemplateName(Index)
lstTemplate.Items.Add((strName))
Next Index
' Notify the index value of the template currently selected
Index = FormScan.CurrentInstance.AxFiScn1.GetSIpcTemplateSelect
' Make the currently selected template to the selected status
lstTemplate.SelectedIndex = Index

End Sub

Private Sub cmdOK_Click()

' Configure the template currently selected
FormScan.CurrentInstance.AxFiScn1.SetSIpcTemplateSelect(lstTemplate
.SelectedIndex)
Me.Close()
End Sub

[Java]
long lSIpcTemplateCount = 0;

try {
FiscnSampleApl obj = new FiscnSampleApl();
//Internal Initialization
initialize(obj);
// Acquires the number of templates of SoftIPC
lSIpcTemplateCount = getSIpcTemplateCount();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
//Internal End Process
unInitialize();
}

239
1.2.11 GetSlpcTemplateName .... Template Name Acquisition
Feature
Acquires a template name of the specified template number by the "Image Processing
Software Option."

Coding Style
[form.] scancontrolname. GetSIpcTemplateName(nTemplateIndex As Short) [ = BSTR ]

Parameters
nTemplateIndex Number of the template to be acquired (0 – )

Return Values
Character string: Template name, except ""
Character string: "" Acquisition failed

Explanation
Acquires the template name corresponding to the template number specified by the "Image
Processing Software Option."

Target method
GetSIpcTemplateCount
GetSIpcTemplateSelect
SetSIpcTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence .)

Compatibility and Restraints

N/A

Sample

[Visual Basic]
Refer to the sample for the GetSIpcTemplateCount method.

[Java]
String strSIpcTemplateName = "";
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Acquires the index value of the template name selected
long lIndex = 0;
strSIpcTemplateName = getSIpcTemplateName(iIndex);
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

240
1.2.12 GetSlpcTemplateSelect .... Selected Template Number Acquisition
Feature
Acquires the template number (0 – ) selected by the "Image Processing Software Option."

Coding Style
[form.] scancontrolname. GetSIpcTemplateSelect() [ = Integer]

Parameters
N/A

Return Values
0 – : Number of the selected template (0 – )
-1 : RC_FAILURE Acquisition failed
-2 : RC_SIPC_NOTINSTALL The Image Processing Software Option is not installed

Explanation
Acquires the template number (0 – ) currently selected by the "Image Processing Software
Option."

Target method
GetSIpcTemplateCount
GetSIpcTemplateName
SetSIpcTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

Sample
[Visual Basic]
Refer to the sample for the GetSIpcTemplateCount method.

[Java]
long lSIpcTemplateSelect ;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Acquires the template number (0 - ) selected.
lSIpcTemplateSelect = getSIpcTemplateSelect();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

241
1.2.13 GetSourceCount .... Getting the total number of data source
Feature
Gets the total number of data source.

Coding Style
[form.] scancontrolname. GetSourceCount() [ = Integer]

Parameters
N/A

Return Values
1 – : Total number of data source
-1 : RC_FAILURE Getting the value failed

Explanation
Gets the total number of data source.
Always call this method before calling the GetSourceSelect, GetSourceName, and
SelectSourceName methods.

Target method
GetSourceName
GetSourceSelect
SelectSourceName

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

242
Sample
Displays a dialog box with a list of data source names to allow data source to be select.

[Visual Basic]
Private Sub Form SourceList_Load (ByVal sender As System.Object, ByVal e
As System.EventArgs) Handles MyBase.Load
Dim count As Short
Dim Index As Short
Dim strName As String

' Open the scanner.

FormScan.CurrentInstance.AxFiScn1.OpenScanner2(Me.Handle.ToInt32)

' Get the total number of data source

count = FormScan.CurrentInstance.AxFiScn1.GetSourceCount
If count < 1 Then
ButtonOK.Enabled = False
lstSource.Enabled = False
Exit Sub
End If

' Create a Source list for data source

For Index = 0 To count - 1
strName= FormScan.CurrentInstance.AxFiScn1. GetSourceName
(Index)
lstSource.Items.Add((strName))
Next Index
' Notify the index value of the data source currently selected
Index = FormScan.CurrentInstance.AxFiScn1.GetSourceSelect
' Make the currently selected data source to the selected status
lstSource.SelectedIndex = Index
End Sub

Private Sub ButtonOK_Click (ByVal sender As System.Object, ByVal e As

System.EventArgs) Handles ButtonOK.Click
' Configure the data source currently selected
FormScan.CurrentInstance.AxFiScn1. SelectSourceName
(lstSource.Text)
Me.Close()
End Sub

[Java]
long lSourceCount = 0;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Get the total number of data source
lSourceCount = getSourceCount();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

243
1.2.14 GetSourceName .... Getting a data source name
Feature
Gets a data source name.

Coding Style
[form.] scancontrolname. GetSourceName(nSourceIndex As Short) [ = BSTR]

Parameters
nSourceIndex Index (0 –)

Return Values
Character string: Other than "" Data source name
Character string: "" Could not obtain

Explanation
This function gets the name of the data source that corresponds to the data source index.
Before calling this method, always call the GetSourceCount method first.

Target method
GetSourceCount
GetSourceSelect
SelectSourceName

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

244
Sample

[Visual Basic]
Refer to the sample for the GetSourceCount method.
[Java]
String strSourceName = “”;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Get the total number of data source
getSourceCount();
// Acquires the index value of the data source name selected
long lIndex = 0;
strSourceName = getSourceName(iIndex);
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

245
1.2.15 GetSourceSelect .... Getting the index of a selected data source
Feature
Gets the index of a selected data source.

Coding Style
[form.] scancontrolname. GetSourceSelect() [= Integer]

Parameters
None

Return Values
0 – : Index of a selected data source (0 –)
-1 : RC_FAILURE Getting the value failed

Explanation
This function gets the index of the data source currently selected.
Before calling this method, always call the GetSourceCount method first.

Target method
GetSourceCount
GetSourceName
SelectSourceName

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A.

246
Sample

[Visual Basic]
Refer to the sample for the GetSourceCount method.
[Java]
long lSourceSelect ;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Get the total number of data source
getSourceCount();
// Get the index value of the data source currently selected
lSourceSelect = getSourceSelect();
} catch (FiScnException e) {
// TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

247
1.2.16 GetTWAINTemplateCount .... Setting File / profile Total Number Acquisition
Feature
Acquires the total number of setting files / profiles in the TWAIN driver.

Coding Style
[form.] scancontrolname. GetTWAINTemplateCount() [ = Integer]
Parameters
N/A

Return Values
0 – : Number of setting files / profiles in the TWAIN driver
-1 : RC_FAILURE Acquisition failed
-2 : RC_TWAIN_NOTINSTAL The TWAIN driver is not installed

Explanation
Acquires the total number of setting files / profiles created (including those available by
default) in the TWAIN driver.

Target method
GetTWAINTemplateName
GetTWAINTemplateSelect
SetTWAINTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

248
Sample
Displays a dialog box containing a list of setting files / profiles stored in the TWAIN driver to
allow a setting file / profile selection.
[Visual Basic]
Private Sub FormTWAIN_Load (ByVal sender As System.Object, ByVal e As
System.EventArgs) Handles MyBase.Load
Dim count As Short
Dim Index As Short
Dim strName As String

'Opens the scanner.

FormScan.CurrentInstance.AxFiScn1.OpenScanner2(Me.Handle.ToInt32)

'Notify the number of templates of TWAIN

count = FormScan.CurrentInstance.AxFiScn1.GetTWAINTemplateCount
'Template list is not created when no template is present
If count < 1 Then
ButtonOK.Enabled = False
lstTemplate.Enabled = False
Exit Sub
End If

'Create a template list for TWAIN

For Index = 0 To count - 1
strName=
FormScan.CurrentInstance.AxFiScn1.GetTWAINTemplateName(Index)
lstTemplate.Items.Add((strName))
Next Index
'Notify the index value of the template currently selected
Index = FormScan.CurrentInstance.AxFiScn1.GetTWAINTemplateSelect
'Make the currently selected template to the selected status
lstTemplate.SelectedIndex = Index

End Sub

Private Sub ButtonOK_Click(ByVal sender As System.Object, ByVal e As

System.EventArgs) Handles ButtonOK.Click
'Configure SourceCurrentScan currently selected
FormScan.CurrentInstance.AxFiScn1.SourceCurrentScan=FormScan.Cur
rentInstance.MenuItemSourceCurrentScan.Checked
'Configure the template currently selected
FormScan.CurrentInstance.AxFiScn1.SetTWAINTemplateSelect(lstTempl
ate.SelectedIndex)

249
[Java]
long lTWAINTemplateCount = 0;

try {
FiscnSampleApl obj = new FiscnSampleApl();
//Internal Initialization
initialize(obj);
// Acquires the number of templates of TWAIN
lTWAINTemplateCount = getTWAINTemplateCount();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
//Internal End Process
unInitialize();
}

250
1.2.17 GetTWAINTemplateName .... Setting File / profile Name Acquisition
Feature
Acquires the setting file / profile name corresponding to the setting file / profile number
specified in the TWAIN driver.

Coding Style
[form.] scancontrolname. GetTWAINTemplateName(nTemplateIndex As Short) [ = BSTR]

Parameters
nTemplateIndex Number of the template to be acquired (0 – )

Return Values
Character string: Name of setting files / profiles, except ""
Character string: "" Acquisition failed

Explanation
Acquires the setting file / profile name corresponding to the setting file / profile number
specified in the TWAIN driver.

Target method
GetTWAINTemplateCount
GetTWAINTemplateSelect
SetTWAINTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

Sample

[Visual Basic]
Refer to the sample for the GetTWAINTemplateCount method.

[Java]
String strTWAINTemplateName = "";
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
//Acquires the index value of the template name selected
long lIndex = 0;
strTWAINTemplateName = getTWAINTemplateName(ｌIndex);
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

251
1.2.18 GetTWAINTemplateSelect
.... Selected Setting File / profile Number Acquisition
Feature
Acquires the number (0 – ) of a selected setting file / profile in the TWAIN driver."

Coding Style
[form.] scancontrolname. GetTWAINTemplateSelect() [ = Integer]

Parameters
N/A

Return Values
0 – : Number of the selected template / profile (0 – )
-1 : RC_FAILURE Acquisition failed
-2 : RC_TWAIN_NOTINSTALL The TWAIN driver is not installed

Explanation
Acquires the number (0 – ) of a selected setting file / profile in the TWAIN driver.

Target method
GetTWAINTemplateCount
GetTWAINTemplateName
SetTWAINTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence .)

Compatibility and Restraints

N/A

Sample

[Visual Basic]
Refer to the sample for the GetTWAINTemplateCount method.

[Java]
long lTWAINTemplateSelect ;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Acquires the template number (0 - ) selected.
lTWAINTemplateSelect = getTWAINTemplateSelect();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

252
1.2.19 OpenScanner .... Opening the Scanner
Feature
Performs the initialization process before scanning.

Coding Style
[form.] scancontrolname.OpenScanner(hWnd As Integer) [ = Integer]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
0 : RC_SUCCESS Normal end
2 : RC_NOT_DS_FJTWAIN Not " TWAIN driver"
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Acquires scanner information and performs the associated initialization process.
Applications must call this method or the OpenScanner2 method before calling the StartScan
method.

Target method
CloseScanner
StartScan

Related Properties
ErrorCode
IsExistsFB ... Set by this method
ImageScanner... Set by this method
TwainDS... Referred to by this method

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

Set so that applications call this method or the OpenScanner2 method before calling the
StartScan method (such as during application startup).
If the StartScan method is called without calling this method or the OpenScanner2 method,
the properties may not be applied properly to the source, a file may not be created properly,
or other problems may occur.
If this method or OpenScanner2 method has been called, be sure to always call the
CloseScanner method when exiting the application or when otherwise required. (The
CloseScanner method must be paired with this method or the OpenScanner2 method.)
Also, if calling the StartScan method after the CloseScanner method was called, set so that
this method or the OpenScanner2 method is called again.
If RC_SEQUENCE_ERROR is returned, it indicates the method is being executed by
another form. The method can be retried after the execution. However, it is not
recommended to design an application which executes the CloseScanner method while
another form is executing the StartScan method. We strongly recommend that you issue
such methods from the same form.
Prevent two or more control instances from being generated. If two or more instances issue
methods, operations are not guaranteed.

253
Sample
Refer to the sample for the StartScan method.

254
1.2.20 OpenScanner2 .... Open scanner (part 2)
Feature
Performs initialization process before scanning and assumes control of the scanner.

Coding Style
[form.] scancontrolname.OpenScanner2(hWnd As Integer) [ = Integer]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Value
0 : RC_SUCCESS Normal end
2 : RC_NOT_DS_FJTWAIN Not " TWAIN driver"
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during method execution)

Explanation
Acquires scanner information and performs the associated initialization process.
Applications must call this method or the OpenScanner method.
After calling of this method, the scanner driver continues to be open until the CloseScanner
method is called, and this method assumes control of the scanner. As a result, compared to
the case when the OpenScanner method is called, the processing speed by the following
methods is faster.
・ FeederLoaded
・ GetTWAINTemplateCount
・ GetTWAINTemplateName
・ GetTWAINTemplateSelect
・ ScannerAvailable
・ SetTWAINTemplateSelect
・ SetupDataSourceProperties
・ StartScan
Although the scanning start speed is faster when using this method, because the scanner is
controlled by this method, the scanner cannot be used by other applications.

Target method
StartScan
CloseScanner

Related Properties
ErrorCode
IsExistsFB … Set by this method
ImageScanner… Set by this method
TwainDS... Referred to by this method

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, "3.1 Error Codes and Error Recovery Procedures".

Compatibility and Restrictions

- Set so that applications call this method or the OpenScanner method before calling the
StartScan method (such as during application startup).
- If the StartScan method is called without calling this method or the OpenScanner method,
the properties may not be applied properly to the source, a file may not be created properly,
or other problems may occur.

255
- If this method or the OpenScanner method has been called, be sure to always call the
CloseScanner method when exiting the application or when otherwise required. (This
method or the OpenScanner method must be paired with the CloseScanner method.)
- If an RC_SEQUENCE_ERROR is reported, this indicates that the method is being
executed in another form, and a retry is possible once the currently-running method has
been completed. However, we cannot recommend application designs where the
CloseScanner method is executed from another form during execution of the StartScan
method from a given form. Issuing from the same form is strongly recommended.
- Prevent two or more control instances from being generated. If two or more instances issue
methods, operations are not guaranteed.
- When you call the OpenScanner2 method, and then start up a process other than the
scanning process to run alongside the OpenScanner2 method, if a read error (such as a
multifeed or out of paper error) occurs in the StartScan method, you may receive a double
open error notification (EC_ERROR_MAX_CONNECTIONS) from the TWAIN driver. In this
case, you may be able to avoid the double open error notification by starting a process other
than the scanning process before calling the OpenScanner2 method.

Example)
<Read sequence (Before)>
1. Calling the OpenScanner2 method
2. Starting up a process other than the scanning process
3. Calling the StartScan method (*A double open error is notified)
4. Calling the CloseScanner method

<Read sequence (After)>

1. Starting up a process other than the scanning process
2. Calling the OpenScanner2 method
3. Calling the StartScan method
4. Calling the CloseScanner method

Sample
For details on how to use this method, refer to the OpenScanner method.

256
1.2.21 ScannerAvailable .... Image Scanner Availability
Feature
Checks if the device (scanner) is in the ready status.

Coding Style
[form.] scancontrolname.ScannerAvailable(hWnd As Integer) [ = Boolean]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
True Available
False Unavailable or error

Target method
N/A

Related Properties
ErrorCode

Error Recovery
Available status indicates that the device is online. However, this status does not always
mean that scanning is immediately possible. Scanning may not be possible, for example,
when the cover is open.
When "False" is returned, refer to the ErrorCode property since it may contain an error.

Compatibility and Restraints

"False" is returned when the method is being executed.

257
Sample
Displays whether the device (scanner) is in the ready status.
[Visual Basic]
Private Sub Command7_Click()
Dim status As Boolean
' Whether the image scanner is available
status = AxFiScn1.ScannerAvailable(Me.Handle.ToInt32)
If status = FALSE Then
MsgBox ("Device unavailable or error ")
Else
MsgBox ("Device ready ")
End If
End Sub

[Java]
try {
FiscnSampleApl obj = new FiscnSampleApl();
//Internal Initialization
initialize(obj);
// Whether the image scanner is available
scannerAvailable ();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

258
1.2.22 SelectSource .... Data source Selection
Feature
Performs the selection process of the data source.
Note: Specify the driver (data source) of the device.

Coding Style
[form.] scancontrolname.SelectSource(hWnd As Integer) [ = Integer]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
0 : RC_SUCCESS Normal end
1 : RC_CANCEL Canceled by the user
-1: RC_FAILURE Error
-3: RC_SEQUENCE_ERROR Sequence error (method in execution)

Explanation
This is used to select the data source.
Set so that the OpenScanner method or OpenScanner2 method is called after calling this
method.

Target method
N/A

Related Properties
ErrorCode

Error Recovery
When no data source is present in the system, the Cancel button only is enabled in the
selection dialog box.
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

N/A

259
Sample
Displays the "Select Source" (scanner selection) screen.
[Visual Basic]
Private Sub Command3_Click()
' Performing the data source selection process.
AxFiScn1.SelectSource(Me.Handle.ToInt32)
' Open the scanner.
AxFiScn1.OpenScanner(Me.Handle.ToInt32)
End Sub

[Java]
long lSelectSource = 0;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Performing the data source selection process.
lSelectSource = selectSource();
// Open the scanner.
openScanner();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

260
1.2.23 SelectSourceName .... data source selection
Feature
Select a data source.

Coding Style
[form.] scancontrolname. SelectSourceName(SourceName As String) [ = Integer]

Parameters
SourceName Data source name used

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error

Explanation
Select a data source that is used for scanning.
After calling this method, always call the OpenScanner method and OpenScanner2 method.

Target method
GetSourceCount
GetSourceName
GetSourceSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A.

261
Sample
The data source is selected by the name.
[Visual Basic]
Refer to the sample for the GetSourceCount method.
[Java]
String sourceName = “PaperStream IP fi-7180”;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Select a data source
selectSourceName(sourceName);
openScanner();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

262
1.2.24 SetCapability .... Capability Configuration
Feature
Configures the capability.

Coding Style
[form.] scancontrolname. SetCapability(nCap As Short, nItemType As Short, lItemValue As
Integer) [ = Integer]

Parameters
nCap Capability type ex)ICAP_PIXELTYPE
nItemType Capability data type ex)TWTY_UINT16
lItemValue Capability value ex)TWPT_BW

Return Values
0 :RC_SUCCESS Normal end
-1:RC_FAILURE Error

Explanation
Knowledge of the TWAIN convention is required for calling this method. Refer to
http://www.twain.org/ for the TWAIN protocol.
Configures the capability directly on the TWAIN data source from an application.
Call this method when receiving the NegotiateCapabilities event.

Target method
StartScan

Related Properties
ErrorCode

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

Configuration of TWAIN data is not available when using the Image Processing Software
Option.

263
1.2.25 SetSlpcTemplateSelect .... Template Number Specification
Feature
Configures the template number to be selected (enabled) in the "Image Processing Software
Option."

Coding Style
[form.] scancontrolname. SetSIpcTemplateSelect( nTemplateIndex As Short) [ = Integer]

Parameters
nTemplateIndex Number of the template to be selected (0 – )

Return Values
0 – : Selected template number (0 – )
-1 : RC_FAILURE Configuration failed
-2 : RC_SIPC_NOTINSTALL The Image Processing Software Option is not installed

Explanation
Configures the template number (0 – ) which is used by the "Image Processing Software
Option" for selection.

Target method
GetSIpcTemplateCount
GetSIpcTemplateName
GetSIpcTemplateSelect

Related Properties
N/A

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

N/A

Sample
[Visual Basic]
Refer to the sample for the GetSIpcTemplateCount method.

[Java]
long lSelectSource = 0;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Configures the template number
setSIpcTemplateSelect(lSelectSource);
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

264
1.2.26 SetTWAINTemplateSelect .... Configuring Setting File / profile Numbers
Feature
Configures numbers for setting files / profiles stored in the TWAIN driver."

Coding Style
[form.] scancontrolname. SetTWAINTemplateSelect( nTemplateIndex As Short) [ = Integer]

Parameters
nTemplateIndex Number of the template to be selected (0 – )

Return Values
0 – : Number of selected setting files / profiles (0 – )
-1 : RC_FAILURE Configuration failed
-2 : RC_TWAIN_NOTINSTALL The TWAIN driver is not installed

Explanation
Configures numbers (0 – ) for setting files / profiles stored in the TWAIN driver.

Target method
GetTWAINTemplateCount
GetTWAINTemplateName
GetTWAINTemplateSelect

Related Properties
SourceCurrentScan

Error Recovery
N/A (No value can be obtained from the ErrorCode property at the time of error occurrence.)

Compatibility and Restraints

To use this method, set the SourceCurrentScan property to "True." When the property is set
to "False", setting file / profile numbers are set to 0 by this method.

Sample

[Visual Basic]
Refer to the sample for the GetTWAINTemplateCount method.

[Java]
long lTemplateSelect = 0;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Configures the template number
setTWAINTemplateSelect(lTemplateSelect);
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

265
1.2.27 SetupDataSourceProperties .... Settable UI Display
Feature
Displays source configuration dialog box.

Coding Style
[form.] scancontrolname.SetupDataSourceProperties(hWnd As Integer) [ = Integer]

Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Displays the user interface (the same as TWAIN driver) for the source which allows
configuration of values only. (Read startup cannot be initiated from this user interface.)

Example of the FUJITSU TWAIN32 driver user interface display

266
 Example of the PaperStream IP(TWAIN) driver user interface display

If the compression specification is invalid due to the ScanTo property and the FileType
property, "0 - No Compress" is set to the CompressionType property.

Reference
This method enables the parameter configuration on the user interface when a user system
does not provide its own parameter configuration screen.
If calling the StartScan method after calling this method, always set "True" to the
SourceCurrentScan property prior to calling the StartScan method. Otherwise, functions
configured by this method are replaced by values of properties configured on this Control
before scanning.

Target method
StartScan

Related Properties
ScanTo (Reference only)
FileType (Reference only)
CompressionType (Reference, update as necessary)
PixelType (Update as necessary)
Note (Configure before calling the StartScan method after calling this method)
SourceCurrentScan
ShowSourceUI

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

Compatibility and Restraints

If RC_SEQUENCE_ERROR is returned, it indicates the method is being executed by
another form. The method can be retried after the execution. However, it is not
recommended to design an application which executes the CloseScanner method while

267
another form is executing the StartScan method. We strongly recommend that you issue
such methods from the same form.

Sample
Displays the user interface (the same as TWAIN driver) for the source which allows
configuration only.

[Visual Basic]
Private Sub Command8_Click()
' Display a user interface which allows configuration only
AxFiScn1.SetupDataSourceProperties (Me.Handle.ToInt32)
End Sub

[Java]
long lSelectSource = 0;
try {
FiscnSampleApl obj = new FiscnSampleApl();
// Internal Initialization
initialize(obj);
// Display a user interface which allows configuration only
setupDataSourceProperties ();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
// Internal End Process
unInitialize();
}

268
1.2.28 StartScan .... Starting an Image Scanning
Feature
Starts scanning an image.

Coding Style
[form.] scancontrolname.StartScan(hWnd As Integer) [ = Integer]
Parameters
hWnd Handle of the window where this Control (RICOH Scanner Control) is located.

Return Values
0 : RC_SUCCESS Normal end
1 : RC_CANCEL Canceled by the user, or an error which causes the
device to be unable to continue scanning (insufficient
disk space, image transfer error, etc.)
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Starts scanning an image according to the specified properties.
Always call the OpenScanner method or OpenScanner2 method before calling this method.

Target method
CloseScanner
OpenScanner
OpenScanner2

Related Properties
All properties except IsExistFB and ImageScanner.
Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").
For how to handle errors, refer to "3.1 Error code and how to fix error."

This method reports the return value "0" (Normal end) if the Close button is clicked instead of
the Scan button on the user interface (UI) of the source. Therefore, check the PageCount
property together with this return value to determine if the actual scan has been performed.

An error occurs (EC_ERROR_FEEDPAGE) if there is no document in the ADF when

StartScan runs. If there is no document in the ADF after one or more documents are
scanned, it ends normally.

Compatibility and Restraints

Always call this method between the OpenScanner or Openscanner2 method and the
CloseScanner method.
If this method is called in any other manner, the property values may not be applied properly,
or a file may not be created properly.
Example) Calling the StartScan method
OpenScanner // (At the startup of an application, etc.)

StartScan

CloseScanner

OpenScanner // After CloseScanner is executed, be sure to call up OpenScanner or
// OpenScanner2 for another scan.

269
 
StartScan

CloseScanner

OpenScanner // (At the startup of an application, etc.)


StartScan

StartScan // When scanning again.

CloseScanner

X Incorrect calling method

OpenScanner // (When an application window is generated, etc.)

StartScan

CloseScanner

StartScan
X The StartScan method is called after the CloseScanner method without calling the
OpenScanner or Openscanner2 method.

If RC_SEQUENCE_ERROR is returned, it indicates the method is being executed by another

form. The method can be retried after the execution. However, it is not recommended to
design an application which executes the CloseScanner method while another form is
executing the StartScan method. We strongly recommend that you issue such methods from
the same form.
After changing the feeding method from ADF to flatbed, it takes some time for scanning to
start when this method is executed.

270
Sample
The following code indicates from opening of the scanner, starting of scanning, to closing of
the scanner.
[Visual Basic]
Private Sub Command1_Click()
Dim status As Integer

' Specify whether to display the source user interface (UI)

AxFiScn1.ShowSourceUI = False ' Not to display
' Specify the file format
AxFiScn1.FileType = 0 'bitmap file
' Specify the file name to save the image
AxFiScn1.filename = "c:\img\img#####"
' Specify the start number of the sequence number attached to the file
AxFiScn1.FileCounterEx = 1 ' Start number 1
' Specify whether to overwrite the file.
AxFiScn1.Overwrite = 1 ' Overwrite
' Specify the paper feed method.
AxFiScn1.PaperSupply = 1 'ADF
' Specify the document size.
AxFiScn1.PaperSize = 1 ' A4 size
' Specify the pixel type.
AxFiScn1.PixelType = 1 ' Grayscale
' Specify the resolution for scanning.
AxFiScn1.Resolution = 0 '200dpi
' Open the scanner.
status = AxFiScn1.OpenScanner(Me.Handle.ToInt32)
' Scanner open error
If status = -1 Then
Exit Sub
End If

' Start scanning an image.

status = AxFiScn1.StartScan(Me.Handle.ToInt32)
' Scan successful
If status = 0 Then
' Display the scanned image on the image control.
Image1.Picture = LoadPicture("c:\img\img00001.bmp")
Image1.Refresh
End If

' Close the scanner.

AxFiScn1.CloseScanner (Me.Handle.ToInt32)

End Sub

271
[Java]
public void Scan() {
long lStatus = 0;
try {
FiscnSampleApl obj = new FiscnSampleApl();
//Internal Initialization
initialize(obj);
// Specify whether to display the source user interface (UI)
setShowSourceUI(false); // Not to display
//Specify the file format
setFileType(0); //bitmap file
//pecify the file name to save the image
setFileName = "c:\img\img#####"
// Specify the start number of the sequence number attached to the file
setFileCounterEx(1); // Start number 1
// Specify whether to overwrite the file
setOverwrite(1); // Overwrite
// Specify the paper feed method.
setPaperSupply(1); //ADF
// Specify the document size.
setPaperSize(1); //A4 size
// Specify the pixel type.
setPixelType(1); // Grayscale
// Specify the resolution for scanning.
setResolution(0); //200dpi
// Open the scanner.
openScanner();
// Start scanning an image.
lStatus = startScan()；
// Scan successful
if (lStatus == 0){
// TODO: Execute a normal end process.
}
// Close the scanner.
closeScanner();
} catch (FiScnException e) {
//TODO: Fix error
} finally {
//Internal End Process
unInitialize();
}

272
1.3 Events

1.3.1 List of Events

The following describes events supported by RICOH Scanner Control SDK.
PaperStream IP(TWAIN) driver : PSIP
FUJITSU TWAIN32 driver : TWAIN

Event Name Description PSIP TWAIN

AutoProfileSelection Information about an applied profile and registered form is ○ N/A

issued.
DetectBarcode Issued when a barcode is detected. ○ N/A
DetectBarcodeDetail Issued when a barcode detail is detected. ○ N/A
DetectJobSeparator Issued when a special document (document with a specific ○ ○
shape) or patch code document is detected.
DetectPatchCode Issued when a patch code is detected. ○ N/A
MultiStreamPropertySetting Issues an event that sets properties for each image. ○ N/A
NegotiateCapabilities Configures the TWAIN capability which cannot be ○ ○
configured by this Control.
PagePartition Issued at a page break. ○ ○
ScanToDib Issued by the scanning process (the StartScan method) for ○ ○
each scanned page when the ScanTo property is set to "1 -
Dib Handle"
This event is not supported by Java.
This is a compatible event.
Use the ScanToDibEx event.
ScanToDibEx Issued by the scanning process (the StartScan method) for ○ ○
each scanned page when the ScanTo property is set to "1 -
Dib Handle"
This event is not supported by Java.
ScanToFile Issued by the scanning process (the StartScan method) for ○ ○
each scanned page when the ScanTo property is set to "0 -
File"
This event is not supported by Java.
ScanToRaw Issued by the scanning process (the StartScan method) for ○ ○
each scanned page when the ScanTo property is set to "2 -
Raw Image Handle"
This event is not supported by Java.
This is a compatible event.
Use the ScanToRawEx event.
ScanToRawEx Issued by the scanning process (the StartScan method) for ○ ○
each scanned page when the ScanTo property is set to "2 -
Raw Image Handle"
This event is not supported by Java.

273
1.3.2 Notes on a Process Written in an Event Handler
While an application is performing a process written in an event handler, SDK waits for
the process to end, suspending its own process as a result.
Therefore, if it takes a while to perform a process written in the handler, the scanning
process is suspended until the process written in the handler which is performed ends.
This may take long time to scan documents as a result.
Make sure that a process written in the handler ends as quick as possible.

1.3.3 Examples and Notation Conventions in This Chapter

Feature
Describes the outline of the event.

Coding Style
Describes the syntax of the event when coding a program.
Describes codes in accordance with the conventions of Visual Basic .
Example) scancontrolname_ScanToDibEx( ByVal hDib As Stdole.OLE_HANDLE )

Parameters
Describes arguments for the event.

Explanation
Describes the use and function of the property. In addition, notes and restraints regarding
correlated properties are also described if necessary.

Target method
Describes a list of methods whose property status is altered by processing this event.

Related Properties
Describes all properties which mutually influence each other.

Sample
Describes simple program samples where necessary.

274
1.3.4 AutoProfileSelection .... Notification of the identified forms
Feature
Information about an applied profile and registered form is issued.

Coding Style
scancontrolname_AutoProfileSelection( ByVal DistResult As Integer,
ByVal FormName As String,
ByVal ProfileName As String)

Parameters
DistResult Result of an identification
FormName Name of a registered form
ProfileName Name of an applied profile

Explanation
When "1 - Enabled" has been set for the AutoProfile property and after the
ScanToFile/ScanToDibEx/ScanToRawEx event is issued, this event is issued.
Values for DistResult
-1 An error occurred while identifying a form
0 A registered form was detected (accuracy level: high)
1 No registered form was detected
2 A registered form was detected (accuracy level: low)

Target method
StartScan

Related Properties
AutoProfile
AutoProfileSensitivity

Compatibility and Restrictions

This event is issued even if a registered form is not detected.
In this case, the following is issued for FormName and ProfileName.
FormName Issues an empty string
ProfileName Issues an empty string
For details about forms and profiles, refer to the Help of the PaperStream IP (TWAIN) driver.

Sample

[Java]
public void eventAutoProfileSelection (long distResult, String formName,
String profileName) {
System.out.println("Registered form name：" + formName);
System.out.println("Profile name：" + profileName);
}

275
1.3.5 DetectBarcode .... Barcode detection notification
Feature
Issued when a barcode is detected.

Coding Style
scancontrolname_DetectBarcode( ByVal ReadCount As Integer,
ByVal BarcodeType As Integer,
ByVal BarcodeText As String)

Parameters
ReadCount Number of scanned images
BarcodeType Barcode type
BarcodeText Barcode identification text

Explanation
This event is issued after the ScanToFile/ScanToDibEx/ScanToRawEx event is issued.

Target method
StartScan

Related Properties
BarcodeDetection
BarcodeNotDetectionNotice
BarcodeType

Compatibility and Restrictions

If "True" is set for the BarcodeDetection property, this is issued when a barcode is detected.
However, when "True" is set for the BarcodeNotDetectionNotice property, this notification is
issued even if a barcode is not detected.
In this case, the following values are issued for the parameters:
ReadCount The number of scanned images is issued (the same as when a barcode
is detected)
BarcodeType 0 is issued
BarcodeText An empty string is issued
The BarcodeDetection property is disabled if it is not supported on the specific device.
If more than one barcode exists in the barcode recognition area, the order in which barcodes
are detected is undetermined.
(* Refer to "Reference Manual (Separate Volume).")
*For details on barcodes, refer to the User's Guide for your device.

Sample
[Java]
public void eventDetectBarcode(long readeCount, long barcdeType, String
barcodeText) {
System.out.println("Barcode was detected.");
}

276
1.3.6 DetectBarcodeDetail .... Barcode detail detection notification
Feature
When a barcode is detected, the barcode detail is issued.

Coding Style
scancontrolname_DetectBarcodeDetail( ByVal ReadCount As Integer,
ByVal BarcodeCount As Integer,
ByVal BarcodeTotalCount As Integer,
ByVal BarcodeType As Integer,
ByVal BarcodeTextLength As Integer,
ByVal BarcodeText As String,
ByVal BarcodeX As Integer,
ByVal BarcodeY As Integer,
ByVal BarcodeRotation As Integer,
ByVal BarcodeConfidence As Integer)

Parameters
ReadCount Number of scanned images
BarcodeCount Number of barcodes counted in the scanned image
BarcodeTotalCount Total number of barcodes detected in the scanned image
BarcodeType Barcode type
BarcodeTextLength Barcode text length
BarcodeText Barcode identification text
BarcodeX The X coordinate (pixel) of the barcode detection area
BarcodeY The Y coordinate (pixel) of the barcode detection area
BarcodeRotation The degrees to rotate the barcode
BarcodeConfidence (To be implemented in the future)

Explanation
When a barcode is detected, the barcode detail is issued.
The values obtained from BarcodeRotation are "0 - No rotation", "1 - Rotate 90 degrees to
the right", "2 - Rotate 180 degrees to the right", "3 - Rotate 270 degrees to the right", and "4 -
Rotation degrees unknown, or Two-dimensional code".
This event is Issued after the ScanToFile/ScanToDibEx/ScanToRawEx event is issued.

Target method
StartScan

Related Properties
BarcodeDetection
BarcodeNotDetectionNotice
BarcodeType

Compatibility and Restrictions

If "True" is set for the BarcodeDetection property, this is issued when a barcode is detected.
However, when "True" is set for the BarcodeNotDetectionNotice property, this notification is
issued even if a barcode is not detected.
In this case, the following values are issued for the parameters:
ReadCount The number of scanned images is issued (the same as when a
barcode is detected)
BarcodeCount 0 is issued
BarocdeRotation 0 is issued
BarcodeTotalCount 0 is issued
BarcodeText An empty string is issued
BarcodeTextLength 0 is issued
BarcodeType 0 is issued

277
 BarcodeX 0 is issued
BarocdeY 0 is issued
The BarcodeDetection property is disabled if it is not supported on the specific device.
If more than one barcode exists in the barcode recognition area, the order in which barcodes
are detected is undetermined.
Parameter BarcodeConfidence is to be implemented in the future. The value obtained from
BarcodeConfidence is indefinite. Do not use the value.
(* Refer to "Reference Manual (Separate Volume).")
*For details on barcodes, refer to the User's Guide for your device.

Sample
[Java]
public void event DetectBarcodeDetail(long readCount, long
barcodeCount ,long barcodeTotalCount, barcodeType, long
barcodeTextLength, String barcodeText, long barcodeX, long barcodeY, long
barcodeRotation, long barcodeConfidence) {
System.out.println("Barcode detail was detected.");
}

278
1.3.7 DetectJobSeparator
.... Special Document / Patch Code Document Detection Notification
Feature
Issued when a special document (document with a specific shape) or patch code document
is detected.

Coding Style
scancontrolname_DetectJobSeparator( )

Parameters
N/A

Explanation
When "0 - Special Document" is set for JobControlMode property, this event is Issued before
the ScanToFile/ScanToDibEx/ScanToRawEx event is issued.
When "1 - Patch Code Document" is set for JobControlMode property, this event is Issued
after the ScanToFile/ScanToDibEx/ScanToRawEx event is issued.
If you have set the JobControl property to "2 - Include and Stop", the JobControlMode
property to "1 - Patch Code Document", or the JobControl property to "4 - Exclude and Stop",
and if you have specified True for the ScanContinue property and a special document or
patch code document is detected, this event is notified after confirmation of continuous read.

Target method
StartScan

Related Properties
JobControl
JobControlMode

Compatibility and Restraints

This event is issued when a special document or patch code document is detected while the
JobControl property is set to a value other than "0 - None", or job control is set by the driver
user interface.
The JobControl property is invalid on devices which do not support the property.
(* Refer to "Reference Manual (Separate Volume).")
* For the details of special documents (documents in a particular shape), refer to the User's
Guide for your device.

Sample
[Java]
public void eventDetectJobSeparator() {
System.out.println("File transfer was detected.");
}

279
1.3.8 DetectPatchCode .... Patch code detection notification
Feature
Issued when a patch code is detected.

Coding Style
scancontrolname_DetectPatchCode( ByVal ReadCount As Integer,
ByVal PatchCodeType As Integer)

Parameters
ReadCount Scanning image count
PatchCodeType Patch code type

Explanation
This event is issued after the ScanToFile/ScanToDibEx/ScanToRawEx event is issued.

Target method
StartScan

Related Properties
PatchCodeDetection

Compatibility and Restrictions

If "True" is set for the PatchCodeDetection property, this is issued when a patch code is
detected.
The PatchCodeDetection property is disabled if it is not supported on the specific device.
(* Refer to "Reference Manual (Separate Volume)."))
*For details on patch codes, refer to the User's Guide for your device.

Sample

[Java]
public void eventDetectPatchCode(long readCount, long patchCcdeType) {
System.out.println("Patch code was detected.");
}

280
1.3.9 MultiStreamPropertySetting .... Setting Properties for Each Image
Feature
Issues an event that sets properties for each image.

Coding Style
scancontrolname_ MultiStreamPropertySetting (ByVal StreamCount As Integer,
ByVal PixelType As Integer,
ByVal PageSide As Integer)

Parameters
StreamCount Output order of images
PixelType (To be implemented in the future)
PageSide (To be implemented in the future)

Explanation
This event is issued when the MultiStreamMode property is set to a value other than "0 -
OFF". Obtain this event to set properties for each image.
When "1 - 2 MultiImage" is specified for the MultiStreamMode property, this event is issued
twice. When "2 – 3 MultiImage" is specified, this event is issued three times.
To set properties for the 1st image, those properties must be used when the first parameter
(StreamCount) in this event is "1".
To set properties for the 2nd image, those properties must be used when the first parameter
(StreamCount) in this event is "2".
To set properties for the 3rd image, those properties must be used when the first parameter
(StreamCount) in this event is "3".

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB
AdjustRGBG
AdjustRGBR
ADTCThreshold
AutoBright
Background
BackgroundSmoothing
BackgroundSmoothness
BackgroundThreshold
Brightness
CharacterExtraction
CharacterExtractionMethod
CharacterThickness
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow
CompressionType
Contrast
CustomGamma
CustomResolution
DTCSensitivity
FadingCompensation

281
FileType “0 – BMP”, “1 - TIFF”, “3 - JPEG”, “4 - PDF”
Filter
FilterSaturationSensitivity
Gamma
GammaFile
Halftone
HalftoneFile
Highlight
MultiStreamMode “1 - 2 MultiImage”, “2 - 3 MultiImage”
PixelType “0 - Black & White”, “1 - Grayscale”, “2 - RGB”
Resolution
Reverse
ScanCount
ScanTo “0 - File”
SDTCSensitivity
SEE
Shadow
Sharpness
SimpleSlicePatternRemoval
sRGB
Threshold

Compatibility and Restraints

- The PixelType parameter and the PageSide parameter are to be implemented in the future.
The value obtained is indefinite.
- This property does not support Java.

282
 Sample
[Visual Basic]
Private Sub Command1_Click()
'Set a file name for saving an image.
AxFiScn1.filename = "c:\img\img#####"
'Set an output method for a scanned image.
AxFiScn1.ScanTo = 0 'Out put as a file
'Set a paper feeding method.
AxFiScn1.PaperSupply = 1 'ADF
'Out put multiple images.
AxFiScn1.MultiStreamMode = 1 'Multi image output (two images)
'Open the scanner.
AxFiScn1.OpenScanner(Me.Handle.ToInt32)
'Start scanning documents.
AxFiScn1.StartScan(Me.Handle.ToInt32)
'Close the scanner.
AxFiScn1.CloseScanner (Me.Handle.ToInt32)
End Sub

Private Sub axFiScn1_MultiStreamPropertySetting(sender As Object, e As

AxFiScnLib._DFiScnEvents_MultiStreamPropertySettingEvent) Handles
AxFiScn1.MultiStreamPropertySetting
If e.streamCount = 1 Then
AxFiScn1.PixelType = 0 'Pixel type for the 1st image: Binary (Black and
White)
AxFiScn1.FileType = 1 'File type for the 1st image: TIFF file
AxFiScn1.Threshold = -2 'Threshold for the 1st image: Dynamic Threshold
(iDTC) binary character mode
AxFiScn1.PatternRemoval = 1 'Dynamic Threshold (iDTC) binary pattern
removal for the 1st image: Remove (default)
ElseIf e.streamCount = 2 Then
AxFiScn1.PixelType = 2 'Pixel type for the 2nd image: RGB color
AxFiScn1.FileType = 3 'File type for the 1st image: JPEG file
AxFiScn1.Brightness = 100 'Brightness for the 2nd image
AxFiScn1.Contrast = 120 'Contrast for the 2nd image
End If
End Sub

For details, refer to the sample source code.

For the Visual C++ sample source code, the MultiStreamMode property and the
MultiStreamPropertySetting event are not implemented. Refer to the sample source codes for Visual
Basic and Visual C#.

283
1.3.10 NegotiateCapabilities .... Capability Configuration Notification
Feature
Configures the TWAIN capability which cannot be configured by this Control.
Issued after the TWAIN capability configuration by this Control.

Coding Style
scancontrolname_ NegotiateCapabilities ( )

Parameters
N/A

Target method
StartScan
SetCapability
GetCapability

Related Properties
N/A

Compatibility and Restraints

Configure capabilities which can be configured by this Control with properties of this Control.

Sample
[Java]
public void eventNegotiateCapabilities() {
System.out.println("Configures the TWAIN capability .");
}

284
1.3.11 PagePartition .... Page break notification
Feature
Issued at a page break.

Coding Style
scancontrolname_PagePartition( )

Parameters
N/A

Explanation
This event is issued after the ScanToFile/ScanToDibEx/ScanToRawEx/DetectBarcode/
DetectBarcodeDetail/DetectJobSeparator/DetectPatchCode/AutoProfileSelection event is
issued.
This event will be issued at the end of the events notified for each page.

Example)
Events will be notified as follows when Paper A with two barcodes and Paper B with a patch
code are scanned.
ScanToFile An event related to Paper A
DetectBarcode An event related to Paper A
DetectBarcodeDetail An event related to Paper A
PagePartition An event related to Paper A
ScanToFile An event related to Paper B
DetectPatchCode An event related to Paper B
PagePartition An event related to Paper B

Note: If "True" is set for the ScanContinue property, this event will be issued after a user
makes a response in the confirmation window.

Target method
StartScan

Related Properties
N/A

Compatibility and Restraints

If the image data is not saved , this event will not occur.
This event will not be issued after the DetectJobSeparator event when the JobControl
property is specified with "3 - Exclude and Continue" or "4 - Exclude and Stop" and the last
page is a special document (document with a specific shape)/patch code document.

Sample

[Java]
public void eventPagePartition() {
System.out.println("A page break was detected.");
}

285
1.3.12 ScanToDib .... DIB Handle Consignment
Feature
This event is issued for each page during the scanning process (the StartScan method)
when the ScanTo property is set to "1 - Dib Handle."
This is a compatible event. Use the ScanToDibEx event.

Coding Style
scancontrolname_ScanToDib( ByVal hDib As Stdole.OLE_HANDLE )

Parameters
hDib DIB (Device Independent Bitmaps) handle

Target method
StartScan

Related Properties
ScanTo"Dib Handle"

Compatibility and Restraints

Do not use this event when developing a 64-bit application. Depending on the memory
usage amount during the process of running an application, it may cause the application to
end abnormally or cause an error in the image data.
This is a compatible event which can be re-compiled when using SDK V2.2L70 or later.
However, you cannot compile this event after a major version upgrade that may occur in the
future.
When creating a new application or when fixing a program, use the ScanToDibEx event
name instead of ScanToDib.
If the image data is not saved , this event will not occur.
The application is responsible for releasing the DIB (Device Independent Bitmaps) handle
(handle to the global memory) obtained from this event.
Release the DIB handle (global memory) when it is no longer necessary when scanning with
the ScanTo property set to "1 - Dib Handle." Otherwise, the global memory area available to
the system is reduced and may result in the system being unstable.
This Control is not liable for DIB handles (global memory) issued by this event after their
issuance. The application is responsible for its use and release afterwards.
This event is not supported by Java.

286
1.3.13 ScanToDibEx .... DIB Handle Consignment
Feature
This event is issued for each page during the scanning process (the StartScan method)
when the ScanTo property is set to "1 - Dib Handle."

Coding Style
scancontrolname_ScanToDibEx ( ByVal hDib As Long )

Parameters
hDib DIB (Device Independent Bitmaps) handle

Target method
StartScan

Related Properties
ScanTo"1 - Dib Handle"

Compatibility and Restraints

If the image data is not saved , this event will not occur.
The application is responsible for releasing the DIB (Device Independent Bitmaps) handle
(handle to the global memory) obtained from this event. Release the DIB handle (global
memory) when it is no longer necessary when scanning with the ScanTo property set to "1 -
Dib Handle". Otherwise, the global memory area available to the system is reduced and may
result in the system being unstable.
This Control is not liable for DIB handles (global memory) issued by this event after their
issuance. The application is responsible for its use and release afterwards.
This event is not supported by Java.
The GetBitmapFromDIB method that converts the DIB handle into the Bitmap class is
provided for Visual Basic/Visual C#. For details, refer to “3.6 Bitmap Class Conversion
Libraries for Visual Basic/Visual C#”.

287
1.3.14 ScanToFile .... File Output
Feature
This event is issued for each page during the scanning process (the StartScan method)
when the ScanTo property is set to "0 - File".

Coding Style
scancontrolname_ScanToFile( ByVal ReadCount As Long, ByVal FileName As String )

Parameters
ReadCount Scanning image count
FileName Scanning file name

Target method
StartScan

Related Properties
ScanTo"File"

Compatibility and Restraints

If the file is not saved, this event will not occur.

Sample

[Java]
public void eventScanToFile(long readCount, String fileName) {
System.out.println("File transfer was detected.");
}

288
1.3.15 ScanToRaw .... Memory Output
Feature
This event is issued for each page during the scanning process (the StartScan method)
when the ScanTo property is set to "2 - Raw Image Handle."
This is a compatible event. Use the ScanToRawEx event.

Coding Style
scancontrolname_ScanToRaw(ByVal Resolution As Integer,
ByVal ImageWidth As Long,
ByVal ImageLength As Long,
ByVal BitPerPixel As Integer,
ByVal CompressionType As Integer,
ByVal Size As Long,
ByVal hRaw As Stdole.OLE_HANDLE )

Parameters
Resolution Resolution (dpi)
ImageWidth Image width (pixel)
ImageLength Image length (pixel)
BitPerPixel Number of bits per pixel
CompressionType Compression type (refer to the CompressionType property)
Size Data size
Hraw Image data handle (pointer)

Target method
StartScan

Related Properties
ScanTo"Raw Image Handle"
CompressionType

Compatibility and Restraints

Do not use this event when developing a 64-bit application. Depending on the memory
usage amount during the process of running an application, it may cause the application to
end abnormally or cause an error in the image data.
This is a compatible event which can be re-compiled when using SDK V2.2L70 or later.
However, you cannot compile this event after a major version upgrade that may occur in the
future.
When creating a new application or when fixing a program, use the ScanToRawEx event
name instead of ScanToRaw.
If the image data is not saved , this event will not occur.
The image data handle (global memory) issued by this event is released by this Control.
Therefore, referring to the image data handle (global memory) acquired from this event is not
available after this event is finished. The application should assign global memory in this
event and use the copy if necessary. Access to the image data handle after this event is
finished may result in an abnormal termination of the application, or anomalies of the system,
or in the worst case, the system may go down.
Although the RGB color could not be specified for JPEG in V1.0, it has become possible
since V2.0L10. Specify "2 - RGB" to the PixelType property, "5 - JPEG" to the
CompressionType property, and "3 - JPEG" to the FileType property.
This event is not supported by Java.

289
1.3.16 ScanToRawEx .... Memory Output
Feature
This event is issued for each page during the scanning process (the StartScan method)
when the ScanTo property is set to "2 - Raw Image Handle."

Coding Style
scancontrolname_ScanToRawEx (ByVal Resolution As Integer,
ByVal ImageWidth As Long,
ByVal ImageLength As Long,
ByVal BitPerPixel As Integer,
ByVal CompressionType As Integer,
ByVal Size As Long,
ByVal hRaw As Long )

Parameters
Resolution Resolution (dpi)
ImageWidth Image width (pixel)
ImageLength Image length (pixel)
BitPerPixel Number of bits per pixel
CompressionType Compression type (refer to the CompressionType property)
Size Data size
Hraw Image data handle (pointer)

Target method
StartScan

Related Properties
ScanTo"Raw Image Handle"
CompressionType

Compatibility and Restraints

If the image data is not saved , this event will not occur.
The image data handle (global memory) issued by this event is released by this Control.
Therefore, referring to the image data handle (global memory) acquired from this event is not
available after this event is finished. The application should assign global memory in this
event and use the copy if necessary. Access to the image data handle after this event is
finished may result in an abnormal termination of the application, or anomalies of the system,
or in the worst case, the system may go down.
Although the RGB color could not be specified for JPEG in V1.0, it has become possible
since V2.0L10. Specify "2 - RGB" to the PixelType property, "5 - JPEG" to the
CompressionType property, and "3 - JPEG" to the FileType property.
This is not supported by Java.
The GetBitmapFromRAW method that converts the image data handle into the Bitmap class
is provided for Visual Basic/Visual C#. For details, refer to “3.6 Bitmap Class Conversion
Libraries for Visual Basic/Visual C#”.

290
1.4 Property Pages
Property Pages is a screen where properties (of frequent use) of RICOH Scanner Control are
edited. (The following screen is displayed by selecting a RICOH Scanner Control property which
is pasted on a form in Visual Basic 2015.)
The following items (properties) can be specified in the Property Pages.

Paper supply : PaperSupply property

0 - Flatbed Flatbed
1 - ADF ADF (scanning the front side)
2 - ADF(Duplex) ADF(Duplex scan)
3 - ADF(BackSide) ADF(Back scan)
4 - ADF(CarrierSheet Spread A3)
A3 double-page spread images scanned using the Carrier Sheet
5 - ADF(CarrierSheet Spread DL)
Double-letter double-page spread images scanned using the Carrier Sheet
6 - ADF(CarrierSheet Spread B4)
B4 double-page spread images scanned using the Carrier Sheet
7 - ADF(CarrierSheet Clipping)
Separate outputs of front and back side images scanned using the Carrier Sheet
10 - ADF(CarrierSheet Spread A3)
A3 double-page spread images scanned using the Carrier Sheet
11 - ADF(CarrierSheet Spread DL)
Double-letter double-page spread images scanned using the Carrier Sheet
12 - ADF(CarrierSheet Spread B4)
B4 double-page spread images scanned using the Carrier Sheet
13 - ADF(CarrierSheet Spread Auto)
Automatic detection double-page spread images scanned using the Carrier Sheet
14 - ADF(CarrierSheet Clipping All)
Carrier Sheet Size Clipping Front images scanned using the Carrier Sheet
15 - ADF(CarrierSheet Clipping A4)
A4 Clipping Front images scanned using the Carrier Sheet
16 - ADF(CarrierSheet Clipping A5)
A5 Clipping Front images scanned using the Carrier Sheet
17 - ADF(CarrierSheet Clipping A6)
A6 Clipping Front images scanned using the Carrier Sheet
18 - ADF(CarrierSheet Clipping POST)
POST Card Clipping Front images scanned using the Carrier Sheet

291
19 - ADF(CarrierSheet Clipping B5)
B5 Clipping Front images scanned using the Carrier Sheet
20 - ADF(CarrierSheet Clipping B6)
B6 Clipping Front images scanned using the Carrier Sheet
21 - ADF(CarrierSheet Clipping LT)
Letter Clipping Front images scanned using the Carrier Sheet
22 - ADF(CarrierSheet Clipping CARD_T)
Card Clipping Front images scanned using the Carrier Sheet
23 - ADF(CarrierSheet Clipping CARD_Y)
Card landscape Clipping Front images scanned using the Carrier Sheet
24 - ADF(CarrierSheet Clipping PHOTO_ET)
Photo E portrait Clipping Front images scanned using the Carrier Sheet
25 - ADF(CarrierSheet Clipping PHOTO_EY)
Photo E landscape Clipping Front images scanned using the Carrier Sheet
26 - ADF(CarrierSheet Clipping PHOTO_LT)
Photo L portrait Clipping Front images scanned using the Carrier Sheet
27 - ADF(CarrierSheet Clipping PHOTO_LY)
Photo L landscape Clipping Front images scanned using the Carrier Sheet
28 - ADF(CarrierSheet Clipping PHOTO_LLT)
Photo LL portrait Clipping Front images scanned using the Carrier Sheet
29 - ADF(CarrierSheet Clipping PHOTO_LLY)
Photo LL landscape Clipping Front images scanned using the Carrier Sheet
30 - ADF(CarrierSheet Clipping Auto)
Automatic detection Clipping Front images scanned using the Carrier Sheet
31 - ADF(CarrierSheet Clipping Custom)
Custom Clipping Front images scanned using the Carrier Sheet
32 - ADF(CarrierSheet Clipping Duplex All)
Carrier Sheet Size Clipping Duplex images scanned using the Carrier Sheet
33 - ADF(CarrierSheet Clipping Duplex A4)
A4 Clipping Duplex images scanned using the Carrier Sheet
34 - ADF(CarrierSheet Clipping Duplex A5)
A5 Clipping Duplex images scanned using the Carrier Sheet
35 - ADF(CarrierSheet Clipping Duplex A6)
A6 Clipping Duplex images scanned using the Carrier Sheet
36 - ADF(CarrierSheet Clipping Duplex POST)
POST Card Clipping Duplex images scanned using the Carrier Sheet
37 - ADF(CarrierSheet Clipping Duplex B5)
B5 Clipping Duplex images scanned using the Carrier Sheet
38 - ADF(CarrierSheet Clipping Duplex B6)
B6 Clipping Duplex Images scanned using the Carrier Sheet
39 - ADF(CarrierSheet Clipping Duplex LT)
Letter Clipping Duplex images scanned using the Carrier Sheet
40 - ADF(CarrierSheet Clipping Duplex CARD_T)
Card Clipping Duplex images scanned using the Carrier Sheet
41 - ADF(CarrierSheet Clipping Duplex CARD_Y)
Card landscape Clipping Duplex images scanned using the Carrier Sheet
42 - ADF(CarrierSheet Clipping Duplex PHOTO_ET)
Photo E portrait Clipping Duplex images scanned using the Carrier Sheet
43 - ADF(CarrierSheet Clipping Duplex PHOTO_EY)
Photo E landscape Clipping Duplex images scanned using the Carrier Sheet
44 - ADF(CarrierSheet Clipping Duplex PHOTO_LT)
Photo L portrait Clipping Duplex images scanned using the Carrier Sheet
45 - ADF(CarrierSheet Clipping Duplex PHOTO_LY)
Photo L landscape Clipping Duplex images scanned using the Carrier Sheet
46 - ADF(CarrierSheet Clipping Duplex PHOTO_LLT)
Photo LL portrait Clipping Duplex images scanned using the Carrier Sheet
47 - ADF(CarrierSheet Clipping Duplex PHOTO_LLY)
Photo LL landscape Clipping Duplex images scanned using the Carrier Sheet

292
 48 - ADF(CarrierSheet Clipping Duplex Auto)
Automatic detection Clipping Duplex images scanned using the Carrier Sheet
49 - ADF(CarrierSheet Clipping Duplex Custom)
Custom Clipping Duplex images scanned using the Carrier Sheet

File type : FileType property

0 - BMP Windows Bitmap file
1 - TIFF TIFF file
2 - Multipage TIFF Multipage TIFF files
3 - JPEG JPEG file
4 - PDF PDF file
5 - Multipage PDF Multipage PDF files
6 - Multi Image Output Multi-Image output
7 - Auto Coloer Detection Auto color detection

Compression type : CompressionType property

0 - No Compress No (not compressing)
1 - CCITT G3(1D) MH compression
2 - CCITT G3(2D) Kfactor = 2 MR compression K Factor 2
3 - CCITT G3(2D) Kfactor = 4 MR compression K Factor 4
4 - CCITT G4 MMR compression
5 - JPEG JPEG compression
6 - Old JPEG Old JPEG compression

JPEG quality level : JpegQuality property

0 - Level1 Compression level 1 (Size given top priority)
1 - Level2 Compression level 2
2 - Level3 Compression level 3
3 - Level4 Compression level 4
4 - Level5 Compression level 5
5 - Level6 Compression level 6
6 - Level7 Compression level 7 (Image quality given top priority)

File name : FileName property

File name for saving the image

293
2. Samples
Sample source codes and executable forms of Visual Basic 2015, Visual C++ 2015, Visual C#
2015 and Java are included in this product.
This version includes samples for using Windows control (ActiveX Control) to scan an image data.
All samples are stored in the following location.
<Installation folder>〵 Sample 〵

These samples are supplemental references for this document. Use these samples or partly
modified samples to confirm operations. However, RICOH is not liable for any operational results
of the samples.

To use the development environment for Visual Studio 2015, Visual Studio 2017, Visual Studio
2019 or Visual Studio 2022, use the samples for Visual Basic 2015, Visual C++ 2015, or Visual
C# 2015.
Microsoft .Net Framework 4.6.2 is required to run the samples for Visual Basic 2015 and Visual
C# 2015. Install Microsoft .NET Framework 4.6.2 in advance.
Microsoft Runtime Library 2022 is required to run the samples for Visual C++ 2015. Install
Microsoft Runtime Library 2022 in advance.

2.1 Basic Operations

(1) As the sample starts, it opens the scanner with the OpenScanner method.
(2) When [StartScan] is selected from the sample's [Scanner] menu, or the [Scan] button is clicked,
it starts scanning with the StartScan method.
(3) When [Exit] is selected from the sample's [File] menu, or the [Exit] button is clicked, it closes
scanner with the CloseScanner method.
(4) When the [Reset] button in the sample is clicked, it returns to the initial configuration status.
(5) When the [PSIP Default] button in the sample is clicked, the default values for PaperStream IP
(TWAIN) driver will be set.

294
2.2 Item Names
Item names within the sample, under the [Scanner] and [Option] menus are corresponding to the
property names and method names of RICOH Scanner Control.
However, the [SoftIPC Template], [TWAIN Template], [Source List], and [Output Result] items
under the [Option] menu are corresponding to neither property names nor method names. (Refer
to "2.3 SoftIPC Template", "2.4 TWAIN Template", "2.5 Source List", and "2.6 Output Result".)

Configuration item of the

FileType property

Configuration item of the

ShowSourceUI property

295
2.3 SoftIPC Template
A dialog box with a list of templates for the "Image Processing Software Option" is displayed to
allow the user to select a template when [SoftIPC Template] under the [Option] menu is clicked.
This dialog box is displayed using the following methods.
A separate product "Image Processing Software Option" must be installed to use this function.

Used Methods
GetSIpcTemplateCount
GetSIpcTemplateName
GetSIpcTemplateSelect
SetSIpcTemplateSelect

2.4 TWAIN Template

A dialog box with a list of templates for the "TWAIN" is displayed to allow the user to select a
template when [TWAIN Template] under the [Option] menu is clicked.
This dialog box is displayed using the following methods.

Used Methods
GetTWAINTemplateCount
GetTWAINTemplateName
GetTWAINTemplateSelect
SetTWAINTemplateSelect

296
2.5 Source List
A dialog box with a list of data source names is displayed to allow the user to select a data source
when [Source List] under the [Option] menu is clicked.

Used Methods
GetSourceCount
GetSourceName
GetSourceSelect
SelectSourceName

2.6 Output Result

Event detection results will be stored with the file name "OutputResult.txt" to where the sample is
stored when [Output Result] under the [Option] menu is clicked.

297
2.7 Visual Basic / Visual C# Sample Screen

Visual Basic samples / Visual C# samples consist of the Standard, Image, Image2, Extension,
Endorser, Barcode, PatchCode, EdgeFiller, 1stStream, 2ndStream and 3rdStream screens.
Configure items by switching between screens.
The screenshot shown below is for reference purposes only. The actual sample screen may look
different.

Standard tab

Cautions
1) The [File] item only is supported among the ScanTo items.
2) When [File] or [Display&File] is specified in the [Report] sub-menu under the [Option] menu,
the ReportFile is stored where samples are stored, with a file name "Report.txt."

298
Image tab

This area can be specified when the

PixelType item is set to [0 - Black &
White], the Threshold item is set to [0],
and the Halftone item is set to [None].

299
Image2 tab

300
Extension tab

301
Endorser tab
The Endorser associated items can be
specified when the Endorser check box is
checked.

The DigitalEndorser associated items can

be specified when the DigitalEndorser
check box is checked.

302
Barcode tab
The BarcodeDetection associated items
can be specified when the Barcode check
box is checked.

303
PatchCode tab

304
EdgeFiller tab

The EdgeFiller related items can be

specified when the EdgeFiller item is not
set to OFF.

305
Stream tab

Allows specification of MultiStreamMode

related properties.

Option > AutoProfile…

306
When the [Check ADF] button is clicked, the Check ADF dialog box opens, and monitoring is
started for whether a document is loaded in the ADF.

Monitoring is canceled if a document is loaded in the ADF.

After scanning is completed, the DetectBarcodeDetail and DetectPatchCode event detection

results and AIQCResult and BlankPageResult and MultiFeedResult are displayed.

307
2.8 Visual C++ Sample Screen
Configuration of the Image, Endorser, Extension, Barcode, PatchCode and EdgeFiller items for
Visual C++ samples is performed by opening an appropriate dialog box.
The screenshot shown below is for reference purposes only. The actual sample screen may look
different.

Cautions
1) If a scan is performed when [Dib Handle] or [Raw Image Handle] is specified for the
ScanTo item, this sample stores the data in the same location as the [File] specification for
the ScanTo item, with the same file name, in a Windows bitmap format.
2) When [File] or [Display&File] is specified in the [Report] sub-menu under the [Option] menu,
the ReportFile is stored where samples are stored, with a file name "Report.txt."

308
The Image dialog box opens when the [Image] button is clicked.

This area can be specified when the

PixelType item is set to [0 - Black &
White], the Threshold item is set to [0],
and the Halftone item is set to [None].

The Image2 dialog box opens when the [Image2] button is clicked.

309
The Endorser dialog box opens when the [Endorser] button is clicked.
The Endorser associated items can be
specified when the Endorser check box is
checked.

The DigitalEndorser associated items can be

specified when the DigitalEndorser check box
is checked.

310
The Extension dialog box opens when the [Extension] button is clicked.

311
The Barcode dialog box opens when the [Barcode] button is clicked.

The BarcodeDetection associated items

can be specified when the Barcode check
box is checked.

312
The PatchCode dialog box opens when the [PatchCode] button is clicked.

The EdgeFiller dialog box opens when the [EdgeFiller] button is clicked.

The EdgeFiller related items can be

specified when the EdgeFiller item is not
set to OFF.

The AutoProfile dialog box opens when the [AutoProfile…] is selected from the [Option] menu.

313
When the [Check ADF] button is clicked, the Check ADF dialog box opens, and monitoring is
started for whether a document is loaded in the ADF.

Monitoring is canceled if a document is loaded in the ADF.

After scanning is completed, the DetectBarcodeDetail and DetectPatchCode event detection

results and AIQCResult and BlankPageResult and MultiFeedResult are displayed.

314
2.9 Java Sample Program
There is no setup screen for a Java sample.
To set properties, use the following xml file.
<Installation folder>〵 ScanTest 〵 Java 〵 FiscnProperties.xml

* Specify the correct path for FileName of FiscnProperties.xml.

To run a Java sample,

(1) Start a command prompt, and run the following command.
cd /d "<Installation folder>"
(2) In the command prompt, run the following command.
java -classpath "<Installation folder>〵 Sample 〵 ScanTest 〵 Java";"<Installation folder>〵
Fiscn.jar" com.ricoh.pfu.fiscn.sdksample.FiscnSampleApp "<Installation folder>〵 Sample 〵
ScanTest 〵 Java 〵 FiscnProperties.xml"

-classpath : Specify jar files or class directories necessary to run the Java sample.
Use a semi colon (;) to separate multiple paths.
Second parameter : Specify an execution class.
Third parameter : Specify an execution parameter.

315
3. Appendix
3.1 Error code and how to fix error
The following describes error countermeasures and attributes for each error number.
■: Errors caused by hardware (critical), □: Errors caused by hardware (non-critical)
●: Errors caused by software (critical), ○: Errors caused by software (non-critical)
Error Number Countermeasures Atr.
0x00000000 EC_SUCCESS - -
0x00000001 EC_NOT_READY Initialization in progress. Try again after the □
(Device is not ready) device becomes ready.
Errors are numbered in the form of
"0x00000001" so that they will be compatible
with the numbering by the old versions.
0x00000002 EC_DETECT_SPECIAL_PAPER Special document or patch code document □
(Special document or patch code detection error. An error to notify the user.
document was detected.) Check the document status.
0x00000003 EC_JAM Check the document status and try again. □
(A paper jam has occurred)
0x00000004 EC_OPENED_ADFCOVER Close the ADF cover and try again. □
(ADF cover, or endorser / imprinter Note: Some devices report the error number
cover is open) 0x0000001B or 0x0000002A when the
ADF cover is open.
0x00000005 EC_NOT_ENOUGH_PAPER Check the document status. □
(No more documents left)
0x00000006 EC_RUNDOWN_FUSE_FBMOTOR The part should be replaced, or the part may ■
(Motor fuse for FB is blown) have failed. Refer to the User's Guide for
your device.
0x00000007 EC_RUNDOWN_FUSE_ADFMOTO The part should be replaced, or the part may ■
R have failed. Refer to the User's Guide for
(Motor fuse for ADF is blown) your device.
0x00000008 EC_RUNDOWN_FUSE_HEATER The part should be replaced, or the part may ■
(Fuse for heater is blown) have failed. Refer to the User's Guide for
your device.
0x00000009 EC_RUNDOWN_FUSE_LAMP The part should be replaced, or the part may ■
(Fuse for lamp is blown) have failed. Refer to the User's Guide for
your device.
0x0000000A EC_RUNDOWN_FUSE_ENDORSE The part should be replaced, or the part may ■
R have failed. Refer to the User's Guide for
(Fuse for Endorser or Imprinter is your device.
blown)
0x0000000B EC_RUNDOWN_SYSTEM The carrier unit may be locked. ■
(Abnormal device drive system) Or the part should be replaced, or the part
may have failed. Refer to the User's Guide
for your device.
0x0000000C EC_ABNORMAL_LIGHTLEVEL The part should be replaced, or the part may ■
(Abnormal light level, Fan have failed. Refer to the User's Guide for
malfunction) your device.
0x0000000D EC_CANNOT_CONTROL_SPC The part should be replaced, or the part may ■
(Internal target error) have failed. Refer to the User's Guide for
your device.
0x0000000E EC_ABNORMAL_ENDORSER The part should be replaced, or the part may ■
(Endorser / Imprinter error) have failed. Refer to the User's Guide for
your device.
0x0000000F EC_INVALID_COMMAND An illegal process in the driver or control, or ●
(Invalid command) an unknown device failure. Restart the ■
computer and scanner device and try again.

316
Error Number Countermeasures Atr.
0x00000010 EC_INVALID_CDB_FIELD An illegal process in the driver or control, or ●
(Unknown code in the CDB field)
an unknown device failure. Restart the ■
computer and scanner device and try again.
0x00000011 EC_UNSUPPORTED_LOGICAL_U An illegal process in the driver or control, or ●
NIT an unknown device failure. Restart the ■
(Unsupported logical unit) computer and scanner device and try again.
0x00000012 EC_INVALID_PARAM_FIELD An illegal process in the driver or control, or ●
(Invalid parameter field) an unknown device failure. Restart the ■
computer and scanner device and try again.
0x00000013 EC_ABNORMAL_WINDOWID An illegal process in the driver or control, or ●
(Window ID combination error) an unknown device failure. Restart the ■
computer and scanner device and try again.
0x00000014 EC_ERROR_SEQUENCE An illegal process in the driver or control, or ●
(Sequence error) an unknown device failure. Restart the ■
computer and scanner device and try again.
0x00000015 EC_UNIT_ATTENTION Initialization in progress. Try again after the □
(Device is being reset) device becomes ready.
0x00000016 EC_ERROR_TRANSFER_IMAGE The internal memory of the device may be □
(Image transfer error) insufficient. Reduce the scan image size and ○
try again.
0x00000017 EC_ERROR_SCSI_PARITY The interface section (SCSI card, SCSI ■
(SCSI parity error) cable, etc.) of the device may have failed.
Check the interface section.
0x00000018 EC_ERROR_LOAD_SM The TWAIN driver may not be installed ○
(Source manager load error) correctly. Check if the TWAIN driver is
installed correctly.
0x00000019 EC_ERROR_OPEN_SM The TWAIN driver may not be installed ○
(Source manager open error) correctly. Check if the TWAIN driver is
installed correctly.
0x0000001A EC_ERROR_OPEN_DS Possible causes include: ○
(Data source open error) - The device is not be powered on.
- The TWAIN driver is in use by another
application.
- The TWAIN driver is not be installed
correctly.
- The device is not be connected correctly.
- The device is not be selected in Scanner
Selection Tool.
- The scanner settings screen is being
displayed on the touch screen.
Please check and respond to the following.
- The device is powered on.
- Terminate any other application.
- The TWAIN driver is installed correctly.
- The device is connected correctly.
- The device is selected in Scanner
Selection Tool.
- Close the scanner settings screen on the
touch screen.
0x0000001B EC_ERROR_ENABLE_DS The device may have an error. This may be ○
(Data source enable error) output if the ADF cover is open when the □
ClearPage is issued. Or cancellation is
responded to the message "Please wait for
the scanner lamp to warm up."

317
Error Number Countermeasures Atr.
0x0000001D EC_DEVICE_NOT_FOUND Check if the device is connected correctly ○
(Cannot find the connected device) and if the device is powered on. Also, check □
if the device is being used by another
application.
0x0000001E EC_UNSUPPORTED_XFERMECH An unsupported transfer mode has been ○
(Transfer mode is not supported) specified.
Modify the ScanTo property and try again.
0x0000001F EC_UNSUPPORTED_FILE_TYPE An unsupported file type has been specified. ○
(File type is not supported) Modify the FileType property and try again.
0x00000020 EC_CANNOT_MAKE Check the character string (file path) ○
(Cannot create a file) specified in the FileName property.
0x00000022 EC_UNSUPPORTED_DS_UIONLY Check the version of the TWAIN driver. ○
(Data source does not support the
configuration screen only mode)
0x00000023 EC_INVALID_WINDOWHANDLE The specified Window handle is invalid. ○
(Window handle of the application is Check if the Window handle is specified
invalid) correctly.
0x00000024 EC_UNSUPPORTED_DEVICEONL The version of the TWAIN driver may be old. ○
INE Or, other company's scanner driver may
(Data source in use does not have been specified. Check the specified
support the DeviceOnline function) scanner driver.
0x00000025 EC_UNSUPPORTED_FEEDER The ADF is not supported. Check if the □
(ADF is not supported) device is equipped with an ADF. Also, check
the PaperSupply property and try again.
0x00000026 EC_UNSUPPORTED_FLATBED The flatbed (FB) is not supported. Check the □
(Flatbed (FB) is not supported) PaperSupply property and try again.
0x00000027 EC_ERROR_FEEDPAGE Check if the documents are still in the ADF or □
(Paper feed error, or all the check the scanned documents.
document pages were determined
to be blank.)
0x00000028 EC_ERROR_CLEARPAGE Check if a paper jam has occurred. Or, check ■
(Paper eject error (or the ClearPage if the TWAIN driver supports the ClearPage
function is not supported)) function.
0x00000029 EC_ERROR_NOT_SUPPORTED_ A non-TWAIN driver error. Check the ○
DS currently selected driver source and select
(PRODUCT FAMILY is not the TWAIN driver.
"FUJITSU" or “PaperStream IP”)
0x0000002A EC_ERROR_CANCELED A cancel detection error. An error to notify □
(Canceled by the user, or detected the user. Or, an error which causes the ○
an error which causes the device to device to be unable to continue scanning
be unable to continue scanning) (insufficient disk space, pattern file error,
insufficient memory, image transfer error,
etc.) Check the available disk space of the
drive specified in the FileName property,
check if the pattern file is correct, and reduce
the scan image size and resolution and try
again.
0x0000002B EC_ERROR_MAX_CONNECTION The TWAIN driver is in use by another ○
S application. Try again after other applications
(Driver is in use by another are finished.
application)
0x0000002C EC_ERROR_LOW_MEMORY Reduce the scan image size and resolution, ○
(Insufficient memory) and try again.
0x0000002D EC_ERROR_LOW_DISK Check the available disk space on the drive ○
(Insufficient disk space, or file specified in the FileName property. And
writing error) check if any other error is occurring.

318
Error Number Countermeasures Atr.
0x0000002E EC_ERROR_ACCESSDENIED Check the file path specified in the FileName ○
(File is in use) property.
0x0000002F EC_ERROR_ENV_SAVEFILE Check the file path specified in the FileName ○
(File save environment error) property.
0x00000030 EC_ERROR_WRITEDENIED_FILE Check the file path specified in the FileName
(No write privileges to the file) property.
0x00000031 EC_ERROR_UNSETING_FILENA Indicate the file name in the file path ○
ME specified in the FileName or FileName1 or
(File name is not specified) FileName2 or FileName3 property.
0x00000032 EC_ERROR_BAD_PATH Check if the file path is correctly specified in ○
(Specified path is invalid) the FileName or FileName1 or FileName2 or
FileName3 property.
0x00000033 EC_ERROR_WRITEDENIED_DIRE Check if you have write privileges on the ○
CTORY directory in the file path specified in the
(No write privileges to the specified FileName or FileName1 or FileName2 or
directory) FileName3 property.
0x00000034 EC_ERROR_NOT_NCEVENT Call the GetCapability or SetCapability ○
(Not the NegotiateCapabilities method using the NegotiateCapabilities
event) event.
0x00000035 EC_ERROR_BAD_PARAMETER The parameter specified for the ○
(Specified parameter is invalid) GetCapability method is invalid, or one of the
following is done for each image in the
MultiStreamPropertySetting event while a
value other than "0 - OFF" is set for the
MultiStreamMode property.
- Set "6 - Multi Image Output" or "7 - Auto
Color Detection" for the FileType property
- Set a value other than "0 - Black & White"
to "2 - RGB" for the PixelType property
Check the parameter.
0x00000036 EC_DOUBLEFEED A paper multi-feed (double-feed) detection □
(Detected paper multi-feed or error. An error to notify the user. Check the
double-feed) document status and try again.
0x00000037 EC_ABNORMAL_IPCOPTION The part should be replaced, or the part may ■
(Anomaly in IPC option) have failed.
Refer to the User's Guide for your device.
0x00000038 EC_ADF_SETUPERROR The ADF pick roller may be attached ■
(ADF setup error) incorrectly, or the device may have failed.
Refer to the User's Guide for your device.
0x00000039 EC_ABNORMAL_ENDORSER_PRI The print area specification in Imprinter □
NTAREA (Endorser) is invalid.
(Imprinter (Endorser) print area Modify the print position.
specification error)
0x0000003A EC_ENDORSER_PRINTHEAD_CH Check the ink cartridge for Imprinter □
ECK (Endorser).
(Check Imprinter (Endorser) ink
cartridge)
0x0000003B EC_UNSUPPORTED_FEEDERLO The version of the TWAIN driver may be old. ○
ADED Or, other company's scanner driver may
(FeederLoaded method is not have been specified. Check the specified
supported) scanner driver.
0x0000003D EC_ERROR_SKEW Check whether the document is slanted. ○
(Abnormal skew detected)
0x0000003E EC_ERROR_SCANAREA The specified scan area is invalid. Change ○
(Error in specified scan area) the scan area. Or, the specified document
size is invalid. Change the document size.

319
Error Number Countermeasures Atr.
0x00000044 EC_ERROR_FEEDMODESWITCH Switching of the modes for the feed mode □
ED has been detected. Check the setting of the
(Feed mode switching detected) feed mode switch.
0x00000045 EC_JAM2 Remove the document from either the ADF □
(Documents are detected in both paper chute (feeder) or the Return path
the ADF paper chute and the Return opening.
path opening. Or, check the document status and try again.
Or, a paper jam has occurred)
0x00000062 EC_ERROR_SYSENV Restart the computer and scanner device ●
(System environment error) and try again. If the error persists, contact
RICOH Support.
0x00000063 EC_ERROR_INTERNAL Restart the computer and scanner device ●
(Internal error) and try again. If the error persists, contact
RICOH Support.
0x000003E9 EC_ERROR_CS_VLINE_NOT_FO Failed to process images as the vertical line ●
UND on the Carrier Sheet was not sensed. ■
(The vertical line on the Carrier Retry. If the error persists, contact RICOH
Sheet not sensed) Support.
0x000003EA EC_ERROR_CS_HLINE_NOT_FO Failed to process images as the horizontal ●
UND line on the Carrier Sheet was not sensed. ■
(The horizontal line on the Carrier Retry. If the error persists, contact RICOH
Sheet not sensed) Support.
0x000003EC EC_ERROR_CS_INPUT_ERROR The material you scanned is not a Carrier ●
(Illegal input parameters for merging Sheet. Load the Carrier Sheet again, and
the images scanned using the then retry.
Carrier Sheet)
0x000007D0 EC_ERROR_CS_INVALID_DS The specified data source (Image Processing ○
(Data source not supported Carrier Software Option) does not support the
Sheet) Carrier Sheet.
Do not specify Image Processing Software
Option as the data source.
0x0103800E Stopped scanning to prevent paper Check that the documents are not bound □
damage. together with fastenings such as staples.
0x0103800F Stopped scanning because a If any documents remain in the scanner, □
document may have been fed remove them. Then slide the paper output
incorrectly. selection switch up or down again and try
scanning.
0x01044400 Irregular status is detected in the If the status remains after turning OFF and ■
scanner. ON the scanner, contact RICOH Support.
0x01050000 The specified read area is not Change the read area specification. ○
suitable for the document size when Or the part should be replaced, or the part ■
the AutoBorderDetection function may have failed.
and Read Area Specification
function are combined.
Or the document detection sensor
error occurs.
0x02000001 EC_ERROR_JAVA_NOINITIALIZE Internal initialization for Java is not called. ○
Call internal initialization for Java.
0x02000002 EC_ERROR_JAVA_SDKABNORMI An SDK environmental error occurred. Check ●
TY if the SDK is installed properly.
0x02000003 EC_ERROR_METHOD_SEQUENC The method is being executed in another ●
E form. Try again after the current execution of
the method has completed.
0x02000004 EC_ERROR_SIPC_NOTINSTALL The Image Processing Software Option is not ●
installed. Install the Image Processing
Software Option.

320
Error Number Countermeasures Atr.
0x02000005 EC_ERROR_TEMPLATEGET Failed to acquire the total ●
number/names/numbers of templates in the
Image Processing Software Option. Check if
the Image Processing Software Option is
installed properly.
0x02000006 EC_ERROR_TEMPLATESET Failed to configure numbers for templates in ●
the Image Processing Software Option.
Check if the Image Processing Software
Option is installed properly.
0x02000007 EC_ERROR_FISCN_NOTFOUND Resource file "FiScn.dll" was not found. ○
Check if the "FiScn.dll" file is stored together
with "FiScn.jar" in the same place.
0x02000010 EC_ERROR_TWAIN_NOTINSTALL TWAIN driver is not installed. Install a TWAIN ●
driver.
0x02000011 EC_ERROR_TWAIN_TEMPLATEG Failed to acquire the total ●
ET number/names/numbers of setting files /
profiles in the TWAIN driver. Check if the
TWAIN driver is installed properly.
0x02000012 EC_ERROR_TWAIN_TEMPLATES Failed to configure the setting file / profile ●
ET numbers in the TWAIN driver. Check if the
TWAIN driver is installed properly.
0x02000100 EC_ERROR_FISCN_UNKNOWN A system error occurred. Retry the process. ●
If the error persists, contact RICOH Support.
0x0F000000 Error details set when the The Condition Code in the TWAIN protocol is ○
- GetCapability/SetCapability method set at lower 2-byte.
0x0F00FFFF is called. Refer to http://www.twain.org/ for the TWAIN
protocol.
0xFFFFFC16 EC_ERROR_CS_MEMORY Failed to process the images scanned with ●
(Insufficient Memory) the Carrier Sheet due to a memory failure.
Retry. If the error persists, contact RICOH
Support.

If the problem persists after applying the above countermeasures, or returns error codes other
than the above, make a note of the error code and contact RICOH Support.

321
 3.2 Relationships Between Properties

The following describes relationships between properties . Since some properties also have priority
order; refer also to "3.3 Property Priority Order."
A property is invalid (ignored) if a valid condition is not configured on a target property.
Also, the property is invalid if even one invalid condition is configured on a property.
Note: Properties which are not supported by some devices are not taken into consideration in the
following table. (* Refer to "Reference Manual (Separate Volume).")

Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
AdjustRGB N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)" "10 -
ADF(CarrierSheet Clipping)" – "49 -
ADF(CarrierSheet Clipping Duplex
Custom)"
○Valid PixelType "2 - RGB"
N/A Disabled. ScanMode "1 - Assist Scan"
N/A Disabled. sRGB "True"
AdjustRGBB ○Valid AdjustRGB "True"
AdjustRGBG
AdjustRGBR
ADTCThreshold N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
○Valid Threshold "-1"

AIQCNotice ○Valid AutoBorderDetection "True"

"True" ○Valid BackgroundColor "1 - ON"
AIQCNotice N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

AutoBorderDetection N/A Disabled. DivideLongPage "True"

N/A Disabled. LengthDetection "1 - LengthBlack”
“2 - LengthBlackOVS"

N/A Disabled. UndefinedScanning "True"

N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
AutoBorderDetection N/A Disabled. AutoProfile "1 - Enabled”
"False"

322
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
AutoBright N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

N/A Disabled. ①PixelType "0 - Black & White"

②Threshold "-2" "-1"
N/A Disabled. SimpleSlicePatternRemoval "True"
AutomaticColorBackground N/A Disabled AutoProfile "1 - Enabled"
○Valid PixelType "3 - Automatic"
AutomaticColorSensitivity N/A Disabled AutoProfile "1 - Enabled"
N/A Disabled PaperSupply “4 - ADF(CarrierSheet Spread A3)”
“5 - ADF(CarrierSheet Spread DL)”
“6 - ADF(CarrierSheet Spread B4)”
“7 - ADF(CarrierSheet Clipping)”

○Valid PixelType "3 - Automatic”

AutomaticRotateMode ○Valid AutoBorderDetection "True"
N/A Disabled. ①PaperSize "99 - Custom"
②LongPage "True"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping Duplex
Custom)"

N/A Disabled. PaperSize Longer than 14 in.

Longer than 17 in. if "A3" is available for
the PaperSize property when an A3
scannable device is connected
○Valid Rotation "4 - Automatic"
AutomaticSenseMedium N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping Duplex
Custom)"

N/A Disabled. FrontBackMergingEnabled "True"

AutoProfile N/A Disabled. MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
AutoSeparation ○Valid PixelType "0 - Black & White"
BarcodeDetection N/A Disabled. DivideLongPage "True"
Background N/A Disabled. SimpleSlicePatternRemoval "True"

323
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
BackgroundColor N/A Disabled. AutoBorderDetection "True"
N/A Disabled. AutoProfile "1 - Enabled”
N/A Disabled. LengthDetection "1 - LengthBlack"
"2 - LengthBlackOVS"
N/A Disabled. OverScan "1 - ON"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" – "49 -
ADF(CarrierSheet Clipping Duplex
Custom)"

N/A Disabled. PunchHoleRemoval "1 - White"

"2 - Background color"
N/A Disabled. UndefinedScanning "True"(FUJITSU TWAIN32 Driver only)
BackgroundSmoothing N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

○Valid PixelType "1 - Grayscale"

"2 - RGB"
BackgroundSmoothness ○Valid BackgroundSmoothing "1 - Automatic"
"2 - White"
BackgroundThreshold N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

○Valid ①PixelType "0 - Black & White"

②Threshold "-2"
BarcodeDetection N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

BarcodeDirection ○Valid BarcodeDetection "True"

BarcodeMaxSearchPriorities
BarcodeNotDetectionNotice
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionTop
BarcodeRegionWidth
BarcodeType
Binding ○Valid PaperSupply "2 - ADF(Duplex)"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" – "49 -
ADF(CarrierSheet Clipping Duplex
Custom)"

N/A Disabled. Rotation "4 - Automatic"

324
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
BlankPageIgnoreAreaSize ○Valid ①BlankPageSkipMode "0 - Sensitivity"
BlankPageNotice ②BlankPageSkip “1 - 11”
“1 - ON”
○Valid ①BlankPageSkipMode "1 - Black & White Dots Ratio"
BlankPageSkipMode
②SkipBlackPage "1 - 50"
○Valid ①BlankPageSkipMode "1 - Black & White Dots Ratio"
②SkipWhitePage "1 - 50"
BlankPageIgnoreAreaSize N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
BlankPageNotice "5 - ADF(CarrierSheet Spread DL)"
BlankPageSkip "6 - ADF(CarrierSheet Spread B4)"
BlankPageSkipMode "7 - ADF(CarrierSheet Clipping)"
BlankPageSkipTabPage
BlankPageSkip N/A Disabled. DivideLongPage "True"
BlankPageSkipTabPage ○Valid ①BlankPageSkipMode "0 - Sensitivity"
②BlankPageSkip "1 - 11"
③AutoBorderDetection "True"
○Valid ①BlankPageSkipMode "1 - Black & White Dots Ratio"
②SkipBlackPage "1 - 50"
③AutoBorderDetection "True"
○Valid ①BlankPageSkipMode "1 - Black & White Dots Ratio"
②SkipWhitePage "1 - 50"
③AutoBorderDetection "True"
Brightness N/A Disabled. AutoBright "True"
N/A Disabled. Gamma "1 - Soft"
"2 - Sharp"
"3 - Gamma Pattern File"
"5 - Bright"
"6 - Standard"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
N/A Disabled. ①PixelType "0 - Black & White"
②Threshold "-2" "-1"
N/A Disabled. SimpleSlicePatternRemoval "True"
CarrierSheetClippingMode N/A Disabled. PaperSupply "14 - ADF(CarrierSheet Clipping All)"
– "49 - ADF(CarrierSheet Clipping
Duplex Custom)"
CharacterExtraction ○Valid ①PixelType "0 - Black & White"
②Threshold "-2"
CharacterExtractionMethod ○Valid CharacterExtraction "True"
CharacterThickness N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
○Valid ①PixelType "0 - Black & White"
②Threshold "-2"
CloseSourceUI ○Valid ShowSourceUI "True"

325
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
ColorReproduction N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
○Valid PixelType "2 - RGB"
N/A Disabled ScanMode "1 - Assist Scan"
N/A Disabled sRGB "True"
ColorReproductionBrightness ○Valid ColorReproduction "1 - Hue"
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow
CompressionType N/A Disabled. FileType "0 - BMP"
Note: Except when the ScanTo
property is set to "2 - Raw Image
Handle"
CompressionType “6 - Old JPEG” N/A Disabled. ①FileType "4 - PDF"
"5 - Multipage PDF"
②PixelType "1 - Grayscale"
"2 - RGB"
CompressionType "1 - CCITT N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
G3(1D)" "5 - ADF(CarrierSheet Spread DL)"
"2 - CCITT G3(2D) KFactor = 2" "6 - ADF(CarrierSheet Spread B4)"
"3 - CCITT G3(2D) KFactor = 4" "7 - ADF(CarrierSheet Clipping)"
"4 - CCITT G4"
"6 - Old JPEG"
Contrast N/A Disabled. AutoBright "True"
N/A Disabled. Gamma "1 - Soft"
"2 - Sharp"
"3 - Gamma Pattern File"
"5 - Bright"
"6 - Standard"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
N/A Disabled. ①PixelType "0 - Black & White"
②Threshold "-2" "-1"
N/A Disabled. SimpleSlicePatternRemoval "True"
CropMarginSize ○Valid AutoBorderDetection "True"
N/A Disabled. AutoProfile "1 - Enabled”
N/A Disabled. FrontBackMergingEnabled "True"
○Valid SelectOutputSize "0 - Margin"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

326
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
CropPriority ○Valid AutoBorderDetection "True"
N/A Disabled. ScanMode "1 - Assist Scan"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

CustomGamma ○Valid Gamma "4 - Custom"

N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

CustomPaperLength N/A Disabled. ①LongPage "True"

LongPage ②PaperSize "99 - Custlom"
(For conditions that make the
③FrontBackMergingEnabled "True"
LongPage property invalid when
"True" is set for the
FrontBackMergingEnabled
property, refer to the driver help.)
CustomPaperLength N/A Disabled. ①LongPage "True"
17inch or over ②PaperSize "99 - Custlom"
③AutoProfile "1 - Enabled"
CustomPaperLength, ○Valid PaperSize "99 - Custom"
CustomPaperWidth
CustomPaperLength, N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
CustomPaperWidth "5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"30 - ADF(CarrierSheet Clipping Auto)
"
"32 - ADF(CarrierSheet Clipping
Duplex All) " – "48 - ADF(CarrierSheet
Clipping Duplex Auto)"
CustomResolution ○Valid Resolution "99 - Custom"
Deskew N/A Disabled. AutoBorderDetection "True"
N/A Disabled. AutoProfile "1 - Enabled”
N/A Disabled. DivideLongPage "True"
N/A Disabled. FrontBackMergingEnabled "True"
N/A Disabled. LengthDetection "1 - LengthBlack”
“2 - LengthBlackOVS"
N/A Disabled. UndefinedScanning "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

327
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
DeskewBackground N/A Disabled Deskew "2 - OFF"
N/A Disabled PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

DeskewMode N/A Disabled. Deskew "2 - OFF"

DigitalEndorser N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
DigitalEndorserCountDirection ○Valid DigitalEndorser "True"
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset
DivideLongPage N/A Disabled. AutoProfile "1 - Enabled"
N/A Disabled. MultiStreamMode "1 – 2 MultiImage""2 – 3 MultiImage”
DTCSensitivity N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
○Valid ①PixelType "0 - Black & White"
②Threshold "-2"
EdgeFiller N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
EdgeFillerBottom ○Valid EdgeFiller "1 - Black"
EdgeFillerLeft "2 - White"
EdgeFillerRigth
EdgeFillerTop
EdgeRepair ○Valid AutoBorderDetection "True"
N/A Disabled. DivideLongPage "True"
N/A Disabled. FrontBackMergingEnabled "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
Endorser N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

328
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
EndorserCountDirection, ○Valid Endorser "True"
EndorserCounter,
EndorserCountStep,
EndorserDialog
EndoｒserDirection,
EndorserFont,
EndorserOffset,
EndorserString
FadingCompensation ○Valid ①PixelType "0 - Black & White"
②Threshold "-2"
FileCounterEx ○Valid ScanTo "0 - File"
N/A Disabled. ①MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
②MultiStreamFileNameMode "1 - ON"
FileCounterEx1 ○Valid ①MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
FileCounterEx2 ②MultiStreamFileNameMode "1 - ON"
FileCounterEx3
FileName ○Valid ScanTo "0 - File"
N/A Disabled. ①MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
②MultiStreamFileNameMode "1 - ON"
FileName1 ○Valid ①MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
FileName2 ②MultiStreamFileNameMode "1 - ON"
FileName3
FileType ○Valid ScanTo "0 - File"
Filter N/A Disabled. CharacterExtraction "True"
N/A Disabled. PixelType "2 - RGB"
N/A Disabled. SimpleSlicePatternRemoval "True"
FilterSaturationSensitivity ○Valid Filter "5 - Saturation"
FrontBackDetection N/A Disabled. AutoProfile "1 - Enabled"
N/A Disabled. DivideLongPage "True"
N/A Disabled. Endorser "True"
N/A Disabled. FrontBackMergingEnabled "True"
N/A Disabled. JobControl "1 - Include and Continue" –
"4 - Exclude and Stop”
○Valid PaperSupply "2 – ADF(Duplex)”
N/A Disabled. PixelType "4 - SwitchByCodeSheet "
FrontBackMergingEnabled N/A Disabled. AutoProfile "1 - Enabled"
N/A Disabled. DivideLongPage "True"
N/A Disabled. MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
FrontBackMergingLocation ○Valid FrontBackMergingEnabled "True"
FrontBackMergingRotation
FrontBackMergingTarget
FrontBackMergingTargetMode ○Valid ①FrontBackMergingEnabled "True"
②FrontBackMergingTarget "1 - Short"
"2 - Long"
FrontBackMergingTargetSize ○Valid ①FrontBackMergingEnabled "True"
②FrontBackMergingTarget "1 - Short"
"2 - Long"
③ "1 - Custom
FrontBackMergingTargetMode

329
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
Gamma N/A Disabled. AutoBright "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
N/A Disabled. ①PixelType "0 - Black & White"
②Threshold "-2" "-1"
N/A Disabled. SimpleSlicePatternRemoval "True"
GammaFile ○Valid Gamma "3 - Gamma Pattern File"
Halftone ○Valid PixelType "0 - Black & White"
○Valid CompressionType "0 - No Compress"
HalftoneFile ○Valid Halftone "5 - Dither Pattern File"
Highlight N/A Disabled. AutoBright "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
N/A Disabled. Gamma "1 - Soft"
"2 - Sharp"
"3 - Gamma Pattern File"
"5 - Bright"
"6 - Standard"

○Valid PixelType "2 - RGB"

N/A Disabled. ①PixelType "0 - Black & White"
②Threshold "-2" "-1"
○Valid ①Gamma "4 - Custom"(FUJITSU TWAIN32
Driver only)
②PixelType "1 - Grayscale"

Indicator ○Valid ShowSourceUI “False”

JobControl N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
N/A Disabled. ①PaperSupply "0 - Flatbed"
"3 - ADF(BackSide)"
②JobControlMode "0 - Special Document"
N/A Disabled. ①PaperSupply "0 - Flatbed"
"3 - ADF(BackSide)"
(FUJITSU TWAIN32 Driver only)
②JobControlMode “1 - Patch Code Document”
(FUJITSU TWAIN32 Driver only)
JobControlMode N/A Disabled. JobControl "0 - None"
JpegQuality ○Valid ①ScanTo "0 - File"
②FileType "3 - JPEG"
"4 - PDF"
"5 - Multipage PDF"
○Valid ①ScanTo "0 - File"
②FileType "1 - TIFF", "2 - Multipage TIFF"
③CompressionType “5 - JPEG”, “6 - Old JPEG”

330
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
LengthDetection N/A Disabled. AutoProfile "1 - Enabled”
N/A Disabled. DivideLongPage "True"
N/A Disabled. FrontBackMergingEnabled "True"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

LongPage ○Valid PaperSize "99 - Custom"

N/A Disabled. PaperSupply "0 - Flatbed"
"3 - ADF(BackSide)" (FUJITSU
TWAIN32 Driver only)
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

ManualFeedMode N/A Disabled. PaperSupply "0 - Flatbed"

MultiFeed N/A Disabled. DivideLongPage "True"
N/A Disabled. ManualFeedMode "1 - ON"
"2 - Hardware Setting" Manual Feed
Mode is selected in accordance with
the setting on the scanner
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

MultiFeedModeChangeSize ○Valid MultiFeed "1 - Mode0"

"2 - Mode1"
"4 - Mode3"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

MultiFeedNotice N/A Disabled. MultiFeed “0 - None"

"1 - Mode1"(FUJITSU TWAIN32
Driver only) "
MultiStreamDefaultValueMode ○Valid MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
MultiStreamFileNameMode ○Valid MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
NoiseRejection N/A Disabled. PaperSupply 4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

○Valid ①PixelType "0 - Black & White"

②Threshold "-2"

331
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
NoiseRemoval ○Valid ①PixelType "0 - Black & White"
②Threshold "0"
Orientation N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

Outline N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"

"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
Outline "0 - None" ○Valid PixelType "0 - Black & White"
"1 - Outline Emphasis Low"
"2 - Outline Emphasis Mid"
"3 - Outline Emphasis High"
"4 - Outline Smooth"
"5 - Edge Extract"
Outline "0 - None" ○Valid PixelType "2 - RGB"
"1 - Outline Emphasis Low"
"2 - Outline Emphasis Mid"
"3 - Outline Emphasis High"
"5 - De-Screen Level 1"
"6 - De-Screen Level 2"
"7 - De-Screen Level 3"
"8 - De-Screen Level 4"
OverScan N/A Disabled. AutoBorderDetection "True"
N/A Disabled. AutoProfile "1 - Enabled"
N/A Disabled. Deskew "0 - Edge”, “1 - Documents"
N/A Disabled. DivideLongPage "True"
N/A Disabled FrontBackMergingEnabled "True"
N/A Disabled. LengthDetection "1 - LengthBlack”
"2 - LengthBlackOVS"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
N/A Disabled. UndefinedScanning "True"
Overwrite ○Valid ScanTo "0 - File"
PaperProtection N/A Disabled. ManualFeedMode "1 - ON"
"2 - Hardware Setting" Manual Feed
Mode is selected in accordance with
the setting on the scanner
N/A Disabled. PaperSupply "0 - Flatbed"

332
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
PaperSize N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
PaperSize N/A Disabled AutoProfile "1 - Enabled"
"22 - 8.5 x 34 inch " – "27 - 8.5
x 220inch "
"31 - 12 x 34inch" – "32 - 12 x
125inch"
"34 - 12 x 106.3inch"
- "39 - 12 x 240inch"
PaperSize N/A Disabled FrontBackMergingEnabled "True"
"23 - 8.5 x 106.3 inch " – "27 -
8.5 x 220inch "
"32 - 12 x 125inch"
"34 - 12 x 106.3inch"
- "39 - 12 x 240inch"
PaperSize N/A Disabled ①Resolution More than "1 - 200 x 200dpi [dpi]"
"39 - 12 x 215inch" ②HwMoireReductionMode "1 - Speed"
PaperSize N/A Disabled HwMoireReductionMode "2 - Image Quality"
"36 - 12 x 215inch" – "39 - 12 x
240inch"
PaperSize N/A Disabled ①Resolution More than "1 - 200 x 200dpi [dpi]"
"32 - 12 x 125inch" ②HwMoireReductionMode "2 - Image Quality"
"35 - 12 x 160inch"
PaperSupply N/A Disabled AutoProfile "1 - Enabled"
"4 - ADF(CarrierSheet Spread
A3) "– "49 - ADF(CarrierSheet
Clipping Duplex Custom)
PaperSupply N/A Disabled. DivideLongPage "True"
"0 - Flatbed" "4 -
ADF(CarrierSheet Spread A3) "–
"49 - ADF(CarrierSheet
Clipping Duplex Custom) "
PaperSupply N/A Disabled FrontBackMergingEnabled "True"
"0 - Flatbed" "1 - ADF" "3 -
ADF(BackSide) "
"4 - ADF(CarrierSheet Spread
A3) "– "49 - ADF(CarrierSheet
Clipping Duplex Custom) "
PatchCodeDetection N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

PatchCodeDirection ○Valid PatchCodeDetection "True"

PatchCodeType

333
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
PatternRemoval N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

○Valid ①PixelType "0 - Black & White"

②Threshold "-2"
PixelType- "0 - Black&White" N/A Disabled. FileType "3 - JPEG"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

PixelType N/A Disabled. ①ScanTo "0 - File"

- "1 - Grayscale" ②FileType "1 - TIFF", "2 - Multipage TIFF"
③CompressionType "1 - CCITT G3(1D)"
"2 - CCITT G3(2D) KFactor = 2"
"3 - CCITT G3(2D) KFactor = 4"
"4 - CCITT G4"

N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"

"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
PixelType N/A Disabled. AutoProfile "1 - Enabled"
- "3 - Automatic" ○Valid CompressionType "0 - No Compress"
N/A Disabled. DivideLongPage "True"
PixelType N/A Disabled. AutomaticSenseMedium "True"
- "4 - SwitchByCodeSheet" N/A Disabled. AutoProfile "1 - Enabled"
N/A Disabled. DivideLongPage "True"
○Valid FrontBackMergingEnabled "False"
○Valid JobControl "0 - None"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
○Valid ScanMode "0 - Normal Scan"
PreFiltering ○Valid ①PixelType "0 - Black & White"
②Threshold "0"
PunchHoleRemoval N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Spread A3)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"

PunchHoleRemovalMode ○Valid PunchHoleRemoval "1 - White”

"2 - Background color"

334
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
RegionLeft N/A Disabled. AutoProfile "1 - Enabled"
RegionLength N/A Disabled. DivideLongPage "True"
RegionTop N/A Disabled FrontBackMergingEnabled "True"
RegionWidth
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
Report N/A Disabled. MultiStreamMode "1 – 2 MultiImage"”2 – 3 MultiImage”
ReportFile ○Valid Report "2 - File"
"3 - Display+File"
Resolution - "9 - 1200x1200" N/A Disabled FrontBackMergingEnabled "True"
Reverse N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
Rotation N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

Rotation "0 - None" N/A Disabled. AutoProfile "1 - Enabled"

"0 - R90"
"0 - R180"
"0 - R270"
Rotation - "4 - Automatic" N/A Disabled. DivideLongPage "True"
N/A Disabled FrontBackMergingEnabled "True"
ScanContinue N/A Disabled. DivideLongPage "True"
ScanContinueMode N/A Disabled. ScanContinue "False"
ScanCount N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

ScanMode N/A Disabled. AutoProfile "1 - Enabled"

N/A Disabled. DivideLongPage "True"
N/A Disabled FrontBackMergingEnabled "True"
N/A Disabled. MultiStreamMode "1 – 2 MultiImage""2 – 3 MultiImage"
N/A Disabled. PaperSupply "0 - Flatbed"
"4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

335
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
ScanTo - “2 - Raw Image N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
Handle” "5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
ScanTo - “2 - Raw Image N/A Disabled. MultiStreamMode "1 – 2 MultiImage""2 – 3 MultiImage"
Handle”
SDTCSensitivity N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

○Valid Threshold "0"

SEE ○Valid ①AutoSeparation “0 - OFF”
②CompressionType "0 - No Compress "
③Halftone “1 - Dither Pattern 0"
"2 - Dither Pattern 1"
"3 - Dither Pattern 2"
"4 - Dither Pattern 3"
"5 - Dither Pattern Fil"
"6 - Error Diffusion"
④PixelType "0 - Black & White"
SelectOutputSize ○Valid AutoBorderDetection "True"
N/A Disabled. AutoProfile "1 - Enabled"
Shadow N/A Disabled. AutoBright "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
N/A Disabled. Gamma "1 - Soft"
"2 - Sharp"
"3 - Gamma Pattern File"
"5 - Bright"
"6 - Standard"
○Valid PixelType "2 - RGB"
N/A Disabled. ①PixelType "0 - Black & White"
②Threshold "-2" "-1"
○Valid ①Gamma "4 - Custom"(FUJITSU TWAIN32
Driver only)
②PixelType "1 - Grayscale"
Sharpness N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

N/A Disabled. ①PixelType "0 - Black & White"

②Threshold "-2" "-1"
N/A Disabled. SimpleSlicePatternRemoval "True"

336
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
Sharpness ○Valid ①PixelType "0 - Black & White"
"0 - None" ②Threshold “0”
"1 - Emphasis Low"
"2 - Emphasis Mid"
"3 - Emphasis High"
"5 - Smoothing Level 1"
"6 - Smoothing Level 2"
"7 - Smoothing Level 3"
"8 - Smoothing Level 4"
Sharpness ○Valid ①PixelType "0 - Black & White"
"0 - None" ②Threshold “1 to 255”
"1 - Emphasis Low"
"2 - Emphasis Mid"
"3 - Emphasis High"
"4 - Edge Extract"
"5 - Smoothing Level 1"
"6 - Smoothing Level 2"
"7 - Smoothing Level 3"
"8 - Smoothing Level 4"
Sharpness ○Valid PixelType "1 - Grayscale" "2 - RGB"
"0 - None"
"1 - Emphasis Low"
"2 - Emphasis Mid"
"3 - Emphasis High"
"5 - De-Screen Level 1"
"6 - De-Screen Level 2"
"7 - De-Screen Level 3"
"8 - De-Screen Level 4"
ShowSourceUI N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
SimpleSlicePatternRemoval ○Valid ①PixelType "0 - Black & White"
②ScanMode "0 - Normal Scan"
③Threshold “1 to 255”
SkipBlackPage N/A Disabled. BlankPageSkipMode “0 - Sensitivity” (for PaperStream IP
(TWAIN) driver)
N/A Disabled. PaperSupply “4 - ADF(CarrierSheet Spread A3)”
“5 - ADF(CarrierSheet Spread DL)”
“6 - ADF(CarrierSheet Spread B4)”
“7 - ADF(CarrierSheet Clipping)”
SkipWhitePage N/A Disabled. BlankPageSkipMode “0 - Sensitivity” (for PaperStream IP
(TWAIN) driver)
N/A Disabled. PaperSupply “4 - ADF(CarrierSheet Spread A3)”
“5 - ADF(CarrierSheet Spread DL)”
“6 - ADF(CarrierSheet Spread B4)”
“7 - ADF(CarrierSheet Clipping)”

337
Property Conditions (property values) which make the property on the left valid or invalid
Valid / Invalid Property Value
Smoothing ○Valid ①PixelType "0 - Black & White"
②Threshold "0"
sRGB N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
○Valid PixelType "2 - RGB"
SynchronizationDigitalEndorser ○Valid ①DigitalEndorser "True"
②Endorser "True"
Threshold ○Valid ①Halftone "0 - None"
②PixelType "0 - Black & White"
③CompressionType "0 - No Compress"(FUJITSU
TWAIN32 Driver only)
ThresholdCurve ○Valid ①PixelType "0 - Black & White"
②Threshold "0"
UndefinedScanning N/A Disabled. AutoProfile "1 - Enabled”
N/A Disabled. DivideLongPage "True"
N/A Disabled FrontBackMergingEnabled "True"
N/A Disabled. LengthDetection "1 - LengthBlack”
“2 - LengthBlackOVS”
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"
"10 - ADF(CarrierSheet Clipping)" –
"49 - ADF(CarrierSheet Clipping
Duplex Custom)"
VerticalLineReduction ○Valid AutoBorderDetection "True"
N/A Disabled. DivideLongPage "True"
N/A Disabled. PaperSupply "4 - ADF(CarrierSheet Spread A3)"
"5 - ADF(CarrierSheet Spread DL)"
"6 - ADF(CarrierSheet Spread B4)"
"7 - ADF(CarrierSheet Clipping)"

Note: When the SourceCurrentScan property is set to "True," all properties are invalid except the
ScanTo, FileType, FileName, CompressionType, ScanCount, ShowSourceUI, SilentMode,
FileCounterEx, JpegQuality, Indicator, Overwrite, AIQCNotice and MultiFeedNotice properties.

338
3.3 Property Priority Order
There are the following cases where only one property (effect) becomes valid (others are all
invalid) even if valid values are set on multiple properties (effects).
The following indicates that the properties on the right of an inequality sign take precedence over
the properties on the left.
Note: Properties which are not supported by some devices are not taken into consideration in the
following table. (* Refer to "Reference Manual (Separate Volume).")

- BackgroundColor < OverScan < Deskew < AutoBorderDetection < UndefinedScanning < LengthDetection
<FrontBackMergingEnabled < DivideLongPage < AutoProfile

- BackgroundColor < PunchHoleRemoval

- PixelType "0 - Black & White" < Threshold "0" < Halftone < SEE < AutoSeparation < PixelType "1 - Grayscale,”
"2 - RGB"

- PixelType "1 - Grayscale", "2 - RGB" < CompressionType "1 - CCITT G3(1D)," "2 - CCITT G3(2D) KFactor = 2,"
"3 - CCITT G3(2D) KFactor = 4," "4 - CCITT G4"
(Only when the FileType property is set to "1 - TIFF" or "2 - Multipage TIFF.")

- PixelType “0 - Black&White”,"1 - Grayscale" < PaperSupply "4 - ADF(CarrierSheet Spread A3)","5 -

ADF(CarrierSheet Spread DL)","6 - ADF(CarrierSheet Spread B4)","7 - ADF(CarrierSheet Clipping)"

3.4 Valid Specifications When Using the Image Processing Software Option
Property
Refer to "Reference Manual (Separate Volume)"
Method
All methods are valid except the SetCapability and GetCapability methods.
Event
All events are valid.

339
3.5 How to Change the Property Default Values
The following describes how to change the property default values without modifying the
application that has been already developed.
Adding the commands below to the fiscn.ini file in the Windows directory (with C:\Windows as the
default) enables the customization. Only include the properties for the default values that you
wish to customize.

[Default]
AdjustRGB=0
AdjustRGBR=128
AdjustRGBG=128
AdjustRGBB=128
ADTCThreshold=83
AIQCNotice=0
AutoBorderDetection=0
AutoBright=0
AutomaticColorBackground=0
AutomaticColorSensitivity=0
AutomaticRotateMode=0
AutomaticSenseMedium=0
AutoProfile=0
AutoProfileSensitivity=3
AutoSeparation=0
Background=0
BackgroundColor=0
BackgroundSmoothing=0
BackgroundSmoothness=5
BackgroundThreshold=50
BarcodeDetection=0
BarcodeDirection=2
BarcodeMaxSearchPriorities=1
BarcodeNotDetectionNotice=0
BarcodeRegionLeft=0
BarcodeRegionLength=0
BarcodeRegionTop=0
BarcodeRegionWidth=0
BarcodeType=511
Binding=0
BlankPageIgnoreAreaSize=16
BlankPageNotice=0
BlankPageSkip=0
BlankPageSkipMode=0
BlankPageSkipTabPage=0
Brightness=128
CarrierSheetClippingMode=2
CharacterExtraction=0
CharacterExtractionMethod=7
CharacterThickness=5
CloseSourceUI=0
ColorReproduction=0
ColorReproductionBrightness=128
ColorReproductionContrast=128
ColorReproductionCustomGamma=1.0
ColorReproductionHighlight=255
ColorReproductionShadow=0

340
CompressionType=4
Contrast=128
CropMarginSize=0.0
CropPriority=0
CustomGamma=2.2
CustomPaperLength=1
CustomPaperWidth=1
CustomResolution=300
Deskew=2
DeskewBackground=1
DeskewMode=0
DigitalEndorser=0
DigitalEndorserCountDirection=0
DigitalEndorserCounter=0
DigitalEndorserCountStep=1
DigitalEndorserDirection=0
DigitalEndorserString=ABCDEFG%05ud
DigitalEndorserXOffset=0
DigitalEndorserYOffset=0
DivideLongPage=0
DTCSensitivity=50
EdgeFiller=0
EdgeFillerBottom=0
EdgeFillerLeft=0
EdgeFillerRight=0
EdgeFillerTop=0
EdgeRepair=0
Endorser=0
EndorserCountDirection=0
EndorserCounter=0
EndorserCountStep=1
EndorserDialog=0
EndorserDirection=1
EndorserFont=0
EndorserOffset=0
EndorserString=ABCDEFG%05ud
FadingCompensation=0
FileCounterEx=1
FileCounterEx1=1
FileCounterEx2=1
FileCounterEx3=1
FileName=C:\Program Files\FiScnSDK23\Image#####
FileName1=C:\Program Files\FiScnSDK23\Image1_#####
FileName2=C:\Program Files\FiScnSDK23\Image2_#####
FileName3=C:\Program Files\FiScnSDK23\Image3_#####
FileType=1
Filter=0
FilterSaturationSensitivity=50
FrontBackDetection=0
FrontBackMergingEnabled=0
FrontBackMergingLocation=3
FrontBackMergingRotation=0
FrontBackMergingTarget=0
FrontBackMergingTargetMode=1
FrontBackMergingTargetSize=1
Gamma=0

341
GammaFile=C:\Program Files\FiScnSDK23\gamma.gma
Halftone=0
HalftoneFile=C:\Program Files\FiScnSDK23\halftone.dth
HwAutomaticDeskew=1
HwCompression=0
HwMoireReductionMode=3
Highlight=230
Indicator=1
JobControl=0
JobControlMode=0
JpegQuality=3
LengthDetection=0
LongPage=0
ManualFeedMode=2
Mirroring=0
MultiFeed=0
MultiFeedModeChangeSize=0.0
MultiFeedNotice=0
MultiStreamDefaultValueMode=0
MultiStreamFileNameMode=0
MultiStreamMode=0
NoiseRejection=0
NoiseRemoval=0
Orientation=0
Outline=0
OverScan=0
Overwrite=2
PaperProtection=3
PaperSize=1
PaperSupply=1
PatchCodeDetection=0
PatchCodeDirection=1
PatchCodeType=303
PatternRemoval=1
PixelType=0
PreFiltering=0
PunchHoleRemoval=0
PunchHoleRemovalMode=0
RegionLeft=0
RegionLength=0
RegionTop=0
RegionWidth=0
Report=0
ReportFile=C:\Program Files\FiScnSDK23\ReportFile.txt
Resolution=2
Reverse=0
Rotation=0
ScanContinue=0
ScanContinueMode=0
ScanCount=-1
ScanMode=0
ScanTo=0
SDTCSensitivity=2
SEE=0
SelectOutputSize=0
Shadow=10

342
Sharpness=0
ShowSourceUI=1
SilentMode=0
SimpleSlicePatternRemoval=0
SkipBlackPage=0
SkipWhitePage=0
Smoothing=0
SourceCurrentScan=0
sRGB=0
StapleDetection=1
SynchronizationDigitalEndorser=0
Threshold=128
ThresholdCurve=0
TwainDS= RICOH fi-8040
TwainDSAnyPort=0
UndefinedScanning=0
Unit=0
VerticalLineReduction=0

If the values set are not enabled by the properties, no change will be made to the default values.
Changes in the default values are enabled after the application is launched following the
modification of fiscn.ini. Altering the values of fiscn.ini while the application is running will not
change the default values.

343
3.6 Bitmap Class Conversion Libraries for Visual Basic / Visual C#

Libraries are provided in order to convert the image data, which is passed from the SDK in the
ScanToDibEx event when the ScanTo property is set to "1 - Dib Handle," or in the ScanToRawEx
event when the ScanTo property is set to “2 - Raw Image Handle”, into the Bitmap class.
To use the libraries, use “FiScnUtildN20.dll” or “FiScnUtildN4x.dll.”
“FiScnUtildN20.dll” is a DLL for applications that support .NET Framework 2.0 to 3.5, and
“FiScnUtildN4x.dll” is a DLL for applications that support .NET Framework 4.x.
The libraries only support applications created in Visual Basic/Visual C#.
For the usage of the libraries, refer to the ScanToDibEx or ScanToRawEx event in the Visual Basic or
Visual C# sample.

3.6.1 Preparation for using DLL

The following explains how to create an application that supports .NET Framework 4.0 with Visual
Studio 2015 as an example.

Caution
If you create an application on another development environment, replace the following procedure with the one
suitable for the development environment you actually use accordingly.

1. Select the [PROJECT] menu - [Add Reference…].

344
2. Select [Extensions] under [Assemblies], then select “FiScnUtildN4x.DLL”, and click the [OK]
button.

3. Create and build an application.

Caution
To create an application that supports .NET Framework 2.0 to 3.5, use “FiScnUtildN20.dll”.
"FiScnUtildN20.dll" and "FiScnUtildN4x.dll" cannot be used at the same time.

345
3.6.2 Constructors
Feature
Initialize the new ConvH2BM class instance.

Coding Style
ConvH2BM ()

Parameters
N/A

Return Values
N/A

3.6.3 Properties

3.6.3.1 ErrorCode .... error information acquisition

Feature
Gets error information when GetBitmapFromDIB/GetBitmapFromRAW methods end
abnormally.

Coding Style
FiScnUtildN.ConvH2BM.ErrorCode [ = Long ]

Default
No error 0x00000000

Error List
Error Number Countermeasures
0x00000000 No error －
0x00000001 Invalid parameter The specified parameter is invalid. Check the
parameter.
0x00000002 Insufficient memory Reduce the scan image size and resolution, and try
again.
0xFFFFFFFF Internal error Restart the application and try again. If the error
persists, contact RICOH Support.

Caution
The error information that this property holds is cleared at the following timing:
-When the GetBitmapFromDIB method is called
-When the GetBitmapFromRAW method is called

346
3.6.4 Methods

3.6.4.1 GetBitmapFromDIB .... Converting the DIB handle into the Bitmap class

Feature
Converts the image data, which is indicated by the DIB handle that is passed from the SDK
when the ScanToDibEx event occurred, into the Bitmap class format .
.

Coding Style
FiScnUtildN.ConvH2BM.GetBitmapFromDIB( ByVal hDib As Long ) [ = Bitmap]

Parameters
hDib DIB (Device Independent Bitmap) handle

Return Values
Bitmap class Normal end
NULL Error

Cautions
Release the Bitmap class returned as the return value of this function using the
Bitmap.Dispose() method after the Bitmap class is no longer needed.
When an error occurs, details of the error are recorded to the error code. Refer to the
FiScnUtildN.ConvH2BM.ErrorCode property to obtain the error code. Note that the error
code is initialized when this method is called.

347
3.6.4.2 GetBitmapFromRAW
.... Converting the image data handle into the Bitmap class

Feature
Converts the image data, which is indicated by the image data handle that is passed from
the SDK when the ScanToRawEx event occurred, into the Bitmap class format .

Coding Style
FiScnUtildN.ConvH2BM.GetBitmapFromRAW(ByVal Resolution As Integer,
ByVal ImageWidth As Long,
ByVal ImageLength As Long,
ByVal BitPerPixel As Integer,
ByVal CompressionType As Integer,
ByVal Size As Long,
ByVal hRaw As Long ) [ = Bitmap]

Parameters
Resolution Resolution (dpi)
ImageWidth Image width (pixel)
ImageLength Image length (pixel)
BitPerPixel Number of bits per pixel
(Binary (Black and White): 1, Grayscale: 8,
RGB color: 24)
CompressionType Compression type
(No compression: 0, MH compression: 1,
MR compression K Factor 2: 2,
MR compression K Factor 4: 3, MMR compression: 4,
JPEG compression: 5)
Size Data size
hRaw Image data handle (pointer)

Return Values
Bitmap class Normal end
NULL Error

Cautions
Release the Bitmap class retuned as the return value of this function using the
Bitmap.Dispose() method after the Bitmap class is no longer needed.
The BitPerPixel and the CompressionType support the values written in “Parameters“ only.
Even if a data compression format is specified for the CompressionType property, this
function decodes the image data to uncompressed data. Note that the decoding may
degrade the processing perfomance.
To specify “JPEG“ for the CompressionType, PaperStream IP driver or Fujitsu TWAIN driver
must be installed.
When an error occurs, details of the error are recorded to the error code. Refer to the
FiScnUtildN.ConvH2BM.ErrorCode property to obtain the error code. Note that the error
code is initialized when this method is called.

348
3.7 Explanation of Terms Used
ASPI (Advanced SCSI Programming Interface)
Advanced SCSI interface driver. One of the SCSI interface drivers which has a general
application interface.

Capability
A function which is used to communicate with the source (driver) by the TWAIN interface.

TWAIN
A standard specification for communications between a software application and an image
input device such as an image scanner.

Imprinter (Endorser)
A type of printer mechanism and an optional device for the fi Series image Scanners. Image
scanners equipped with this optional device are able to print numbers to identify documents
before and after the scan. (Some image scanners do not support this option)

Gamma adjustment
An adjustment which brightens or darkens the image sensor output which is proportional
with the light reflected from the document.

Image Processing Software Option

An optional software product which provides high quality image processing at low price for
image scanners which is not supported by image processing boards.

Image processing board

An optional board which provides high speed and high quality image processing on scanned
image data before transmitting it to an image processing application. (Some image scanners
do not support this option)

Error diffusion method

A pseudo halftone method which balances high gradation quality and high resolution quality,
by rearranging black pixels in their density order based upon the sum total of density of
focused pixels and surrounding pixels, and the relationship between adjacent pixels.

Contrast
The ratio between the brightest part and darkest part of an image on the document. Contrast
is high where black and white are distinct.

Silent mode
A mode which does not issue notifications such as error messages.

Background adjustment
An automatic contrast adjustment applied when scanning a document whose background is
not white.

349
Automatic separation
A process which captures lines in black and white, and images in halftone by distinguishing
line areas (characters) and image areas (photos) at scanning.

Jam
A state that the document clogs up at the middle of the transfer route in an image scanner.

Job control
Control of a process which is performed when a special document (document of a particular
form) is detected.

Threshold
A threshold value used as criteria to distinguish black and white on a black and white image.

Selectable edge enhancement

A process to scan both the line areas (characters) and image areas (photos) using halftone
and to enhance line areas only.

Source (data source)

The control section of image scanners such as "TWAIN driver."

Source manager (data source manager)

Indicates TWAIN.DLL or TWAIN_32.DLL. An application and a source (TWAIN driver)
communicate through this source manager.

Multi-feed (double-feed)
A phenomenon where two or more pages of a document are fed together.

Halftone process
A process to express pseudo gray using black and white.

Dropout color
Colors of characters or images which are printed on a document; though they are visible to
the human eye, they do not appear on the image scanned by an image scanner.

Brightness
Degree of luminosity on the image.

Outline smoothing
This process removes rough lines and will smooth curved lines in the image.

350
Index
BarcodeRegionTop............................................... 36
BarcodeRegionWidth............................................ 37
A BarcodeType ........................................................ 38
Binding ................................................................. 39
Bitmap class conversion libraries ....................... 344
AboutBox ............................................................ 230
Black and white inversion / Color inversion
Acquire Automatic Image Quality Checker
configuration .................................................. 191
results .............................................................. 14
Blank page skip settings for index-tabbed
ADF .................................................................... 168
pages ............................................................... 45
ADF(CarrierSheet A3) ........................................ 168
BlankPageIgnoreAreaSize ................................... 40
ADF(CarrierSheet B4) ........................................ 168
BlankPageNotice .................................................. 41
ADF(CarrierSheet).............................................. 169
BlankPageResult .................................................. 42
ADF/FB automatic switching................................. 20
BlankPageSkip ..................................................... 43
Adjusting the brightness of each color (RGB)
BlankPageSkipMode ............................................ 44
separately .......................................................... 8
BlankPageSkipTabPage....................................... 45
AdjustRGB .............................................................. 8
BMP.................................................................... 113
AdjustRGBB ........................................................... 9
Bottom edge area setting (edge filler)................... 83
AdjustRGBG ......................................................... 10
Brightness ............................................................ 46
AdjustRGBR ......................................................... 11
Brightness setting ................................................. 46
ADTCThreshold .................................................... 12
AIQCNotice........................................................... 13
AIQCResult........................................................... 14
Applying a profile automatically ............................ 21 C
Auto Color Detection .......................................... 113
AutoBorderDetection ............................................ 15 CancelScan ........................................................ 231
AutoBright ............................................................. 16 Capability acquisition .......................................... 236
Automatic (advanced) binary threshold setting ..... 12 Capability configuration ...................................... 263
Automatic (simple) binary dispersion value ........ 198 Capability configuration notification .................... 284
Automatic Image Quality Checker setting ............. 13 CarrierSheetClippingMode ................................... 47
Automatic Skew Correction ................................ 131 Character string .................................................... 76
AutomaticColorSensitivity ..................................... 18 Character thickness setting .................................. 50
AutomaticRotateMode .......................................... 19 CharacterExtraction .............................................. 48
AutomaticSenseMedium ....................................... 20 CharacterExtractionMethod .................................. 49
AutoProfile ............................................................ 21 CharacterThickness.............................................. 50
AutoProfileSelection ........................................... 275 Chromatic dropout color sensitivity setting ......... 117
AutoProfileSensitivity ............................................ 22 ClearPage .......................................................... 232
AutoSeparation ..................................................... 23 CloseScanner ..................................................... 234
CloseSourceUI ..................................................... 51
ColorReproduction................................................ 52
B ColorReproductionBrightness............................... 53
ColorReproductionContrast .................................. 54
ColorReproductionCustomGamma ...................... 55
Background .......................................................... 24
ColorReproductionHighlight.................................. 56
Background color (black or white background)
ColorReproductionShadow................................... 57
setting .............................................................. 25
CompressionType ................................................ 58
Background color smoothing setting ..................... 26
Continuous scanning method ............................. 194
Background color smoothness setting .................. 27
Contrast ................................................................ 60
Background color threshold setting ...................... 28
Contrast setting .................................................... 60
Background tracking setting ................................. 24
Converting into Bitmap class format ........... 347, 348
BackgroundColor .................................................. 25
ConvH2BM ......................................................... 346
BackgroundSmoothing ......................................... 26
Counter default ..................................................... 90
BackgroundSmoothness ...................................... 27
Counter default value ........................................... 73
BackgroundThreshold .......................................... 28
Counter print direction .......................................... 94
Ballpoint pen filtering setting ............................... 179
Counter print font .................................................. 95
Barcode detection notification............................. 276
Counter step direction .................................... 72, 89
Barcode detail detection notification ................... 277
CropMarginSize .................................................... 61
Barcode detection setting ..................................... 29
CropPriority .......................................................... 62
Barcode direction.................................................. 30
Custom document width setting ........................... 66
Barcode maximum detection count ...................... 31
CustomGamma .................................................... 63
Barcode type ........................................................ 38
CustomPaperLength............................................. 64
BarcodeDetection ................................................. 29
CustomPaperWidth .............................................. 66
BarcodeDirection .................................................. 30
CustomResolution ................................................ 67
BarcodeMaxSearchPriorities ................................ 31
Custom-sized document length setting................. 64
BarcodeNotDetectionNotice ................................. 32
BarcodeRegionLeft ............................................... 33
BarcodeRegionLength .......................................... 34

351
 Endorser/imprinter step count setting ................... 92
D Endorser/imprinter string setting ........................... 97
EndorserCountDirection ....................................... 89
Data compression type setting ............................. 58 EndorserCounter .................................................. 90
Data source selection process.................... 259, 260 EndorserCountStep .............................................. 92
Density curve configuration (when automatic EndorserDialog ..................................................... 93
binarization is specified)................................. 219 EndorserDirection ................................................. 94
De-Screen Level ................................................. 160 EndorserFont ........................................................ 95
Deskew................................................................. 68 EndorserOffset ..................................................... 96
DeskewBackground.............................................. 69 EndorserString ..................................................... 97
DeskewMode ........................................................ 70 Endoser/imprinter counter default setting ............. 90
DetectBarcode .................................................... 276 Error code and how to fix error ........................... 316
DetectBarcodeDetail........................................... 277 Error diffusion method ........................................ 128
Detecting document feeding errors ..................... 165 Error information acquisition ......................... 99, 346
DetectJobSeparator............................................ 279 ErrorCode ..................................................... 99, 346
DetectPatchCode ............................................... 280 Events ................................................................ 273
Device (scanner) status confirmation ......... 257, 258 Examples and notation conventions (events) ..... 274
Digital endorser character string setting ............... 76 Examples and notation conventions (methods)227, 229
Digital endorser counter default value setting ....... 73 Explanation of terms used .................................. 349
Digital endorser counter step direction setting ...... 72
Digital endorser counter step value setting ........... 74
Digital endorser output direction setting ............... 75
Digital endorser output start position (X offset)
F
setting .............................................................. 77
Digital endorser output start position (Y offset) Fading compensation setting .............................. 100
setting .............................................................. 78 FadingCompensation ......................................... 100
Digital endorser setting ......................................... 71 FeederLoaded .................................................... 235
DigitalEndorser ..................................................... 71 File format setting ............................................... 113
DigitalEndorserCountDirection ............................. 72 File name setting ................................................ 109
DigitalEndorserCounter ........................................ 73 File overwrite setting........................................... 162
DigitalEndorserCountStep .................................... 74 File serial number setting ........................... 101, 105
DigitalEndorserDirection ....................................... 75 FileCounter ......................................................... 101
DigitalEndorserString............................................ 76 FileCounter1 ....................................................... 103
DigitalEndorserXOffset ......................................... 77 FileCounter2 ....................................................... 103
DigitalEndorserYOffset ......................................... 78 FileCounter3 ....................................................... 103
DivideLongPage ................................................... 79 FileCounterEx ..................................................... 105
Document ejection .............................................. 232 FileCounterEx1 ................................................... 107
Document orientation setting .............................. 158 FileCounterEx2 ................................................... 107
Document size setting (fixed size) ...................... 166 FileCounterEx3 ................................................... 107
Dropout color setting .......................................... 115 FileName ............................................................ 109
DTCSensitivity ...................................................... 81 FileName1 .......................................................... 111
Duplex binding direction setting ............................ 39 FileName2 .......................................................... 111
Dust removal mode setting ................................. 157 FileName3 .......................................................... 111
Dynamic Threshold (iDTC) binary sensitivity FileType.............................................................. 113
setting .............................................................. 81 Filter ................................................................... 115
FilterSaturationSensitivity ................................... 117
Flatbed ............................................................... 168
Flatbed support information acquisition .............. 136
E Flip Vertical setting ............................................. 144
FrontBackDetection ............................................ 118
Edge extraction........................................... 159, 160 FrontBackMergingEnabled ................................. 119
Edge filler.............................................................. 82 FrontBackMergingLocation................................. 120
Edge filler repair ................................................... 87 FrontBackMergingRotation ................................. 121
Edge filler setting .................................................. 82 FrontBackMergingTarget .................................... 122
EdgeFiller ............................................................. 82 FrontBackMergingTargetMode ........................... 123
EdgeFillerBottom .................................................. 83 FrontBackMergingTargetSize ............................. 125
EdgeFillerLeft ....................................................... 84
EdgeFillerRight ..................................................... 85
EdgeFillerTop ....................................................... 86
EdgeRepair........................................................... 87
G
Endorser ............................................................... 88
Endorser/imprinter and digital endorser Gamma............................................................... 126
synchronization function ................................ 217 Gamma adjustment setting ................................. 126
Endorser/imprinter print direction setting .............. 94 GammaFile ......................................................... 127
Endorser/imprinter print font setting ...................... 95 GetBitmapFromDIB ............................................ 347
Endorser/imprinter print start position setting ....... 96 GetBitmapFromRAW .......................................... 348
Endorser/imprinter setting .................................... 88 GetCapability ...................................................... 236

352
GetSerialNumber ................................................ 237
GetSIpcTemplateCount ...................................... 238
M
GetSIpcTemplateName ...................................... 240
GetSIpcTemplateSelect ...................................... 241 Manual Feed Mode............................................. 143
GetSourceCount ................................................. 242 ManualFeedMode............................................... 143
GetSourceName ................................................. 244 Memory output ........................................... 289, 290
GetSourceSelect ................................................ 246 Method ............................................................... 229
Getting a page number ....................................... 164 Mirroring ............................................................. 144
Getting the multifeed result ................................. 148 Mode for keeping the default value for each
GetTWAINTemplateCount .................................. 248 image ............................................................. 149
GetTWAINTemplateName .................................. 251 Moire Reduction(Advanced) ............................... 133
GetTWAINTemplateSelect ................................. 252 Multi feed detection setting ................................. 145
Multi Image Output ............................................. 113
MultiFeed............................................................ 145
Multifeed notification setting ............................... 147
H MultiFeedModeChangeSize ............................... 146
MultiFeedNotice ................................................. 147
Halftone .............................................................. 128 MultiFeedResult ................................................. 148
Halftone pattern setting ...................................... 128 MultiStreamDefaultValueMode ........................... 149
HalftoneFile ........................................................ 129 MultiStreamFileNameMode ................................ 151
Highlight ............................................................. 130 MultiStreamMode ............................................... 152
Highlight setting .................................................. 130 MultiStreamPropertySetting................................ 281
HwAutomaticDeskew .......................................... 131
HwCompression ................................................. 132
HwMoireReductionMode .................................... 133
N
NegotiateCapabilities.......................................... 284
I Noise removal setting ......................................... 156
NoiseRejection ................................................... 156
ID card automatic detection setting .................... 118 NoiseRemoval .................................................... 157
Image Processing Software Option238, 240, 241, 264 Notes on a process written in an event handler .. 274
Image quality automatic adjustment setting .......... 16 Notification of the identified forms ...................... 275
Image scanner name acquisition ........................ 134 Notifies whether or not the document is loaded
ImageScanner .................................................... 134 on the ADF..................................................... 235
Indecator ............................................................ 135
Initialization process ........................................... 253
IsExistsFB........................................................... 136
O
Obtaining a scanner serial number ..................... 237
J OCR smoothing / background removal
configuration .................................................. 212
Java samples ...................................................... 315 OpenScanner ..................................................... 253
Job control paper type setting............................. 139 OpenScanner2 ................................................... 255
Job control setting .............................................. 137 Orientation .......................................................... 158
JobControl .......................................................... 137 Outline ................................................................ 159
JobControlMode ................................................. 139 Outline correction setting .................................... 159
JPEG .......................................................... 113, 282 Outline emphasis ................................................ 159
Jpeg compression level setting........................... 140 Outline smoothing....................................... 159, 160
JpegQuality......................................................... 140 Output destination of scanned data .................... 197
Output direction .................................................... 75
OverScan ........................................................... 161
L Overscan setting ................................................ 161
Overwrite ............................................................ 162
Left edge area setting (edge filler) ........................ 84
Left edge configuration (scanning area) ............. 182
Left edge position setting (detection area) ............ 33 P
Length configuration (scanning area) ................. 183
Length setting (detection area) ............................. 34 Page break notification ....................................... 285
LengthDetection ................................................. 141 PageCount ......................................................... 163
List of events ...................................................... 273 PageNumber ...................................................... 164
List of methods ................................................... 227 PagePartition ...................................................... 285
Long page scanning setting ................................ 142 Paper end detection ........................................... 223
LongPage ........................................................... 142 Paper feed method setting ................................. 168
PaperProtection .................................................. 165
PaperSize ........................................................... 166

353
PaperSupply ....................................................... 168 ScanToDib.......................................................... 286
Patch code detection notification ........................ 280 ScanToDibEx ..................................................... 287
Patch code detection .......................................... 173 ScanToFile ......................................................... 288
Patch code direction ........................................... 174 ScanToRaw ........................................................ 289
Patch code type .................................................. 175 ScanToRawEx .................................................... 290
PatchCodeDetection........................................... 173 SDTCSensitivity ................................................. 198
PatchCodeDirection............................................ 174 SEE .................................................................... 199
PatchCodeType .................................................. 175 Selectable edge enhancement configuration ...... 199
Pattern removal setting ....................................... 176 SelectOutputSize ................................................ 200
PatternRemoval .................................................. 176 SelectSource ...................................................... 259
PDF .................................................................... 113 SelectSourceName............................................. 261
Pixel type setting ................................................ 177 Sensitivity level for identifying a form when a
PixelType ............................................................ 177 profile is applied automatically ......................... 22
PreFiltering ......................................................... 179 SetCapability ...................................................... 263
Print settings window display ................................ 93 SetSIpcTemplateSelect ...................................... 264
Priority setting during automatic paper size Setting the properties for each image ................. 281
detection .......................................................... 62 Setting a mode for detecting the orientation of
Profile name acquisition (TWAIN Driver) ............ 251 an image .......................................................... 19
Profile number acquisition (TWAIN Driver) ......... 252 Setting a type of document whose front and
Profile numbers (TWAIN Driver) ......................... 265 back side images are to be merged ............... 122
Profiles total number acquisition (TWAIN Setting an initial value for each serial number
Driver) ............................................................ 248 that will be added to a file name when a file
Progress indicator setting ................................... 135 created from each output image is saved103, 107
Property .................................................................. 7 Setting auto color detection which ignores
Property list............................................................. 1 background color ............................................. 17
Property page ..................................................... 291 Setting continuous scanning............................... 193
Property priority order ......................................... 339 Setting file name acquisition (TWAIN Driver) ..... 251
Punch hole removal mode setting ...................... 181 Setting file number acquisition (TWAIN Driver) .. 252
Punch hole removal setting ................................ 180 Setting file numbers (TWAIN Driver) .................. 265
PunchHoleRemoval ............................................ 180 Setting file total number acquisition (TWAIN
PunchHoleRemovalMode ................................... 181 Driver) ............................................................ 248
Setting for displaying the endorser/imprinter
print settings window when scanning starts . 5, 93
R Setting for dividing long pages ............................. 79
Setting for merging the front and back side
images ........................................................... 119
RegionLeft .......................................................... 182
Setting for the angle to rotate the back side
RegionLength ..................................................... 183
when merging the front and back side
RegionTop .......................................................... 185
images ........................................................... 121
RegionWidth ....................................................... 186
Setting for the way of merging the front and
Relationships between properties....................... 322
back side images ........................................... 120
Report ................................................................. 188
Setting the auto image area separation ................ 23
Report file name configuration ............................ 189
Setting the automatic border detection ................. 15
Report output configuration ................................ 188
Setting the brightness of the color blue when
ReportFile ........................................................... 189
the brightness of each color (RGB) is
Resolution........................................................... 190
adjusted separately............................................ 9
Reverse .............................................................. 191
Setting the brightness of the color green when
Right edge area setting (edge filler) ...................... 85
the brightness of each color (RGB) is
Rotation .............................................................. 192
adjusted separately.......................................... 10
Rotation angle configuration ............................... 192
Setting the brightness of the color red when the
brightness of each color (RGB) is adjusted
separately ........................................................ 11
S Setting the color reproduction............................... 52
Setting the criteria for determining a type of
Samples ............................................................. 294 document whose front and back side
Scan mode setting .............................................. 196 images are to be merged ............................... 123
Scan page count acquisition ............................... 163 Setting the endoser/counter step direction ........... 89
Scan pages configuration ................................... 195 Setting the file name and file counter for a file
Scan resolution setting (custom) .......................... 67 created from each output image .................... 151
Scan with the current value ................................ 213 Setting the file names used for each output
ScanContinue ..................................................... 193 image ............................................................. 111
ScanContinueMode ............................................ 194 Setting the length for the criteria for
ScanCount .......................................................... 195 determining a type of document whose front
ScanMode .......................................................... 196 and back images are to be merged ............... 125
ScannerAvailable................................................ 257 Setting the sensitivity for auto color detection ...... 18
ScanTo ............................................................... 197 Setting whether or not to lock the TWAIN data

354
 source name .................................................. 222
Setting whether to send a barcode detection
T
notification even if a barcode is not detected ... 32
SetTWAINTemplateSelect .................................. 265 Template name acquisition (Image Processing
SetupDataSourceProperties ............................... 266 Software Option) ............................................ 240
Shadow .............................................................. 201 Template number acquisition (Image
Shadow setting ................................................... 201 Processing Software Option) ......................... 241
Sharpness .......................................................... 202 Template number configuration (Image
Sharpness setting ............................................... 202 Processing Software Option) ......................... 264
ShowSourceUI.................................................... 204 Termination process ........................................... 234
Sides undetected during blank page detection ..... 40 Threshold ........................................................... 218
Silent mode configuration ................................... 206 Threshold configuration ...................................... 218
SilentMode.......................................................... 206 ThresholdCurve .................................................. 219
Simple slice binary pattern removal setting ........ 207 TIFF .................................................................... 113
SimpleSlicePatternRemoval ............................... 207 Top edge area setting (edge filler) ........................ 86
Simultaneous setting of paper end Top edge configuration (scanning area) ............. 185
detection/background color/overscan ............ 141 Top edge position setting (detection area) ........... 36
Skew correction .................................................... 68 Total number of templates acquisition (Image
Skip blank page configuration (white pages) ...... 210 Processing Software Option) ......................... 238
Skip blank pages configuration (black pages) .... 208 TWAIN data source configuration ....................... 220
SkipBlackPage ................................................... 208 TWAIN driver ...................................................... 248
SkipWhitePage ................................................... 210 TWAIN driver ...................................................... 251
Smoothing .......................................................... 212 TWAIN driver ...................................................... 252
SoftIPC Template ............................................... 296 TWAIN driver ...................................................... 265
SoftIPC Template ............................................... 296 TWAIN Template ................................................ 296
SourceCurrentScan ............................................ 213 TwainDS ............................................................. 220
Special document ............................................... 137 TwainDSAnyPort ................................................ 222
Special document detection notification (job
control) ........................................................... 279
Specifying a highlight when a color hue is U
prioritized ......................................................... 56
Specifying a shadow when a color hue is Undefined length scan configuration .................. 223
prioritized ......................................................... 57 UndefinedScanning ............................................ 223
Specifying the brightness when a color hue is Unit ..................................................................... 224
prioritized ......................................................... 53 Unit of size (inch/centimeter/pixel) ...................... 224
Specifying the color contrast when a color hue Use examples and conventions (Property) ......... 1, 7
is prioritized...................................................... 54 User interface display ......................................... 204
Specifying the gamma pattern file ...................... 127 User interface display (for configuration) ............ 266
Specifying the gamma value (custom) .................. 63 User interface exit setting ..................................... 51
Specifying the gamma value when a color hue
is prioritized...................................................... 55
Specifying the halftone pattern file...................... 129
Specifying the output size ................................... 200
V
Specifying the paper length to disable
multifeed detection ......................................... 146 Version information dialog box display ............... 230
Specifying the parent application ........................ 172 Vertical line reduction setting .............................. 226
Specifying the size of cropping margins ............... 61 VerticalLineReduction......................................... 226
sRGB .................................................................. 215 Visual Basic samples .......................................... 298
sRGB output ....................................................... 215 Visual C# samples .............................................. 298
Stapled Documents Detection ............................ 216 Visual C++ samples ............................................ 308
StapleDetection .................................................. 216
Starting a scan.................................................... 269
StartScan ............................................................ 269 W
Step count ............................................................ 92
Step value............................................................. 74 Width configuration (scanning area) ................... 186
Stop an Image Scanning .................................... 231 Width setting (detection area)............................... 37
String .................................................................... 97
SynchronizationDigitalEndorser .......................... 217

355
RICOH Scanner Control SDK
Reference Manual

First Edition September 2024

© PFU Limited 2024