P2WW-4310-10ENZ0

fi Series Web API

Version 1.9.0

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
Thank you for purchasing the "fi Series Web API".
This product is provided as an additional component for "RICOH Scanner Control SDK" in
order to easily add the scan functions (scan setting, scanning, uploading a scanned image
securely) to a Web application in JavaScript.
This manual describes the preparations and the development procedure for using the "fi
Series Web API", and describes information about the functions and sample source codes of
the "fi Series Web API".
Make sure that you read the "RICOH Scanner Control SDK Reference Manual" before
reading this manual.

"fi Series Web API" is referred to as a "Web API" in this manual. Refer to "RICOH Scanner
Control SDK Getting Started" for trademarks and abbreviations.

II
<Contents>
1. System Requirements .......................................................................................... 1
1.1 Supported Languages ................................................................................................................ 1
1.2 Supported Models ....................................................................................................................... 1
2. Development Environment .................................................................................. 2

3. Outline and Functions of This Product .............................................................. 2

3.1 Outline of This Product .............................................................................................................. 2
3.2 Functions of This Product ......................................................................................................... 2
4. Components of a Program .................................................................................. 3

5. Install/Uninstall ..................................................................................................... 5
5.1 Install ............................................................................................................................................ 5
5.2 Uninstall ....................................................................................................................................... 5
6. Development Procedure ...................................................................................... 6
6.1 Preparing for Application Development ................................................................................... 6
6.2 Creating Applications ................................................................................................................. 6
6.2.1 Outline of Process ................................................................................................................. 6
6.2.2 Basic Level ............................................................................................................................ 9
6.2.3 Advanced Level ................................................................................................................... 17
6.2.4 Uploading a File ................................................................................................................... 19
6.3 Setting ........................................................................................................................................ 19
7. Reference ............................................................................................................ 20
7.1 Property ..................................................................................................................................... 20
7.1.1 Property list .......................................................................................................................... 20
7.1.2 Example of use and conventions in this chapter ................................................................. 26
7.1.3 AdjustRGB .... Adjusting the brightness of each color (RGB) separately ........................... 27
7.1.4 AdjustRGBB .... Brightness of the Color Blue ..................................................................... 28
7.1.5 AdjustRGBG .... Brightness of the Color Green .................................................................. 29
7.1.6 AdjustRGBR .... Brightness of the Color Red ...................................................................... 30
7.1.7 ADTCThreshold .... Automatic (advanced) binary threshold ............................................... 31
7.1.8 AIQCNotice .... Automatic Image Quality Checker setting .................................................. 32
7.1.9 AutoBorderDetection .... automatic border detection .......................................................... 33
7.1.10 AutoBright .... Automatic adjustment of brightness-related image quality ......................... 34
7.1.11 AutomaticColorBackground .... setting auto color detection which ignores background
color ..................................................................................................................................... 35
7.1.12 AutomaticColorSensitivity .... Sensitivity for auto color detection ...................................... 36
7.1.13 AutomaticRotateMode .... Mode for detecting the orientation of an image ....................... 37
7.1.14 AutomaticSenseMedium .... ADF/FB automatic switching ................................................ 38
7.1.15 AutoProfile .... Applying a profile automatically ................................................................. 39
7.1.16 AutoProfileSensitivity .... Sensitivity level for identifying forms ......................................... 40
7.1.17 Background .... background tracking ................................................................................. 41
7.1.18 BackgroundColor .... setting the background color (black or white background) ................. 42
7.1.19 BackgroundSmoothing .... Background color smoothing(Color cleanup) ......................... 43
7.1.20 BackgroundSmoothness .... Background color smoothness(Color cleanup
smoothness) ........................................................................................................................ 44
7.1.21 BackgroundThreshold .... Background color threshold ..................................................... 45
7.1.22 BarcodeDetection .... Barcode detection ........................................................................... 46
7.1.23 BarcodeDirection .... Barcode detection direction setting ................................................. 47
7.1.24 BarcodeMaxSearchPriorities .... Barcode maximum detection count setting ................... 48
7.1.25 BarcodeNotDetectionNotice .... Barcode detection notification when a barcode is not

III
 detected ............................................................................................................................... 49
7.1.26 BarcodeRegionLeft .... Barcode detection area left edge position .................................... 50
7.1.27 BarcodeRegionLength .... Barcode detection area length ................................................. 51
7.1.28 BarcodeRegionTop .... Barcode detection area top edge position .................................... 52
7.1.29 BarcodeRegionWidth .... Barcode detection area width .................................................... 53
7.1.30 BarcodeType .... Barcode type setting .............................................................................. 54
7.1.31 Binding .... duplex binding direction ................................................................................... 55
7.1.32 BlankPageIgnoreAreaSize .... Sides undetected during blank page detection ................. 56
7.1.33 BlankPageNotice .... Output blank page setting ................................................................ 57
7.1.34 BlankPageSkip .... Blank page skip sensitivity .................................................................. 58
7.1.35 BlankPageSkipMode .... Blank page skip mode ................................................................ 59
7.1.36 BlankPageSkipTabPage .... Blank page skip settings for index-tabbed pages................. 60
7.1.37 Brightness .... brightness ................................................................................................... 61
7.1.38 CarrierSheetClippingMode .... Carrier Sheet clipping mode ............................................. 62
7.1.39 CharacterExtraction .... Extracting characters ................................................................... 63
7.1.40 CharacterExtractionMethod .... Setting the type of character extractions ......................... 64
7.1.41 CharacterThickness .... Dynamic Threshold (iDTC) binary character thickness setting 65
7.1.42 CloseSourceUI .... exit setting for the user interface (UI) of the source ............................ 66
7.1.43 ColorReproduction .... Color reproduction ......................................................................... 67
7.1.44 ColorReproductionBrightness .... Brightness when a color hue is prioritized .................... 68
7.1.45 ColorReproductionContrast .... Color contrast when a color hue is prioritized .................. 69
7.1.46 ColorReproductionCustomGamma .... Gamma value when a color hue is prioritized ...... 70
7.1.47 ColorReproductionHighlight .... Highlight when a color hue is prioritized .......................... 71
7.1.48 ColorReproductionShadow .... Shadow when a color hue is prioritized ............................ 72
7.1.49 CompressionType .... data compression type ................................................................... 73
7.1.50 Contrast .... contrast .......................................................................................................... 75
7.1.51 CropMarginSize .... Sizes of cropping margins ................................................................. 76
7.1.52 CropPriority .... Priority setting during automatic paper size detection .............................. 77
7.1.53 CustomGamma .... custom gamma ................................................................................... 78
7.1.54 CustomPaperLength .... custom document length ............................................................ 79
7.1.55 CustomPaperWidth .... custom document width................................................................ 80
7.1.56 CustomResolution .... custom resolution ........................................................................... 81
7.1.57 Deskew .... Skew correction .............................................................................................. 82
7.1.58 DeskewBackground .... Background color used for skew correction ................................ 83
7.1.59 DeskewMode .... Deskew mode ........................................................................................ 84
7.1.60 DigitalEndorser .... Digital endorser setting ....................................................................... 85
7.1.61 DigitalEndorserCountDirection .... Digital endorser counter step direction setting ............ 86
7.1.62 DigitalEndorserCounter .... Digital endorser counter default value setting ........................ 87
7.1.63 DigitalEndorserCountStep .... Digital endorser counter step value setting ....................... 88
7.1.64 DigitalEndorserDirection .... Digital endorser output direction setting ............................... 89
7.1.65 DigitalEndorserString .... Digital endorser character string setting .................................... 90
7.1.66 DigitalEndorserXOffset .... Digital endorser output start position (X offset) setting ........... 91
7.1.67 DigitalEndorserYOffset .... Digital endorser output start position (Y offset) setting ........... 92
7.1.68 DivideLongPage .... Dividing long pages ........................................................................... 93
7.1.69 DTCSensitivity .... Dynamic Threshold (iDTC) binary sensitivity setting ........................... 94
7.1.70 EdgeFiller .... Edge filler..................................................................................................... 95
7.1.71 EdgeFillerBottom .... Edge filler bottom edge area setting ................................................ 96
7.1.72 EdgeFillerLeft .... Edge filler left edge area setting ............................................................ 97
7.1.73 EdgeFillerRight .... Edge filler right edge area setting ....................................................... 98
7.1.74 EdgeFillerTop .... Edge filler top edge area setting ........................................................... 99
7.1.75 EdgeRepair .... Edge filler repair ..................................................................................... 100
7.1.76 Endorser .... Endorser / Imprinter setting......................................................................... 101
7.1.77 EndorserCountDirection .... Endorser / Imprinter counter step direction setting ............. 102
7.1.78 EndorserCounter .... Endorser / Imprinter counter default setting ................................... 103
7.1.79 EndorserCountStep .... Endorser / Imprinter counter step count setting ......................... 104
7.1.80 EndorserDialog .... Endorser / Imprinter print settings window ....................................... 105
7.1.81 EndorserDirection .... Endorser / Imprinter print direction setting.................................... 106
7.1.82 EndorserFont .... Endorser / Imprinter print font setting .................................................. 107
7.1.83 EndorserOffset .... Endorser / Imprinter print position setting ......................................... 108

IV
7.1.84 EndorserString .... Endorser / Imprinter string setting ..................................................... 109
7.1.85 ErrorCode .... error information acquisition ..................................................................... 110
7.1.86 FadingCompensation .... Dynamic Threshold (iDTC) binary fading compensation...... 111
7.1.87 FileCounter .... file serial number setting ......................................................................... 112
7.1.88 FileCounterEx .... file serial number setting ..................................................................... 114
7.1.89 FileName .... file name ..................................................................................................... 116
7.1.90 FileType .... file format (image data format) .................................................................... 118
7.1.91 Filter .... dropout color ...................................................................................................... 120
7.1.92 FilterSaturationSensitivity .... Chromatic dropout color sensitivity setting ....................... 122
7.1.93 FrontBackDetection .... ID card automatic detection ....................................................... 123
7.1.94 FrontBackMergingEnabled .... Setting for merging the front and back side images ....... 124
7.1.95 FrontBackMergingLocation .... Setting for the way of merging the front and back side
images ............................................................................................................................... 125
7.1.96 FrontBackMergingRotation .... Setting for the angle to rotate the back side when
merging the front and back side images ........................................................................... 126
7.1.97 FrontBackMergingTarget .... Setting a type of document whose front and back side
images are to be merged .................................................................................................. 127
7.1.98 FrontBackMergingTargetMode .... Setting the criteria for determining a type of
document whose front and back side images are to be merged ...................................... 128
7.1.99 FrontBackMergingTargetSize .... Setting the length for the criteria for determining a
type of document whose front and back images are to be merged .................................. 129
7.1.100 Gamma .... gamma adjustment ..................................................................................... 130
7.1.101 GammaFile .... gamma pattern file name ...................................................................... 131
7.1.102 Halftone .... halftone ...................................................................................................... 132
7.1.103 HalftoneFile .... halftone pattern file ............................................................................... 133
7.1.104 Highlight .... highlight ..................................................................................................... 134
7.1.105 HwAutomaticDeskew .... Automatic Skew Correction ................................................... 135
7.1.106 HwCompression .... Transfer mode of the hardware .................................................... 136
7.1.107 HwMoireReductionMode .... Moire Reduction(Advanced) ............................................ 137
7.1.108 ImageScanner .... image scanner name acquisition ..................................................... 138
7.1.109 Indicator .... progress indicator setting .......................................................................... 139
7.1.110 IsExistsFB .... image scanner's flatbed (FB) support .................................................... 140
7.1.111 JobControl .... job control setting ................................................................................... 141
7.1.112 JobControlMode .... Job control type setting ................................................................. 143
7.1.113 JpegQuality .... Jpeg data compression level ................................................................ 144
7.1.114 LengthDetection .... Simultaneous setting of paper end detection/background
color/overscan ................................................................................................................... 145
7.1.115 LongPage .... Long document (long page) scan setting ................................................ 146
7.1.116 ManualFeedMode .... Manual Feed Mode .................................................................... 147
7.1.117 MultiFeed .... multifeed detection .................................................................................. 148
7.1.118 MultiFeedModeChangeSize .... Specifying the paper length to disable multifeed
detection ............................................................................................................................ 149
7.1.119 MultiFeedNotice .... Multifeed notification setting .......................................................... 150
7.1.120 MultiStreamDefaultValueMode .... Mode for keeping the default value for each
image ................................................................................................................................. 151
7.1.121 MultiStreamFileNameMode .... File name and file counter settings for a file created
from each outpu image ...................................................................................................... 154
7.1.122 MultiStreamMode .... Settings for outputting multiple images ....................................... 155
7.1.123 NoiseRejection .... Dynamic Threshold (iDTC) binary noise removal ........................... 159
7.1.124 Orientation .... document orientation setting.................................................................. 160
7.1.125 OverScan .... overscan setting ...................................................................................... 161
7.1.126 Overwrite .... file overwrite setting ................................................................................. 162
7.1.127 PageCount .... scan page count acquisition .................................................................. 163
7.1.128 PaperProtection .... Paper Protection ............................................................................ 164
7.1.129 PaperSize .... document size ......................................................................................... 165
7.1.130 PaperSupply .... paper feed method .............................................................................. 167
7.1.131 PatchCodeDetection .... Patch code detection .............................................................. 171
7.1.132 PatchCodeDirection .... Patch code detection direction setting .................................... 172
7.1.133 PatchCodeType .... Patch code type setting ................................................................. 173

V
 7.1.134 PatternRemoval .... Dynamic Threshold (iDTC) binary pattern removal setting ......... 174
7.1.135 PixelType .... pixel type .................................................................................................. 175
7.1.136 PunchHoleRemoval .... Punch hole removal ................................................................. 177
7.1.137 PunchHoleRemovalMode .... Punch hole removal mode .............................................. 178
7.1.138 RegionLeft .... Left Edge of the Scanning Area ............................................................. 179
7.1.139 RegionLength .... Length of the Scanning Area ............................................................ 180
7.1.140 RegionTop .... Top Edge of the Scanning Area ............................................................. 181
7.1.141 RegionWidth .... Width of the Scanning Area ................................................................ 182
7.1.142 Resolution .... Standard Resolution ............................................................................... 183
7.1.143 Reverse .... Black and White Inversion / Color Inversion .............................................. 184
7.1.144 Rotation .... Rotation Angle ............................................................................................ 185
7.1.145 ScanContinue .... Setting Continuous Scanning ........................................................... 186
7.1.146 ScanContinueMode .... Setting Continuous Scanning Method ..................................... 187
7.1.147 ScanCount .... Number of Pages to be Scanned .......................................................... 188
7.1.148 ScanMode .... Scan mode ............................................................................................. 189
7.1.149 SDTCSensitivity .... Automatic (simple) binary dispersion value ................................... 190
7.1.150 SEE .... Selectable Edge Enhancement ........................................................................ 191
7.1.151 SelectOutputSize .... Selecting output size.................................................................... 192
7.1.152 Shadow .... shadow ....................................................................................................... 193
7.1.153 Sharpness .... Sharpness .............................................................................................. 194
7.1.154 ShowSourceUI .... Source User Interface (UI) Display .................................................. 196
7.1.155 SilentMode .... Silent Mode ............................................................................................ 198
7.1.156 SimpleSlicePatternRemoval .... Simple slice binary pattern removal setting ................ 199
7.1.157 SkipBlackPage .... Skip Black Pages ............................................................................ 200
7.1.158 SkipWhitePage .... Skip White Pages ............................................................................ 201
7.1.159 SourceCurrentScan .... Scan with the Source Current Value........................................ 202
7.1.160 sRGB .... sRGB output................................................................................................... 204
7.1.161 StapleDetection .... Stapled Documents Detection ....................................................... 205
7.1.162 SynchronizationDigitalEndorser .... Endorser/Imprinter and Digital Endorser
synchronization function setting ........................................................................................ 206
7.1.163 Threshold .... Threshold ................................................................................................. 207
7.1.164 TwainDS .... Data Source .............................................................................................. 208
7.1.165 TwainDSAnyPort .... Locking the Data Source Name ................................................... 209
7.1.166 UndefinedScanning .... Scanning an Undefined Length (Paper End Detection) ........... 211
7.1.167 Unit .... unit of size (inch/centimeter/pixel) ..................................................................... 212
7.1.168 VerticalLineReduction .... Vertical line reduction setting ............................................... 214
7.2 Methods.................................................................................................................................... 215
7.2.1 List of Methods .................................................................................................................. 215
7.2.2 Examples and Notation Conventions in This Chapter ....................................................... 216
7.2.3 ClearPage .... Document Ejection ..................................................................................... 217
7.2.4 CloseScanner .... Closing the Scanner .............................................................................. 218
7.2.5 ConvertToBase64 .... Returning a character string of a scanned image converted in a
Base64 format ................................................................................................................... 219
7.2.6 DeleteFile.... Deleting a Scanned Image ........................................................................... 220
7.2.7 FeederLoaded .... Notifying Whether or Not a Document Is Loaded on the ADF ............. 221
7.2.8 GetSerialNumber .... Obtaining a scanner serial number .................................................. 222
7.2.9 GetSourceCount .... Getting the total number of data source ........................................... 223
7.2.10 GetSourceName .... Getting a data source name ........................................................... 224
7.2.11 GetSourceSelect .... Getting the index of a selected data source ................................... 225
7.2.12 GetTWAINTemplateCount .... Setting File / profile Total Number Acquisition ................ 226
7.2.13 GetTWAINTemplateName .... Setting File / profile Name Acquisition ............................ 227
7.2.14 GetTWAINTemplateSelect .... Selected Setting File / profile Number Acquisition .......... 228
7.2.15 Initialize .... Web API Initialization Process...................................................................... 229
7.2.16 OpenScanner .... Opening the Scanner .......................................................................... 230
7.2.17 OpenScanner2 .... Open scanner (part 2) ....................................................................... 231
7.2.18 RegisterEvent .... Registering an event to be notified ..................................................... 233
7.2.19 ScannerAvailable .... Image Scanner Availability ............................................................ 234
7.2.20 SelectSource .... Data source Selection .......................................................................... 235
7.2.21 SelectSourceName .... data source selection.................................................................. 236

VI
 7.2.22 SetSourceCurrentScan .... Setting the SourceCurrentScan property. ............................ 237
7.2.23 SetTopMostWindow .... Displaying a screen at the front ................................................ 238
7.2.24 SetTwainDSInfo .... Setting the TwainDS property and the TwainDSAnyPort property . 239
7.2.25 SetTWAINTemplateSelect .... Configuring Setting File / profile Numbers ...................... 240
7.2.26 SetupDataSourceProperties .... Settable UI Display ....................................................... 241
7.2.27 StartScan .... Starting an Image Scanning ...................................................................... 243
7.3 Events ...................................................................................................................................... 245
7.3.1 List of Events ..................................................................................................................... 245
7.3.2 Examples and Notation Conventions in This Chapter ....................................................... 246
7.3.3 AIQCResult .... Notify Automatic Image Quality Checker results ...................................... 247
7.3.4 AutoProfileSelection .... Notification of the identified forms ............................................... 248
7.3.5 BlankPageResult .... Get blank page detection results ..................................................... 249
7.3.6 DetectBarcode .... Barcode detection notification ............................................................. 250
7.3.7 DetectBarcodeDetail .... Barcode detail detection notification .......................................... 251
7.3.8 DetectJobSeparator .... Special Document/Patch Code Document Detection Notification253
7.3.9 DetectPatchCode .... Patch code detection notification .................................................... 254
7.3.10 MultiFeedResult .... Getting the multifeed result ............................................................. 255
7.3.11 PageNumber .... Getting a page number ........................................................................ 256
7.3.12 PagePartition .... Page break notification ........................................................................ 257
7.3.13 ScannerReady .... Completing the initialization process for a scanner application ......... 258
7.3.14 ScanToFile .... File Output ............................................................................................... 259
8. Sample............................................................................................................... 260
8.1 Sample of Scanning ................................................................................................................ 261
8.2 Sample of Uploading a File On a Server ............................................................................... 262
9. Appendix ........................................................................................................... 266
9.1 Silent Installation .................................................................................................................... 266
9.2 Silent Uninstallation ............................................................................................................... 266

VII
1. System Requirements
The environment of the Web API must meet the conditions below:

Environment Details
OS Windows® 10 (32/64bit)
Windows® 11 (64bit)
Software RICOH Scanner Control Runtime V2.3L60 or later
PaperStream IP(TWAIN) 1.60 or later
Google Chrome V58 or later
Google Chrome V78 or later for https
Microsoft® .NET Framework 4.6.2 or later
Microsoft® Edge V90 or later

1.1 Supported Languages

Japanese, English, French, Italian, German, Russian, Spanish, Portuguese,
Chinese(simplified), Chinese(traditional), Korean

1.2 Supported Models

The RICOH fi Series and SP Series image Scanners below can be used:
- fi-8950
- fi-8930
- fi-8820
- fi-8290
- fi-8190
- fi-8270
- fi-8170
- fi-8250
- fi-8150
- fi-8250U
- fi-8150U
- fi-8040
- fi-800R
- fi-7900
- fi-7800
- fi-7700
- fi-7700S
- fi-7600
- fi-7300NX
- fi-7480
- fi-7460
- fi-7280
- fi-7180
- fi-7260
- fi-7160
- fi-7240
- fi-7140
- fi-7030
- fi-70F
- fi-6800
- fi-6400
- fi-5950

1
 - fi-65F
- SP-1425
- SP-1120N
- SP-1125N
- SP-1130N

2. Development Environment
Set the web browser settings to enable JavaScript to work when developing an application
with this product.

3. Outline and Functions of This Product

This chapter explains about the outline and main features of this product.

3.1 Outline of This Product

Web API enables you to use RICOH Scanner Control SDK functions from a Web
application. This enables a Web application to gain control of a scanner directly and
perform a scan from it. In addition, you can display and check the image that is scanned
with Web API on the Web screen.

3.2 Functions of This Product

・ Image processing
The settings of many image processing functions, including the adjustment in image
quality and the rotation of various images, can be configured.

・ Scanner control
Various scanners that support functions such as the multifeed detection and the
endorser function can be controlled.

・ Information notification
Information such as barcodes and patch codes can be notified.

2
4. Components of a Program
A list of components for the Web API is explained below:

Component Function Location

1 Web API Communicates with RICOH Client PC
Scanner Control SDK directly.
2 Web API Script Script files that are provided for Web server
the Web API interface
3 Web application Sets the scan settings and Web server
(User application) performs a scan with Web API.
(Sample source codes are
available.)

Supplied components with this product

Client PC Web Server

Web browser
HTML(JavaScript) Web Server
2 3

SignalR Hub API

3 Web applications
1 Web API User applications

Web API services

FiScanServices.exe
(FiScanservices) 2 Web API Script

FiSDKClient.exe

RICOH Scanner Control Runtime

PaperStream IP

3
File components of the Web API are described. <Program Files> indicates the folder that
is specified during installation.

Service program of client

<Program Files>\FiScanService\FiScanCommon.dll
<Program Files>\FiScanService\FiScanService.exe
<Program Files>\FiScanService\FiScanService.exe.config
<Program Files>\FiScanService\log4net.dll
<Program Files>\FiScanService\log4net.xml
<Program Files>\FiScanService\Microsoft.AspNet.SignalR.Core.dll
<Program Files>\FiScanService\Microsoft.AspNet.SignalR.Core.xml
<Program Files>\FiScanService\Microsoft.Owin.Cors.dll
<Program Files>\FiScanService\Microsoft.Owin.Cors.xml
<Program Files>\FiScanService\Microsoft.Owin.Diagnostics.dll
<Program Files>\FiScanService\Microsoft.Owin.Diagnostics.xml
<Program Files>\FiScanService\Microsoft.Owin.dll
<Program Files>\FiScanService\Microsoft.Owin.Host.HttpListener.dll
<Program Files>\FiScanService\Microsoft.Owin.Host.HttpListener.xml
<Program Files>\FiScanService\Microsoft.Owin.Hosting.dll
<Program Files>\FiScanService\Microsoft.Owin.Hosting.xml
<Program Files>\FiScanService\Microsoft.Owin.Security.dll
<Program Files>\FiScanService\Microsoft.Owin.Security.xml
<Program Files>\FiScanService\Microsoft.Owin.xml
<Program Files>\FiScanService\Newtonsoft.Json.dll
<Program Files>\FiScanService\Newtonsoft.Json.xml
<Program Files>\FiScanService\Owin.dll
<Program Files>\FiScanService\System.Web.Cors.dll
Program of client)
<Program Files>\FiSDKClient\AxInterop.FiScnLib.dll
<Program Files>\FiSDKClient\FiScanCommon.dll
<Program Files>\FiSDKClient\FiSDKClient.exe
<Program Files>\FiSDKClient\FiSDKClient.exe.config
<Program Files>\FiSDKClient\Interop.FiScnLib.dll
<Program Files>\FiSDKClient\log4net.dll
<Program Files>\FiSDKClient\log4net.xml
<Program Files>\FiSDKClient\Newtonsoft.Json.dll
<Program Files>\FiSDKClient\Newtonsoft.Json.xml
Script files
<Program Files>\WebClient\JavaScrip\ricoh.fiscanner.initiate.js
<Program Files>\WebClient\JavaScript\jquery-1.6.4.min.js
<Program Files>\WebClient\JavaScript\jquery.signalR-2.2.3.min.js
Setting file
<Program Files>\fiWebAPI.xml
License file
<Program Files>\OSS_licenses.txt
<Program Files>\WebAPI_eula.rtf
<Program Files>\WebAPI_eula.txt

4
5. Install/Uninstall
This chapter explains how to install/uninstall the product and also about important
reminders.
"setup folder" indicates " fiWebAPI_setup " that is created when this product is
downloaded in the following way.

5.1 Install
This section explains how to install the product.
Install this product by following the procedure below:

1. Run "Setup.exe" in the setup folder.

2. Follow the installation wizard to install this product.

Note
To install this product, login as a user with administrator privileges.
"RICOH Scanner Control Runtime V2.3L60" is also installed with this product.
If "RICOH Scanner Control Runtime" (older than V2.3L60) is already installed, uninstall
"RICOH Scanner Control Runtime" first, and install Web API and "RICOH Scanner
Control Runtime".
If "RICOH Scanner Control Runtime" (V2.3L60 or later) is already installed, you only
need to install the Web API.

Silent installation, which does not require the user name to be entered, is available. Refer
to "9.1 Silent Installation" for details.

5.2 Uninstall
This section explains how to uninstall the product.

1. Open the Control Panel from the Windows start menu, and select "fi Series Web API" to
uninstall it.

Caution
To uninstall the product, login as a user with administrator privileges.
"RICOH Scanner Control Runtime" will not be uninstalled even if you uninstall the Web
API.

Silent uninstallation, which does not require the user name to be entered, is available.
Refer to "9.2 Silent uninstallation" for details.

5
6. Development Procedure
This chapter explains about procedures for developing applications using the ASP.NET
Web application and Visual Studio 2017 as an example.

6.1 Preparing for Application Development

When you install the Web API, the script files are stored as follows.
<Program Files> indicates the folder that is specified during installation.
<Program Files>\WebClient\JavaScript

For details about how to specify the following scripts, refer to step 6 in "6.2.2 Basic Level".

ricoh.fiscanner.initiate.js fi Series Web API JavaScript Library

jquery.signalR-2.2.3.min.js ASP.NET SignalR JavaScript Library v2.2.3
jquery-1.6.4.min.js jQuery JavaScript Library v1.6.4

6.2 Creating Applications

This section describes how to create an application using Web API at basic and advanced
levels.

6.2.1 Outline of Process

Web API consists of the three components below:

・ Properties for specifying scan parameters
・ Methods for performing a scan and other processes
・ Events to be generated in the scanning process

Create an application that checks for barcode detection for each page scanned, and
notifies "the number of images scanned", "scanned file name", and "recognized barcode
characters" as a message when a barcode is detected.
The procedure to upload a scanned image to a Web server is explained in "Uploading a
File".

6
 The outlined process flow of the application is as follows:
Required process for communicating with SignalR *

Web API setting

Application Web API

Set a URL to SignalR Hub/Declare a Proxy

Web API initialization
(Initialize method)

Event registration
(RegisterEvent method)

Start a SignalR Hub connection

Select the scanner (When necessary)

(TwainDS property)

Open the scanner

(OpenScanner2 method)

Set the scan parameters

(Various properties)

Scan documents
(StartScan method)

Notify an event for each page scanned

(ScanToFile event)

Notify an event for each barcode detected

(DetectBarcode event)

Resume scanning operations

Close the scanner

(CloseScanner method)

* It is necessary to apply this process if you want an application to use the Web API along with
SignalR. To apply this process, enter the same code as the one in the HTML page described in
"6.2.2 Basic Level" or the sample source codes.

7
 The outlined process flow for uploading a file is as follows:
* The operations with the dotted line must be implemented on the user application side.

Web server Application Web API

Convert a scanned image into Base64 format

characters (ConvertToBase64 method）

Callback the function

A function for the callback

which is set for
ConvertToBase64

Send the conversion results in Base64

Output the obtained format characters to a server
data as a file Delete a file as necessary

8
6.2.2 Basic Level

Create the method part in the outlined process flow.

1. Select the [File] menu - [New] - [Project].

2. Select [Web] under [Visual C#], and then select [ASP.NET Web Application].

9
3. Set the name and location of the project, and click the [OK] button.

4. Select [Empty] and click the [OK] button.

10
5. Add a folder.
Display "Solution Explorer", right-click the project that was created, and then select
[Add] - [New folder].

11
6. Place "ricoh.fiscanner.initiate.js", "jquery.signalR-2.2.3.min.js", and
"jquery-1.6.4.min.js" on the folder that was added.
Right-click the folder that was added, click [Add] - [Existing item], and then select
script files.

7. Create a HTML page.

Display "Solution Explorer", right-click the project that was created, and then select
[Add] - [New item].

12
8. Select [Web] under [Visual C#], and then select [HTML Page].

13
9. Set the file name and click the [Add] button.

14
10. Write a program to start scanning when the [Scan] button which is defined in the
HTML page is clicked.
Enter the following code in the HTML page.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="utf-8"/>
<title>
fi Series Web API
</title>
<!-- Refer to scripts -->
<!-- Refer to jQuery script file -->
<script src="Scripts/jquery-1.6.4.min.js"></script>
<!-- Refer to SignalR script file -->
<script src="Scripts/jquery.signalR-2.2.3.min.js"></script>
<!-- Refer to script that is required for SignalR operation. Generated dynamically-->
<script src="http://localhost:8087/signalr/hubs"></script>
<!-- Refer to script file which controls Web API -->
<script type="text/javascript" src="Scripts/ricoh.fiscanner.initiate.js"></script>
</head>
<body>
<div>
<input type="button" id="scan" value="Scan" />
<input type="text" id="errorCode" value="0x00000000" disabled />
<div id="detectBarcode"></div>
</div>
<script type="text/javascript">
$(function () {
// Specify the URL of the Hub in order to establish a connection
$.connection.hub.url = "http://localhost:8087/signalr";
// Create a proxy object so that you can refer to the Hub
// Initialize the Web API
ricoh.fiscanner.Initialize($.connection.fiHub);
// The click event of the scan button
function scanFunc() {
document.getElementById("errorCode").innerText = '0x00000000';
document.getElementById('detectBarcode').innerHTML = '';
// Open the scanner (method)
ricoh.fiscanner.OpenScanner2().done(function (resultCode) {
// Start scanning (method)
ricoh.fiscanner.StartScan().done(function (resultCode) {
// An error occurred during a scan
if (resultCode == -1) {
// Display the error information
var errorCode = ricoh.fiscanner.errorCode.toString(16);
document.getElementById("errorCode").innerText = '0x' + ('00000000' +
errorCode).slice(-8);
}
// Close the scanner (method)
ricoh.fiscanner.CloseScanner().done(function (resultCode) {
});
});
});
};
// Start the Hub connection
$.connection.hub.start().done(function () {
$('#scan').click(function () { scanFunc(); });
});
});
</script>
</body>
</html>

15
When HTML is displayed, the page is shown below:

16
6.2.3 Advanced Level

Create the property parts and event parts in the outlined process flow. Add them to the
program given in Basic Level.

1. Set the properties as scan parameters.

Add the following code between the OpenScanner2 method and the StartScan
method.

ricoh.fiscanner.compressionType = 5; // Compression format: JPEG compression

ricoh.fiscanner.fileType = 3; // File format: JPEG file
ricoh.fiscanner.pixelType = 2; // Pixel type: RGB color
ricoh.fiscanner.fileName = "C:\\temp\\image####"; // File name
ricoh.fiscanner.barcodeDetection = true; // Barcode detection: On
ricoh.fiscanner.showSourceUI = false; // Do not display the source user interfaces

Caution
・ Some properties need to be set before the OpenScanner2 method. For details,
refer to the explanation for each property.
・ If you do not set values for the properties, all values are set to default.
・ After scanning, the properties are set using the values of the current settings.
Therefore, the values of the properties may be changed. Before every scan, set the
proper values for the properties.
・ Create the folder set for the FileName property in advance.

2. By setting the ScanToFile event, write a program to get the "scanned file name" for
each page scanned.
Add the following code after the Initialize method.

var readfilename = ""; //Holds scanned file name

// Called for each page scanned of the data output method is set to a file (event)
ricoh.fiscanner.RegisterEvent("OnScanToFile",
function (readcount, filename) {
readfilename = filename;
});

3. By setting the DetectBarcode event, write a program to issue a message when a

barcode is detected.
Add the following code after the Initialize method.

Caution
The DetectBarcode event is only valid when [1 - True] is set for the BarcodeDetection
property.

// Called for each barcode detected if barcode detection is set to ON (event)

ricoh.fiscanner.RegisterEvent("OnDetectBarcode",
function (readcount, barcodetype, barcodetext) {
document.getElementById('detectBarcode').insertAdjacentHTML('beforeend', "<p>
DetectBarcode event is detected.<br> Number of scanned pages:" + readcount + " page(s)<br> File
name:" + readfilename + "<br> Recognized characters:" + barcodetext + "</p>");
});

17
When a document in which a barcode is printed is scanned, the page is shown below

18
6.2.4 Uploading a File

The procedure to upload a scanned image to a web server is shown below as described
in "6.2.1 Outline of Process":

1. Convert a scanned image into Base64 format characters. (the ConvertToBase64

method in Web API)
2. Get the conversion results with the callback function which is set for the
ConvertToBase64 method, and send them to the Web server. (A user application
implements the callback function)
3. Restore the data obtained into binary data on the Web server, and then output it as a file.
(A user application implements the operation for the Web server) Allow a user
application to delete the scanned image as necessary when the data is sent
successfully.

An example of implementation for uploading a file is attached as a sample program.

For step 1 and 2, refer to "ScanTest.html" in the sample program.
For step 3, refer to "FileUpload.aspx".

For details on the sample program, refer to "8. Sample".

[Note]
The maximum file size that the ConvertToBase64 method can handle depends on the
browser type.

6.3 Setting
The default port number for SignalR communication is "8087". Other port numbers can be
used by the procedure below:
Set another port number for the "Port" key in the "FiWebAPI.xml" file, and then restart the
following service.
Service name: FiScanService

<SETTINGS>
<item name="UseHttps" value="False"/>
<item name="Port" value="8087"/>
</SETTINGS>

19
7. Reference

7.1 Property

7.1.1 Property list

The following table gives an overview of the supported Web API properties:

Property name Description

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 image when an
image is automatically rotated.
AutoProfile Sets whether to apply a profile automatically.
AutoProfileSensitivity Specifies the sensitivity level for identifying a form when a
profile is applied automatically.
AutomaticSenseMedium Sets automatic switching for the ADF/FB feeding method.
CarrierSheetClippingMode Sets the mode for clipping the Carrier Sheet.
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.
PaperSupply Sets the document feed method (flatbed, ADF, etc.).
ScanContinue Sets continuous scanning.
ScanContinueMode Sets the continuous scanning method.
ScanCount Specifies the document scan page count.
ScanMode Sets the scan mode.
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 source name that
is to be used.
Image format properties/destination
CompressionType Sets the data compression type.
FileCounter Sets the serial numbers of files. (for compatibility)
FileCounterEx Sets the serial numbers of files.
FileName Sets the file name for storing the image. (Extension not
included)
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.

20
 Property name Description
Image properties
AdjustRGB Sets whether to adjust the brightness of each color (Red,
Green, Blue) separately.
AdjustRGBB Sets the brightness of the color blue when the brightness of
each color (RGB) is adjusted separately.
AdjustRGBG Sets the brightness of the color green when the brightness of
each color (RGB) is adjusted separately.
AdjustRGBR Sets the brightness of the color red when the brightness of
each color (RGB) is adjusted separately.
ADTCThreshold Sets the automatic (advanced) binary threshold.

AutoBright Sets the automatic adjustment of the brightness-related image

quality.
AutomaticColorBackground Detects color automatically ignoring background color.
AutomaticColorSensitivity Sets the sensitivity for auto color detection.
Background Sets the background tracking.
BackgroundSmoothing Smoothens the image backgrounds, and prevents unevenness
of color and density.
BackgroundSmoothness Sets the smoothness level of the background color.
BackgroundThreshold Sets the background threshold.
Brightness Specifies the brightness.
CharacterExtraction Sets whether to extract characters or not.
CharacterExtractionMethod Sets the type of character extractions.
CharacterThickness Sets the thickness of the Dynamic Threshold (iDTC) binary
character.
ColorReproduction Sets the color reproduction.
ColorReproductionBrightness Specifies the brightness when a color hue is prioritized.
ColorReproductionContrast Specifies the color contrast when a color hue is prioritized.
ColorReproductionCustomGamma Specifies the gamma value when a color hue is prioritized.
ColorReproductionHighlight Specifies a highlight when a color hue is prioritized.
ColorReproductionShadow Specifies a shadow when a color hue is prioritized.
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 sensitivity.
EdgeFiller Sets the edge filler.
EdgeFillerBottom Sets the edge filler area at the bottom edge of the paper size.
EdgeFillerLeft Sets the edge filler area at the left edge of the paper size.
EdgeFillerRight Sets the edge filler area at the right edge of the paper size.
EdgeFillerTop Sets the edge filler area at the top edge of the paper size.
EdgeRepair Sets the edge filler repair.
FadingCompensation Sets the compensation of the fading section of the image
during Dynamic Threshold (iDTC) binary scanning.
Filter Sets the dropout color.
FilterSaturationSensitivity Sets the chromatic dropout color sensitivity.
Gamma Sets the gamma pattern type (soft/sharp/download/custom).
GammaFile Specifies a customized gamma pattern file.

21
 Property name Description
Image properties
Halftone Specifies the halftone pattern.
HalftoneFile Specifies the halftone pattern file.
Highlight Set highlights.
HwMoireReductionMode Specify whether to adjust the scanning speed of the scanner to
reduce moire (vertical streaks) pattern appearing on the
images.
MultiStreamDefaultValueMode 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.
MultiStreamFileNameMode Sets a file name and file counter for a file created from each
output image.
MultiStreamMode Outputs multiple images for each page that is scanned.
NoiseRejection Sets the sensitivity for Dynamic Threshold (iDTC) binary noise
removal.
Orientation Sets the document orientation (portrait/landscape).
PaperSize Specifies the document size.
PatternRemoval Sets the removal of the Dynamic Threshold (iDTC) 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.
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 value.
SEE Sets the selective enhancement.
Shadow Sets shadow.
Sharpness Sets the sharpness.
SimpleSlicePatternRemoval Sets the removal of the simple slice binary pattern.
sRGB Sets the sRGB output.
Threshold Sets the threshold.
VerticalLineReduction Sets whether the vertical lines are reduced.
Properties relating to behavior
AIQCNotice Sets whether the image recognition check function is used.
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.
BarcodeDirection Sets the direction of the barcode that is detected.
BarcodeMaxSearchPriorities Sets the maximum number of barcodes that are detected.
BarcodeNotDetectionNotice Sets whether to send a barcode detection notification even if a
barcode is not detected.
BarcodeRegionLeft Sets the left edge of the barcode detection area.
BarcodeRegionLength Sets the length of the barcode detection area.
BarcodeRegionTop Sets the top edge of the barcode detection area.
BarcodeRegionWidth Sets the width of the barcode detection area.
BarcodeType Sets the type of barcode that is detected.
Binding Sets the binding direction for duplex scanning.
BlankPageIgnoreAreaSize Sets the sides around a page to be undetected during blank
page detection.

22
 Property name Description
BlankPageNotice Sets whether a blank page is output or not.

23
 Property name Description
Properties relating to behavior
BlankPageSkip Sets the sensitivity to scan by skipping blank pages during
continuous ADF scanning.
BlankPageSkipMode Sets a criteria for detecting blank pages.
BlankPageSkipTabPage Sets whether or not index-tabbed pages are checked during
blank page detection.
CropMarginSize Specifies the sizes of cropping margins.
CropPriority Sets the priority during automatic paper size detection.
Deskew Sets the skew correction.
DeskewBackground 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.
DeskewMode Sets the driver's deskew setting in [Configuration].
DivideLongPage Sets whether or not to divide long pages.
DigitalEndorser Sets whether the digital endorser is used.
DigitalEndorserCountDirection Sets the step direction of the digital endorser counter.
DigitalEndorserCounter Sets the default value of the digital endorser counter.
DigitalEndorserCountStep Sets the step value of the digital endorser counter.
DigitalEndorserDirection Sets the digital endorser output direction.
DigitalEndorserString Sets the digital endorser character string.
DigitalEndorserXOffset Sets the digital endorser output start position (X offset).
DigitalEndorserYOffset Sets the digital endorser output start position (Y offset).
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.
EndorserDialog Sets whether or not to display the 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.
FrontBackMergingEnabled Sets whether or not to merge the front and back side images.
FrontBackMergingLocation Sets the way of merging the front and back side images.
FrontBackMergingRotation Sets the angle to rotate the back side when merging the front
and back side images.
FrontBackMergingTarget Sets a type of document whose front and back side images are
to be merged.
FrontBackMergingTargetMode Sets the criteria for determining a type of document whose
front and back side images are to be merged.
FrontBackMergingTargetSize Sets the length for the criteria for determining a type of
document whose front and back side images are to be merged.
HwAutomaticDeskew Specify whether to have document skew automatically
corrected when documents are fed.
HwCompression Sets the transfer mode in the hardware.
JobControl Specifies the job when detecting a special document
(document in a particular shape).
JobControlMode Sets the type of job control document.
LengthDetection Sets paper end detection, background color, and overscan
simultaneously.

24
 Property name Description
Properties relating to behavior
ManualFeedMode Switches to Manual Feed Mode.
MultiFeed Sets the multifeed detection function (“MultiFeed” refers to the
phenomenon, when two or more sheets of paper are fed at one
time).

MultiFeedModeChangeSize Specifies the paper length to disable multifeed detection.

MultiFeedNotice Sets whether or not to use the multifeed notification function.
OverScan Set overscan.
PaperProtection Detects document feeding errors.
PatchCodeDetection Sets patch code detection.
PatchCodeDirection Sets the direction of the patch code that is detected.
PatchCodeType Sets the type of patch code that is detected.
PunchHoleRemoval Sets removal of punch holes.
PunchHoleRemovalMode Sets which type of punch holes to be removed.
Rotation Specifies the rotation angle for a scanned image.
SelectOutputSize Select the method for specifying the output size 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 documents are
detected during scanning by feeder.
SynchronizationDigitalEndorser Sets the endorser/imprinter and digital endorser
synchronization function.
UndefinedScanning Sets the undefined scanning.
Unit Set units (inch/centimeter/pixel).

25
7.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.

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

Default
Describes the value for RICOH Scanner Control SDK, 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.
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.

26
7.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
ricoh.fiscanner.adjustRGB

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "AdjustRGB1"
for the 1st image, "AdjustRGB2" for 2nd image, and "AdjustRGB3" for the 3rd image to set
this property.

Target method
StartScan

Related Properties
AdjustRGBB
AdjustRGBG
AdjustRGBR
PaperSupply
PixelType
ScanMode
sRGB

Value Setting
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.

Compatibility and Restraints

N/A

27
7.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
ricoh.fiscanner.adjustRGBB

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "AdjustRGBB1"
for the 1st image, "AdjustRGBB2" for 2nd image, and "AdjustRGBB3" for the 3rd image to
set this property.

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBG
AdjustRGBR

Value Setting
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.

Compatibility and Restraints

N/A

28
7.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
ricoh.fiscanner.adjustRGBG

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "AdjustRGBG1"
for the 1st image, "AdjustRGBG2" for 2nd image, and "AdjustRGBG3" for the 3rd image to
set this property.

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB
AdjustRGBR

Value Setting
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.

Compatibility and Restraints

N/A

29
7.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
ricoh.fiscanner.adjustRGBR

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "AdjustRGBR1"
for the 1st image, "AdjustRGBR2" for 2nd image, and "AdjustRGBR3" for the 3rd image to
set this property.

Target method
StartScan

Related Properties
AdjustRGB
AdjustRGBB
AdjustRGBG

Value Setting
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.

Compatibility and Restraints

N/A

30
7.1.7 ADTCThreshold .... Automatic (advanced) binary threshold
Feature
Sets the automatic (advanced) binary threshold.

Coding Style
ricoh.fiscanner.aDTCThreshold

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".

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ADTCThreshold1" for the 1st image, "ADTCThreshold2" for 2nd image, and
"ADTCThreshold3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PaperSupply
Threshold

Value Setting
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

31
7.1.8 AIQCNotice .... Automatic Image Quality Checker setting
Feature
Sets whether Automatic Image Quality Checker is used.

Coding Style
ricoh.fiscanner.aIQCNotice

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".

Target method
StartScan

Related Properties
AutoBorderDetection
BackgroundColor
PaperSupply

Value Setting
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

32
7.1.9 AutoBorderDetection .... automatic border detection
Feature
Sets the automatic document size detection function.

Coding Style
ricoh.fiscanner.autoBorderDetection

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.

Target method
StartScan

Related Properties
AutoProfile
BackgroundColor
Deskew
DivideLongPage
LengthDetection
OverScan
PaperSupply
UndefinedScanning

Value Setting
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.

Compatibility and Restraints

N/A

33
7.1.10 AutoBright .... Automatic adjustment of brightness-related image quality
Feature
Sets the automatic adjustment of the brightness-related image quality.

Coding Style
ricoh.fiscanner.autoBright

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "AutoBright1" for
the 1st image, "AutoBright2" for 2nd image, and "AutoBright3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
PaperSupply
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

34
7.1.11 AutomaticColorBackground
.... setting auto color detection which ignores background color
Feature
Sets auto color detection which ignores background color.

Coding Style
ricoh.fiscanner.automaticColorBackground

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.

Target method
StartScan

Related Properties
AutoProfile
PixelType

Value Setting
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.

Compatibility and Restraints

N/A

35
7.1.12 AutomaticColorSensitivity .... Sensitivity for auto color detection
Feature
Sets the sensitivity for auto color detection.

Coding Style
ricoh.fiscanner.automaticColorSensitivity

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.

Target method
StartScan

Related Properties
AutoProfile
PaperSupply
PixelType

Value Setting
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.

Compatibility and Restraints

N/A

36
7.1.13 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
ricoh.fiscanner.automaticRotateMode

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.

Target method
StartScan

Related Properties
AutoBorderDetection
CustomPaperLength
LongPage
PaperSize
PaperSupply
Rotation

Value Setting
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.

Compatibility and Restraints

N/A

37
7.1.14 AutomaticSenseMedium .... ADF/FB automatic switching
Feature
Sets automatic switching for the ADF/FB feeding method.

Coding Style
ricoh.fiscanner.automaticSenseMedium

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.

Target method
StartScan

Related Properties
DivideLongPage
FrontBackMergingEnabled
PaperSupply

Value Setting
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.

Compatibility and Restraints

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

38
7.1.15 AutoProfile .... Applying a profile automatically

Feature
Sets whether to apply a profile automatically.

Coding Style
ricoh.fiscanner.autoProfile

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.
・"4 - Automatic" is set for the Rotation property.

Target method
StartScan

Related Properties
AutoProfileSensitivity
MultiStreamMode

Value Setting
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.

Compatibility and Restraints

N/A

39
7.1.16 AutoProfileSensitivity .... Sensitivity level for identifying forms

Feature
Specifies the sensitivity level for identifying a form when a profile is applied automatically.

Coding Style
ricoh.fiscanner.autoProfileSensitivity

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 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.

Compatibility and Restraints

N/A

40
7.1.17 Background .... background tracking
Feature
Sets the background tracking.

Coding Style
ricoh.fiscanner.background

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"Background1" for the 1st image, "Background2" for 2nd image, and "Background3" for
the 3rd image to set this property.

Target method
StartScan

Related Properties
N/A

Value Setting
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.

Compatibility and Restraints

N/A

41
7.1.18 BackgroundColor .... setting the background color (black or white background)

Feature
Sets the background color (black or white background)

Coding Style
ricoh.fiscanner.backgroundColor

Value
0 – OFF No
1 – ON Yes (Black or White)

Default
0 – OFF No

Explanation
Sets the background color at the time of ADF scanning.

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
LengthDetection
OverScan
PaperSupply
PunchHoleRemoval
UndefinedScanning

Value Setting
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.

Compatibility and Restraints

N/A

42
7.1.19 BackgroundSmoothing .... Background color smoothing(Color cleanup)

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

Coding Style
ricoh.fiscanner.backgroundSmoothing

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"BackgrounSmoothing1" for the 1st image, "BackgrounSmoothing2" for 2nd image, and
"BackgrounSmoothing3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType

Value Setting
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.

Compatibility and Restraints

N/A

43
7.1.20 BackgroundSmoothness
.... Background color smoothness(Color cleanup smoothness)

Feature
Sets the smoothness level of the background color.

Coding Style
ricoh.fiscanner.backgroundSmoothness

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"BackgroundSmoothness1" for the 1st image, "BackgroundSmoothness2" for 2nd image,
and "BackgroundSmoothness3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
BackgroundSmoothing

Value Setting
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.

Compatibility and Restraints

N/A

44
7.1.21 BackgroundThreshold .... Background color threshold

Feature
Sets the background threshold.

Coding Style
ricoh.fiscanner.backgroundThreshold

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"BackgroundThreshold1" for the 1st image, "BackgroundThreshold2" for 2nd image, and
"BackgroundThreshold3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

45
7.1.22 BarcodeDetection .... Barcode detection
Feature
Sets barcode detection.

Coding Style
ricoh.fiscanner.barcodeDetection

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 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.

Compatibility and Restraints

N/A

46
7.1.23 BarcodeDirection .... Barcode detection direction setting
Feature
Sets the direction of the barcode that is detected.

Coding Style
ricoh.fiscanner.barcodeDirection

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.

Target method
StartScan

Related Properties
BarcodeDetection

Value Setting
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.

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.barcodeMaxSearchPriorities

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.

Target method
StartScan

Related Properties
BarcodeDetection

Value Setting
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.

Compatibility and Restraints

N/A

48
7.1.25 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
ricoh.fiscanner.barcodeNotDetectionNotice

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 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

49
7.1.26 BarcodeRegionLeft .... Barcode detection area left edge position
Feature
Sets the left edge position of the barcode detection area.

Coding Style
ricoh.fiscanner.barcodeRegionLeft

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.

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLength
BarcodeRegionTop
BarcodeRegionWidth
Unit

Value Setting
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

50
7.1.27 BarcodeRegionLength .... Barcode detection area length
Feature
Sets the length of the barcode detection area.

Coding Style
ricoh.fiscanner.barcodeRegionLength

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.

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLeft
BarcodeRegionTop
BarcodeRegionWidth
Unit

Value Setting
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

51
7.1.28 BarcodeRegionTop .... Barcode detection area top edge position
Feature
Sets the top edge position of the barcode detection area.

Coding Style
ricoh.fiscanner.barcodeRegionTop

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.

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionWidth
Unit

Value Setting
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

52
7.1.29 BarcodeRegionWidth .... Barcode detection area width
Feature
Sets the width of the barcode detection area.

Coding Style
ricoh.fiscanner.barcodeRegionWidth

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.

Target method
StartScan

Related Properties
CustomPaperWidth
CustomPaperLength
PaperSize
PaperSupply
BarcodeDetection
BarcodeRegionLeft
BarcodeRegionLength
BarcodeRegionTop
Unit

Value Setting
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

53
7.1.30 BarcodeType .... Barcode type setting
Feature
Sets the type of barcode that is detected.

Coding Style
ricoh.fiscanner.barcodeType

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.

Target method
StartScan

Related Properties
BarcodeDetection

Value Setting
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.

Compatibility and Restraints

N/A

54
7.1.31 Binding .... duplex binding direction

Feature
Sets the binding direction for duplex scanning.

Coding Style
ricoh.fiscanner.binding

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.

Target method
StartScan

Related Properties
PaperSupply
Rotation

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

55
7.1.32 BlankPageIgnoreAreaSize .... Sides undetected during blank page detection

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

Coding Style
ricoh.fiscanner.blankPageIgnoreAreaSize

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.

Target method
StartScan

Related Properties
BlankPageSkip
BlankPageSkipMode
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
When implemented.

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

Compatibility and Restraints

N/A

56
7.1.33 BlankPageNotice .... Output blank page setting
Feature
Sets whether a blank page is output or not.

Coding Style
ricoh.fiscanner.blankPageNotice

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.

Target method
StartScan

Related Properties
BlankPageSkip
PaperSupply

Value Setting
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.blankPageSkip

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.

Target method
StartScan

Related Properties
BlankPageSkipMode
DivideLongPage
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
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.

Compatibility and Restraints

N/A

58
7.1.35 BlankPageSkipMode .... Blank page skip mode
Feature
Sets a criteria for detecting blank pages.

Coding Style
ricoh.fiscanner.blankPageSkipMode

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.

Target method
StartScan

Related Properties
BlankPageSkip
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
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.

Compatibility and Restraints

N/A

59
7.1.36 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
ricoh.fiscanner.blankPageSkipTabPage

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.

Target method
StartScan

Related Properties
AutoBorderDetection
BlankPageSkip
BlankPageSkipMode
PaperSupply
SkipBlackPage
SkipWhitePage

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

60
7.1.37 Brightness .... brightness
Feature
Specifies the brightness.

Coding Style
ricoh.fiscanner.brightness

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

Default
128

Explanation
Sets the brightness of images when scanning.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Brightness1" for
the 1st image, "Brightness2" for 2nd image, and "Brightness3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
AutoBright
Gamma
Halftone
PixelType
PaperSupply
SEE
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

61
7.1.38 CarrierSheetClippingMode .... Carrier Sheet clipping mode
Feature
Sets the mode for clipping the Carrier Sheet.

Coding Style
ricoh.fiscanner.carrierSheetClippingMode

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.

Target method
StartScan

Related Properties
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

62
7.1.39 CharacterExtraction .... Extracting characters
Feature
Sets whether to extract characters or not.

Coding Style
ricoh.fiscanner.characterExtraction

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"CharacterExtraction1" for the 1st image, "CharacterExtraction2" for 2nd image, and
"CharacterExtraction3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
CharacterExtractionMethod
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

63
7.1.40 CharacterExtractionMethod .... Setting the type of character extractions
Feature
Sets the type of character extractions.

Coding Style
ricoh.fiscanner.characterExtractionMethod

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"CharacterExtractionMethod1" for the 1st image, "CharacterExtractionMethod2" for 2nd
image, and "CharacterExtractionMethod3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
CharacterExtraction

Value Setting
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.

Compatibility and Restraints

N/A

64
7.1.41 CharacterThickness
.... Dynamic Threshold (iDTC) binary character thickness setting
Feature
Sets the thickness of the Dynamic Threshold (iDTC) binary character.

Coding Style
ricoh.fiscanner.characterThickness

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"CharacterThickness1" for the 1st image, "CharacterThickness2" for 2nd image, and
"CharacterThickness3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

65
7.1.42 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
ricoh.fiscanner.closeSourceUI

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."

Target method
StartScan

Related Properties
ShowSourceUI

Value Setting
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

66
7.1.43 ColorReproduction .... Color reproduction

Feature
Sets the color reproduction.

Coding Style
ricoh.fiscanner.colorReproduction

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ColorReproduction1" for the 1st image, "ColorReproduction2" for 2nd image, and
"ColorReproduction3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow
PaperSupply
PixelType
ScanMode
sRGB

Value Setting
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.

Compatibility and Restraints

N/A

67
7.1.44 ColorReproductionBrightness .... Brightness when a color hue is prioritized

Feature
Specifies the brightness when a color hue is prioritized.

Coding Style
ricoh.fiscanner.colorReproductionBrightness

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ColorReproductionBrightness1" for the 1st image, "ColorReproductionBrightness2" for 2nd
image, and "ColorReproductionBrightness3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow

Value Setting
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.

Compatibility and Restraints

N/A

68
7.1.45 ColorReproductionContrast .... Color contrast when a color hue is prioritized

Feature
Specifies the color contrast when a color hue is prioritized.

Coding Style
ricoh.fiscanner.colorReproductionContrast

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ColorReproductionContrast1" for the 1st image, "ColorReproductionContrast2" for 2nd
image, and "ColorReproductionContrast3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionCustomGamma
ColorReproductionHighlight
ColorReproductionShadow

Value Setting
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.

Compatibility and Restraints

N/A

69
7.1.46 ColorReproductionCustomGamma
.... Gamma value when a color hue is prioritized

Feature
Specifies the gamma value when a color hue is prioritized.

Coding Style
ricoh.fiscanner.colorReproductionCustomGamma

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ColorReproductionCustomGamma1" for the 1st image,
"ColorReproductionCustomGamma2" for 2nd image, and
"ColorReproductionCustomGamma3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionHighlight
ColorReproductionShadow

Value Setting
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.

Compatibility and Restraints

N/A

70
7.1.47 ColorReproductionHighlight .... Highlight when a color hue is prioritized

Feature
Specifies a highlight when a color hue is prioritized.

Coding Style
ricoh.fiscanner.colorReproductionHighlight

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ColorReproductionHighlight1" for the 1st image, "ColorReproductionHighlight2" for 2nd
image, and "ColorReproductionHighlight3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionShadow

Value Setting
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.

Compatibility and Restraints

N/A

71
7.1.48 ColorReproductionShadow .... Shadow when a color hue is prioritized

Feature
Specifies a shadow when a color hue is prioritized.

Coding Style
ricoh.fiscanner.colorReproductionShadow

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"ColorReproductionShadow1" for the 1st image, "ColorReproductionShadow2" for 2nd
image, and "ColorReproductionShadow3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
ColorReproduction
ColorReproductionBrightness
ColorReproductionContrast
ColorReproductionCustomGamma
ColorReproductionHighlight

Value Setting
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.

Compatibility and Restraints

N/A

72
7.1.49 CompressionType .... data compression type
Feature
Sets the data compression type,

Coding Style
ricoh.fiscanner.compressionType

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

Default
4 - CCITT G4 MMR compression

Explanation
Specifies the data compression type.
This property is enabled when the FileType property is set to "1 - TIF," "2 - Multipage TIF," "4
- PDF" or "5 - Multipage PDF". 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.

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 Web API,
this property operates as it is set to "3 - CCITT G3(2D) Kfactor = 4".

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"CompressionType1" for the 1st image, "CompressionType2" for 2nd image, and
"CompressionType3" for the 3rd image to set this property.

Target method
StartScan

73
Related Properties
FileType
JpegQuality
PaperSupply
PixelType

Value Setting
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

74
7.1.50 Contrast .... contrast
Feature
Sets the contrast.

Coding Style
ricoh.fiscanner.contrast

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Contrast1" for
the 1st image, "Contrast2" for 2nd image, and "Contrast3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
AutoBright
Gamma
PaperSupply
PixelType
Threshold

Value Setting
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

75
7.1.51 CropMarginSize .... Sizes of cropping margins
Feature
Specifies the sizes of cropping margins.

Coding Style
ricoh.fiscanner.cropMarginSize

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".

Target method
StartScan

Related Properties
AutoBorderDetection
FrontBackMergingEnabled
SelectOutputSize
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

76
7.1.52 CropPriority .... Priority setting during automatic paper size detection
Feature
Sets the priority during automatic paper size detection.

Coding Style
ricoh.fiscanner.cropPriority

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".

Target method
StartScan

Related Properties
AutoBorderDetection
PaperSupply
ScanMode

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

77
7.1.53 CustomGamma .... custom gamma
Feature
Specifies the gamma value.

Coding Style
ricoh.fiscanner.customGamma

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.)

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"CustomGamma1" for the 1st image, "CustomGamma2" for 2nd image, and
"CustomGamma3" for the 3rd image to set this property.

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

Value Setting
When implemented. >1

Value Reference 0(light) 255

input
When implemented. (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.

Compatibility and Restraints

N/A

78
7.1.54 CustomPaperLength .... custom document length
Feature
Sets the length of a custom-sized document.

Coding Style
ricoh.fiscanner.customPaperLength

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)."

Target method
StartScan

Related Properties
AutoProfile
FrontBackMergingEnabled
LongPage
PaperSize
PaperSupply
Unit

Value Setting
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.
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

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.

79
7.1.55 CustomPaperWidth .... custom document width
Feature
Sets the width of a custom-sized document.

Coding Style
ricoh.fiscanner.customPaperWidth

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)."

Target method
StartScan

Related Properties
PaperSize
PaperSupply
Unit

Value Setting
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.
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

80
7.1.56 CustomResolution .... custom resolution
Feature
Specifies the scan resolution.

Coding Style
ricoh.fiscanner.customResolution

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"CustomResolution1" for the 1st image, "CustomResolution2" for 2nd image, and
"CustomResolution3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
Resolution
PaperSize
PixelType

Value Setting
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.

Compatibility and Restraints

N/A

81
7.1.57 Deskew .... Skew correction
Feature
Sets the skew correction.

Coding Style
ricoh.fiscanner.deskew

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.

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
DivideLongPage
FrontBackMergingEnabled
LengthDetection
OverScan
PaperSupply
UndefinedScanning

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

82
7.1.58 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
ricoh.fiscanner.deskewBackground

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".

Target method
StartScan

Related Properties
Deskew
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.deskewMode

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.

Target method
StartScan

Related Properties
Deskew

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

84
7.1.60 DigitalEndorser .... Digital endorser setting
Feature
Sets whether the digital endorser is used.

Coding Style
ricoh.fiscanner.digitalEndorser

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.

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

85
7.1.61 DigitalEndorserCountDirection
.... Digital endorser counter step direction setting
Feature
Sets the step direction of the digital endorser counter.

Coding Style
ricoh.fiscanner.digitalEndorserCountDirection

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".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

86
7.1.62 DigitalEndorserCounter .... Digital endorser counter default value setting
Feature
Sets the default value of the digital endorser counter.

Coding Style
ricoh.fiscanner.digitalEndorserCounter

Value
Value in the range from -1 and 0 to 99999999
When -1 is set, the 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".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
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.

87
7.1.63 DigitalEndorserCountStep .... Digital endorser counter step value setting
Feature
Sets the step value of the digital endorser counter.

Coding Style
ricoh.fiscanner.digitalEndorserCountStep

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".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

88
7.1.64 DigitalEndorserDirection .... Digital endorser output direction setting
Feature
Sets the output direction for the digital endorser.

Coding Style
ricoh.fiscanner.digitalEndorserDirection

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".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserString
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
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
7.1.65 DigitalEndorserString .... Digital endorser character string setting
Feature
Sets the digital endorser character string.

Coding Style
ricoh.fiscanner.digitalEndorserString

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".

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserXOffset
DigitalEndorserYOffset

Value Setting
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 outputed.

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.digitalEndorserXOffset

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 outputtable area for the digital endorser, refer to the Help for the driver.

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserYOffset
Unit

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.digitalEndorserYOffset

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 outputtable area for the digital endorser, refer to the Help for the driver.

Target method
StartScan

Related Properties
DigitalEndorser
DigitalEndorserCountDirection
DigitalEndorserCounter
DigitalEndorserCountStep
DigitalEndorserDirection
DigitalEndorserString
DigitalEndorserXOffset
Unit

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

92
7.1.68 DivideLongPage .... Dividing long pages
Feature
Sets whether or not to divide long pages.

Coding Style
ricoh.fiscanner.divideLongPage

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.

Target method
StartScan

Related Properties
AutoProfile
MultiStreamMode
PaperSize

Value Setting
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.

Compatibility and Restraints

N/A

93
7.1.69 DTCSensitivity .... Dynamic Threshold (iDTC) binary sensitivity setting
Feature
Sets the Dynamic Threshold (iDTC) binary sensitivity.

Coding Style
ricoh.fiscanner.dTCSensitivity

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"DTCSensitivity1" for the 1st image, "DTCSensitivity2" for 2nd image, and "DTCSensitivity3"
for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

94
7.1.70 EdgeFiller .... Edge filler
Feature
Sets the edge filler.

Coding Style
ricoh.fiscanner.edgeFiller

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.

Target method
StartScan

Related Properties
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

95
7.1.71 EdgeFillerBottom .... Edge filler bottom edge area setting
Feature
Sets the edge filler area at the bottom edge of the paper size.

Coding Style
ricoh.fiscanner.edgeFillerBottom

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".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
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.

Compatibility and Restraints

N/A

96
7.1.72 EdgeFillerLeft .... Edge filler left edge area setting
Feature
Sets the edge filler area at the left edge of the paper size.

Coding Style
ricoh.fiscanner.edgeFillerLeft

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".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
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.

Compatibility and Restraints

N/A

97
7.1.73 EdgeFillerRight .... Edge filler right edge area setting
Feature
Sets the edge filler area at the right edge of the paper size.

Coding Style
ricoh.fiscanner.edgeFillerRight

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".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
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.

Compatibility and Restraints

N/A

98
7.1.74 EdgeFillerTop .... Edge filler top edge area setting
Feature
Sets the edge filler area at the top edge of the paper size.

Coding Style
ricoh.fiscanner.edgeFillerTop

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".

Target method
StartScan

Related Properties
PaperSupply
EdgeFiller
Unit

Value Setting
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.

Compatibility and Restraints

N/A

99
7.1.75 EdgeRepair .... Edge filler repair
Feature
Sets the edge filler repair.

Coding Style
ricoh.fiscanner.edgeRepair

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.

Target method
StartScan

Related Properties
AutoBorderDetection
DivideLongPage
FrontBackMergingEnabled
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

100
7.1.76 Endorser .... Endorser / Imprinter setting
Feature
Sets whether or not to use the endorser/imprinter.

Coding Style
ricoh.fiscanner.endorser

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 side)/Post-endorser (front side) and
Post-imprinter (back side)/Post-endorser (back side). If these two types of
imprinters/endorsers are installed together, the Post-imprinter (front side)/Post-endorser
(front side) has higher priority than the Post-imprinter (back side)/Post-endorser (back side)
for printing;

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
If this property cannot be enabled depending on device type, sets it to "false" when scanning
to carry out a scan.

Compatibility and Restraints

N/A

101
7.1.77 EndorserCountDirection
.... Endorser / Imprinter counter step direction setting
Feature
Sets the step direction of the endorser/imprinter counter.

Coding Style
ricoh.fiscanner.endorserCountDirection

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.

Target method
StartScan

Related Properties
Endorser
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserFont
EndorserOffset
EndorserString

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

102
7.1.78 EndorserCounter .... Endorser / Imprinter counter default setting
Feature
Sets the default of the endorser/imprinter counter.

Coding Style
ricoh.fiscanner.endorserCounter

Value
Values in the range of -1 and 0 to 99999999
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.
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.
This property is enabled only when the Endorser property is set to "true."
Enabled for scanners with an endorser/imprinter option.

Target method
StartScan

Related Properties
Endorser
EndorserCounterDirection
EndorserCountStep
EndorserDirection
EndorserFont
EndorserOffset
EndorserString

Value Setting
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.
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.

103
7.1.79 EndorserCountStep .... Endorser / Imprinter counter step count setting
Feature
Sets the step count of the endorser/imprinter counter.

Coding Style
ricoh.fiscanner.endorserCountStep

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.

Target method
StartScan

Related Properties
Endorser
EndorserCounterDirection
EndorserCounter
EndorserDirection
EndorserFont
EndorserOffset
EndorserString

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.endorserDialog

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.
For details on the displayed window, refer to the driver help.

Target method
StartScan

Related Properties
Endorser

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

105
7.1.81 EndorserDirection .... Endorser / Imprinter print direction setting
Feature
Sets the print direction of the endorser/imprinter.

Coding Style
ricoh.fiscanner.endorserDirection

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 counter 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.

Target method
StartScan

Related Properties
Endorser
EndorserCounterDirection
EndorserCounter
EndorserCountStep
EndorserFont
EndorserOffset
EndorserString

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

106
7.1.82 EndorserFont .... Endorser / Imprinter print font setting
Feature
Sets the print font of the endorser/imprinter.

Coding Style
ricoh.fiscanner.endorserFont

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.

Target method
StartScan

Related Properties
Endorser
EndorserCounterDirection
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserOffset
EndorserString

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

107
7.1.83 EndorserOffset .... Endorser / Imprinter print position setting
Feature
Sets the print start position of the endorser/imprinter.

Coding Style
ricoh.fiscanner.endorserOffset

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.
For the printable area of the endorser/imprinter, refer to the User's Guide for your device.

Target method
StartScan

Related Properties
Endorser
EndorserCounterDirection
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserFont
EndorserString
Unit

Value Setting
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

108
7.1.84 EndorserString .... Endorser / Imprinter string setting
Feature
Sets the string for the endorser/imprinter.

Coding Style
ricoh.fiscanner.endorserString

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.
For the maximum number of characters for the endorser/imprinter, refer to the User's Guide
for your device.

Target method
StartScan

Related Properties
Endorser
EndorserCounterDirection
EndorserCounter
EndorserCountStep
EndorserDirection
EndorserFont
EndorserOffset

Value Setting
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.

Compatibility and Restraints

N/A

109
7.1.85 ErrorCode .... error information acquisition
Feature
Gets error information.

Coding Style
ricoh.fiscanner.errorCode

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.
For a list of errors, refer to the RICOH Scanner Control SDK manual.

Target method
All methods.

Related Properties
SilentMode

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
For how to handle errors, refer to the RICOH Scanner Control SDK manual.

Compatibility and Restraints

-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.

110
7.1.86 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
ricoh.fiscanner.fadingCompensation

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"FadingCompensation1" for the 1st image, "FadingCompensation2" for 2nd image, and
"FadingCompensation3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

111
7.1.87 FileCounter .... file serial number setting

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

Coding Style
ricoh.fiscanner.fileCounter

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property and "1 – ON" is set
for the MultiStreamFileNameMode property, use "FileCounter1" for the 1st image,
"FileCounter2" for the 2nd image, and "FileCounter3" for the 3rd image to set this property.
In addition, use the FileName1, FileName2, and FileName3 properties together.

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
FileCounterEx
FileName
FileType
MultiStreamFileNameMode
MultiStreamMode
ScanCount

Value Setting
When implemented.

Value Reference
When implemented.

112
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 is provided for compatibility with applications developed using the WebAPI
prior to 1.6.0. However, compatibility may not be guaranteed at a future major version
upgrade. When creating a new application or when fixing a program, use the FileCounterEx
property instead of FileCounter.

113
7.1.88 FileCounterEx .... file serial number setting

Feature
Sets the serial numbers of files.

Coding Style
ricoh.fiscanner.fileCounterEx

Value
Value in the range from -2, -1 and 0 to 99999999
If -2 is set, the serial number setting is not used.
If -1 is set, the 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 serial number is not set for the file name, and only the file
name is used.
If "-1" is set for this property, a serial number is set by the FileCounter property.
If “0” to “99999999” is set for this property, the FileCounter property value is not used.

If a value other than "0 - OFF" is set for the MultiStreamMode property and "1 – ON" is set
for the MultiStreamFileNameMode property, use "FileCounterEx1" for the 1st image,
"FileCounterEx2" for the 2nd image, and "FileCounterEx3" for the 3rd image to set this
property. In addition, use the FileName1, FileName2, and FileName3 properties together.

Target method
StartScan
OpenScanner
OpenScanner2

Related Properties
FileCounter
FileName
FileType
MultiStreamFileNameMode
MultiStreamMode
ScanCount

Value Setting
When implemented.

Value Reference
When implemented.

114
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

N/A

115
7.1.89 FileName .... file name
Feature
Sets the file name for storing the image. (Extension not included)

Coding Style
ricoh.fiscanner.fileName

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.

Default
"" (empty character string)

Explanation
Sets the file name to be output (does not need to set extension).
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

If a value other than "0 - OFF" is set for the MultiStreamMode property and "1 – ON" is set
for the MultiStreamFileNameMode property, use "FileName1" for the 1st image, "FileName2"
for the 2nd image, and "FileName3" for the 3rd image to set this property. In addition, use
the FileCounterEx1, FileCounterEx2, and FileCounterEx3 properties together.

116
Target method
StartScan

Related Properties
FileCounterEx
FileType
MultiStreamFileNameMode
MultiStreamMode
Overwrite

Value Setting
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 0x00000020:EC_CANNOT_MAKE and returns -1:
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.

117
7.1.90 FileType .... file format (image data format)
Feature
Sets the file format .

Coding Style
ricoh.fiscanner.fileType

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.
-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" or "5 - 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 in the driver.
- 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
driver.
- 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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "FileType1" for
the 1st image, "FileType2" for 2nd image, and "FileType3" for the 3rd image to set this

118
property.

Target method
StartScan

Related Properties
AutoProfile
CompressionType
PixelType
JpegQuality
ScanCount

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

119
7.1.91 Filter .... dropout color
Feature
Sets the dropout color.

Coding Style
ricoh.fiscanner.filter

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 driver.
This property is enabled only when the PixelType property is set to "0 - Black & White" or "1 -
Grayscale." Otherwise, it will be disregarded.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Filter1" for the
1st image, "Filter2" for 2nd image, and "Filter3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType

Value Setting
When implemented.

Value Reference
When implemented.

120
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.
If an unsupported value on the scanner is specified, the driver changes the setting value to
another valid one when scanning is performed.

Compatibility and Restraints

N/A

121
7.1.92 FilterSaturationSensitivity .... Chromatic dropout color sensitivity setting
Feature
Sets the chromatic dropout color sensitivity.

Coding Style
ricoh.fiscanner.filterSaturationSensitivity

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"FilterSaturationSensitivity1" for the 1st image, "FilterSaturationSensitivity2" for 2nd image,
and "FilterSaturationSensitivity3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
Filter

Value Setting
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.

Compatibility and Restraints

N/A

122
7.1.93 FrontBackDetection .... ID card automatic detection
Feature
Sets the ID card automatic detection setting.

Coding Style
ricoh.fiscanner.frontBackDetection

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.

Target method
StartScan

Related Properties
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

123
7.1.94 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
ricoh.fiscanner.frontBackMergingEnabled

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 240inch” 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".

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
MultiStreamMode

Value Setting
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.

Compatibility and Restraints

N/A

124
7.1.95 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
ricoh.fiscanner.frontBackMergingLocation

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

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingRotation

Value Setting
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".

Compatibility and Restraints

N/A

125
7.1.96 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
ricoh.fiscanner.frontBackMergingRotation

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“
Back Front Front

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingLocation

Value Setting
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".

Compatibility and Restraints

N/A

126
7.1.97 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
ricoh.fiscanner.frontBackMergingTarget

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".

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingTargetMode
FrontBackMergingTargetSize

Value Setting
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.

Compatibility and Restraints

N/A

127
7.1.98 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
ricoh.fiscanner.frontBackMergingTargetMode

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.

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingTarget
FrontBackMergingTargetSize

Value Setting
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.

Compatibility and Restraints

N/A

128
7.1.99 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
ricoh.fiscanner.frontBackMergingTargetSize

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.

Target method
StartScan

Related Properties
FrontBackMergingEnabled
FrontBackMergingTarget
FrontBackMergingTargetMode
Unit

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

129
7.1.100 Gamma .... gamma adjustment
Feature
Sets the gamma adjustment mode.

Coding Style
ricoh.fiscanner.gamma

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Gamma1" for
the 1st image, "Gamma2" for 2nd image, and "Gamma3" for the 3rd image to set this
property.

Default
0 - None

Target method
StartScan

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

Value Setting
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.

Compatibility and Restraints

N/A

130
7.1.101 GammaFile .... gamma pattern file name
Feature
Specifies the gamma pattern file.

Coding Style
ricoh.fiscanner.gammaFile

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 driver.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "GammaFile1"
for the 1st image, "GammaFile2" for 2nd image, and "GammaFile3" for the 3rd image to set
this property.

Target method
StartScan

Related Properties
Gamma

Value Setting
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

131
7.1.102 Halftone .... halftone
Feature
Sets the halftone pattern.

Coding Style
ricoh.fiscanner.halftone

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Halftone1" for
the 1st image, "Halftone2" for 2nd image, and "Halftone3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
CompressionType
PixelType
HalftoneFile

Value Setting
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.

Compatibility and Restraints

N/A

132
7.1.103 HalftoneFile .... halftone pattern file
Feature
Specifies the halftone pattern file.

Coding Style
ricoh.fiscanner.halftoneFile

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 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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "HalftoneFile1"
for the 1st image, "HalftoneFile2" for 2nd image, and "HalftoneFile3" for the 3rd image to set
this property.

Target method
StartScan

Related Properties
PixelType
Halftone

Value Setting
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.

Compatibility and Restraints

N/A

133
7.1.104 Highlight .... highlight
Feature
Sets highlights.

Coding Style
ricoh.fiscanner.highlight

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)".

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Highlight1" for
the 1st image, "Highlight2" for 2nd image, and "Highlight3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
AutoBright
Gamma
PaperSupply
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

134
7.1.105 HwAutomaticDeskew .... Automatic Skew Correction

Feature
Specify whether to have document skew automatically corrected when documents are fed.

Coding Style
ricoh.fiscanner.hwAutomaticDeskew

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 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.

Compatibility and Restraints

N/A

135
7.1.106 HwCompression .... Transfer mode of the hardware
Feature
Sets the transfer mode of the hardware.

Coding Style
ricoh.fiscanner.hwCompression

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 implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

136
7.1.107 HwMoireReductionMode .... Moire Reduction(Advanced)
Feature
Specify whether to adjust the scanning speed of the scanner to suppress moire (vertical
streaks) appearing on the images.

Coding Style
ricoh.fiscanner.hwMoireReductionMode

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.

Target method
StartScan

Related Properties
PaperSize
Resolution

Value Setting
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.

Compatibility and Restraints

N/A

137
7.1.108 ImageScanner .... image scanner name acquisition
Feature
Gets the product name of the image scanner.

Coding Style
ricoh.fiscanner.imageScanner

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.)

138
7.1.109 Indicator .... progress indicator setting
Feature
Sets whether to show the progress indicator while scanning.

Coding Style
ricoh.fiscanner.indicator

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 implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.isExistsFB

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.)

140
7.1.111 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
ricoh.fiscanner.jobControl

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 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 the first document to be scanned on a special document or patch code 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
JobControlMode
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

141
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.
* For the details of special documents, refer to the User's Guide for your device.

Compatibility and Restraints

N/A

142
7.1.112 JobControlMode .... Job control type setting
Feature
Sets the type of job control document.

Coding Style
ricoh.fiscanner.jobControlMode

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 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.

Compatibility and Restrictions

N/A

143
7.1.113 JpegQuality .... Jpeg data compression level
Feature
Specifies the JPEG data compression level.

Coding Style
ricoh.fiscanner.jpegQuality

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 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." Otherwise, it will be disregarded.

Target method
StartScan

Related Properties
FileType
PixelType
CompressionType

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.lengthDetection

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.

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
BackgroundColor
Deskew
DivideLongPage
FrontBackMergingEnabled
OverScan
PaperSupply
UndefinedScanning

Value Setting
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.

Compatibility and Restraints

N/A

145
7.1.115 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
ricoh.fiscanner.longPage

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.

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
FrontBackMergingEnabled
PaperSize
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
Disregarded when any value other than "99 - Custom" is specified for the PaperSize
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.

Compatibility and Restraints

N/A

146
7.1.116 ManualFeedMode .... Manual Feed Mode

Feature
Switches to Manual Feed Mode.

Coding Style
ricoh.fiscanner.manualFeedMode

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.

Target method
StartScan

Related Properties
MutiFeed
PaperSupply

Value Setting
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.

Compatibility and Restrictions

N/A

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

Coding Style
ricoh.fiscanner.multiFeed

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 driver will be
displayed.

Target method
StartScan

Related Properties
DivideLongPage
ManualFeedMode
PaperSupply
SilentMode

Value Setting
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.

Compatibility and Restraints

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

148
7.1.118 MultiFeedModeChangeSize
.... Specifying the paper length to disable multifeed detection
Feature
Specifies the paper length to disable multifeed detection.

Coding Style
ricoh.fiscanner.multiFeedModeChangeSize

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".

Target method
StartScan

Related Properties
MultiFeed
PaperSupply
Unit

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

N/A

149
7.1.119 MultiFeedNotice .... Multifeed notification setting
Feature
Sets whether or not to use the multifeed notification function.

Coding Style
ricoh.fiscanner.multiFeedNotice

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.
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 event.

Target method
StartScan

Related Properties
MultiFeed

Value Setting
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

150
7.1.120 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
ricoh.fiscanner.multiStreamDefaultValueMode

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 the MultiStreamMode property and "3 -
400×400 [dpi]" for the Resolution property before the StartScan method and
specifying "0 - 200×200 [dpi]" for Resolution2 property

MultiStreamDefaultValueMode:OFF
1st image: Since the Resolution1 property is not set, the value before the StartScan
method is applied and the scanning outcome becomes 400 dpi.
2nd image: Since the Resolution2 property is set, the scanning outcome becomes 200
dpi.
3rd image: Since the Resolution3 property is not set, the value for the 2nd image is
applied and the scanning outcome becomes 200 dpi.

MultiStreamDefaultValueMode:ON
1st image: Since the Resolution1 property is not set, the default value is applied and the
scanning outcome becomes 300 dpi.
2nd image: Since the Resolution2 property is set, the scanning outcome becomes 200
dpi.
3rd image: Since the Resolution3 property is not set, the default value is applied and the
scanning outcome becomes 300 dpi.

151
Target method
StartScan

Related Properties
AdjustRGB1, AdjustRGB2, AdjustRGB3
AdjustRGBB1, AdjustRGBB2, AdjustRGBB3
AdjustRGBG1, AdjustRGBG2, AdjustRGBG3
AdjustRGBR1, AdjustRGBR2, AdjustRGBR3
ADTCThreshold1, ADTCThreshold2, ADTCThreshold3
AutoBright1, AutoBright2, AutoBright3
Background1 Background2, Background3
BackgroundSmoothing1 BackgroundSmoothing2, BackgroundSmoothing3
BackgroundSmoothness1, BackgroundSmoothness2, BackgroundSmoothness3
BackgroundThreshold1, BackgroundThreshold2, BackgroundThreshold3
Brightness1, Brightness2 Brightness3
CharacterExtraction1, CharacterExtraction2, CharacterExtraction3
CharacterExtractionMethod1, CharacterExtractionMethod2, CharacterExtractionMethod3
CharacterThickness1, CharacterThickness2, CharacterThickness3
ColorReproduction1, ColorReproduction2, ColorReproduction3
ColorReproductionBrightness1, ColorReproductionBrightness2,
ColorReproductionBrightness3
ColorReproductionContrast1, ColorReproductionContrast2, ColorReproductionContrast3
ColorReproductionCustomGamma1, ColorReproductionCustomGamma2,
ColorReproductionCustomGamma3
ColorReproductionHighlight1, ColorReproductionHighlight2, ColorReproductionHighlight3
ColorReproductionShadow1, ColorReproductionShadow2, ColorReproductionShadow3
CompressionType1, CompressionType2, CompressionType3
Contrast1, Contrast2, Contrast3
CustomGamma1, CustomGamma2, CustomGamma3
CustomResolution1, CustomResolution2, CustomResolution3
DTCSensitivity1, DTCSensitivity2, DTCSensitivity3
FadingCompensation1 FadingCompensation2, FadingCompensation3
FileType1, FileType2, FileType3 “0 - BMP”, “1 - TIFF”, “2 - Multipage TIFF”, “3 - JPEG”, “4 -
PDF”, “5 - Multipage PDF”
Filter1, Filter2, Filter3
FilterSaturationSensitivity1, FilterSaturationSensitivity2, FilterSaturationSensitivity3
Gamma1, Gamma2, Gamma3
GammaFile1, GammaFile2, GammaFile3
Halftone1, Halftone2, Halftone3
HalftoneFile1, HalftoneFile2, HalftoneFile3
Highlight1, Highlight2, Highlight3
MultiStreamMode
NoiseRejection1, NoiseRejection2, NoiseRejection3
PatternRemoval1, PatternRemoval2, PatternRemoval3
PixelType1, PixelType2, PixelType3 “0 - Black & White”, “1 - Grayscale”, “2 - RGB”
Resolution1, Resolution2, Resolution3
Reverse1, Reverse2, Reverse3
SDTCSensitivity1, SDTCSensitivity2, SDTCSensitivity3
SEE1, SEE2, SEE3
Shadow1, Shadow2, Shadow3
Sharpness1, Sharpness2, Sharpness3
SimpleSlicePatternRemoval1, SimpleSlicePatternRemoval2, SimpleSlicePatternRemoval3
sRGB1, sRGB2, sRGB3
Threshold1, Threshold2, Threshold3

Value Setting
When implemented.

152
Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restrictions

N/A

153
7.1.121 MultiStreamFileNameMode
.... File name and file counter settings for a file created from each outpu
image

Feature
Sets a file name and file counter for a file created from each output image.

Coding Style
ricoh.fiscanner.multiStreamFileNameMode

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.

Target method
StartScan

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

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restrictions

N/A

154
7.1.122 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
ricoh.fiscanner.multiStreamMode

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.
When a value other than "0 - OFF" is set for this property, the following properties can be set
for each images by adding 1 to 3 to the end of the property names.

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

If you want to set a file name and file counter for each output image, set "1 - ON" for the
MultiStreamFileNameMode property and use the FileName1, FileName2, FileName3,
FileCounterEx1, FileCounterEx2, and FileCounterEx3 properties.

155
If there are properties that are not set for each image, properties that were set for the
previous image are applied. (For example, if the Resolution2 property is not set, a value for
the Resolution1 property is applied. However, if a value for the Resolution1 property is not
set, a value for the Resolution property 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 Resolution2 property.
1st image: Since the Resolution1 property is not set, the value before the
StartScan method is applied and the scanning outcome
becomes 400 dpi.
2nd image: Since the Resolution2 property is set, the scanning outcome
becomes 200 dpi.
3rd image: Since the Resolution3 property is not set, the value for the 2nd
image is applied and the scanning outcome becomes 200 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.
- If values for the CompressionType property, Filetype property, and PixelType property that
are set for each image are inconsistent, the following actions take place. (The
CompressionType property should be replaced with the CompressionType1 property for
the 1st image, the CompressionType2 property for the 2nd image, and the
CompressionType3 property for the 3rd image. The Filetype property should be replaced
with the FileType1 property for the 1st image, the FileType2 property for the 2nd image,
and the FileType3 property for the 3rd image. The PixelType property should be replaced
with the PixelType1 property for the 1st image, the PixelType2 property for the 2nd image,
and the PixelType3 property for the 3rd image.)
- If "0 – Black&White" is set for the PixelType property and "3 - JPEG" is set for the
FileType property for each image, an image is output as a TIFF file.
- If "1 – Grayscale" or "2 – RGB" is set for the PixelType property for each image and a
compression setting is specified for the CompressionType property ("1 - CCITT
G3(1D)", "2 - CCITT G3(2D) KFactor = 2", "3 - CCITT G3(2D) Kfactor = 4", or "4 -
CCITTG4"), "0 - NoCompress" is used for the CompressionType property.
- When "0 – Black&White" is specified for the PixelType property, "1 - TIFF" is specified
for the FileType property, and "5 - 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
AdjustRGB1, AdjustRGB2, AdjustRGB3

156
AdjustRGBB1, AdjustRGBB2, AdjustRGBB3
AdjustRGBG1, AdjustRGBG2, AdjustRGBG3
AdjustRGBR1, AdjustRGBR2, AdjustRGBR3
ADTCThreshold1, ADTCThreshold2, ADTCThreshold3
AutoBright1, AutoBright2, AutoBright3
Background1 Background2, Background3
BackgroundSmoothing1 BackgroundSmoothing2, BackgroundSmoothing3
BackgroundSmoothness1, BackgroundSmoothness2, BackgroundSmoothness3
BackgroundThreshold1, BackgroundThreshold2, BackgroundThreshold3
Brightness1, Brightness2 Brightness3
CharacterExtraction1, CharacterExtraction2, CharacterExtraction3
CharacterExtractionMethod1, CharacterExtractionMethod2, CharacterExtractionMethod3
CharacterThickness1, CharacterThickness2, CharacterThickness3
ColorReproduction1, ColorReproduction2, ColorReproduction3
ColorReproductionBrightness1, ColorReproductionBrightness2,
ColorReproductionBrightness3
ColorReproductionContrast1, ColorReproductionContrast2, ColorReproductionContrast3
ColorReproductionCustomGamma1, ColorReproductionCustomGamma2,
ColorReproductionCustomGamma3
ColorReproductionHighlight1, ColorReproductionHighlight2, ColorReproductionHighlight3
ColorReproductionShadow1, ColorReproductionShadow2, ColorReproductionShadow3
CompressionType1, CompressionType2, CompressionType3
Contrast1, Contrast2, Contrast3
CustomGamma1, CustomGamma2, CustomGamma3
CustomResolution1, CustomResolution2, CustomResolution3
DTCSensitivity1, DTCSensitivity2, DTCSensitivity3
FadingCompensation1 FadingCompensation2, FadingCompensation3
FileCounterEx1, FileCounterEx2, FileCounterEx3
FileName1, FileName2, FileName3
FileType1, FileType2, FileType3 “0 - BMP”, “1 - TIFF”, “2 - Multipage TIFF”, “3 - JPEG”, “4 -
PDF”, “5 - Multipage PDF”
Filter1, Filter2, Filter3
FilterSaturationSensitivity1, FilterSaturationSensitivity2, FilterSaturationSensitivity3
Gamma1, Gamma2, Gamma3
GammaFile1, GammaFile2, GammaFile3
Halftone1, Halftone2, Halftone3
HalftoneFile1, HalftoneFile2, HalftoneFile3
Highlight1, Highlight2, Highlight3
MultiStreamDefaultValueMode
MultiStreamFileNameMode
NoiseRejection1, NoiseRejection2, NoiseRejection3
PatternRemoval1, PatternRemoval2, PatternRemoval3
PixelType1, PixelType2, PixelType3 “0 - Black & White”, “1 - Grayscale”, “2 - RGB”
Resolution1, Resolution2, Resolution3
Reverse1, Reverse2, Reverse3
ScanCount
SDTCSensitivity1, SDTCSensitivity2, SDTCSensitivity3
SEE1, SEE2, SEE3
Shadow1, Shadow2, Shadow3
Sharpness1, Sharpness2, Sharpness3
SimpleSlicePatternRemoval1, SimpleSlicePatternRemoval2, SimpleSlicePatternRemoval3
sRGB1, sRGB2, sRGB3
Threshold1, Threshold2, Threshold3

Value Setting
When implemented.

Value Reference
When implemented.

157
Error Recovery
- Value will not be updated if set beyond the setting range.
- If a value other than "0 - OFF" is set for this property and "6 - Multi Image Output" or "7 -
Auto Color Detection" is set for the FileType1, FileType2, and FileType3 properties for each
image, an error (EC_ERROR_BAD_PARAMETER) occurs.
Set "0 - BMP", "1 - TIFF", "2 - Multipage TIFF", "3 - JPEG", "4 - PDF", or "5 - Multipage
PDF".
- If a value other than "0 - OFF" is set for this property and a value other than a value from "0
- Black & White" to "2 - RGB" is set for the PixelType1, PixelType2, and PixelType3
properties, an error (EC_ERROR_BAD_PARAMETER) occurs.
Set one of the values from "0 - Black & White" to "2 - RGB".

Compatibility and Restrictions

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

158
7.1.123 NoiseRejection .... Dynamic Threshold (iDTC) binary noise removal
Feature
Sets the sensitivity for Dynamic Threshold (iDTC) binary noise removal.

Coding Style
ricoh.fiscanner.noiseRejection

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"NoiseRejection1" for the 1st image, "NoiseRejection2" for 2nd image, and
"NoiseRejection3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType
Threshold

Value Setting
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.

Compatibility and Restrictions

N/A

159
7.1.124 Orientation .... document orientation setting
Feature
Sets the orientation of a document.

Coding Style
ricoh.fiscanner.orientation

Value
0 – Portrait Portrait
1 – Landscape Landscape
Default
0 – Portrait Portrait

Explanation
Sets the orientation (portrait/landscape) of a document.

Target method
StartScan

Related Properties
PaperSize
PaperSupply

Value Setting
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

160
7.1.125 OverScan .... overscan setting
Feature
Sets overscan.

Coding Style
ricoh.fiscanner.overScan

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.

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
BackgroundColor
Deskew
DivideLongPage
FrontBackMergingEnabled
LengthDetection
PaperSupply
UndefinedScanning

Value Setting
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.

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.overwrite
Value
0 – OFF(Mode0) Does not overwrite
(When file type is TIFF, JPEG or BMP, 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.)
Target method
StartScan

Related Properties
SilentMode

Value Setting
When implemented.

Value Reference
When implemented.
Error Recovery
Value not updated if set to other than the specified range.

Compatibility and Restraints

N/A

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

Coding Style
ricoh.fiscanner.pageCount

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
N/A

Value Setting
Not possible.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

163
7.1.128 PaperProtection .... Paper Protection
Feature
Detects document feeding errors.

Coding Style
ricoh.fiscanner.paperProtection

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 driver will be displayed.

Target method
StartScan

Related Events
ManualFeedMode
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

164
7.1.129 PaperSize .... document size
Feature
Sets the document size.

Coding Style
ricoh.fiscanner.paperSize

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.

165
Target method
StartScan

Related Properties
AutoProrfile
CustomPaperWidth
CustomPaperLength
FrontBackMergingEnabled
HwMoireReductionMode
LongPage
Orientation
PaperSupply

Value Setting
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.

Compatibility and Restraints

Only TWAIN compliant document sizes are supported.
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.

166
7.1.130 PaperSupply .... paper feed method
Feature
Sets the paper feed method.

Coding Style
ricoh.fiscanner.paperSupply

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

167
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

168
 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.

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
FrontBackMergingEnabled
IsExistsFB
ManualFeedMode
PageCount
PaperSize
ScanCount

Value Setting
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.

169
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.

170
7.1.131 PatchCodeDetection .... Patch code detection
Feature
Sets patch code detection.

Coding Style
ricoh.fiscanner.patchCodeDetection

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.

Target method
StartScan

Related Properties
DivideLongPage
PaperSupply

Value Setting
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.

Compatibility and Restrictions

N/A

171
7.1.132 PatchCodeDirection .... Patch code detection direction setting
Feature
Sets the direction of the patch code that is detected.

Coding Style
ricoh.fiscanner.patchCodeDirection

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.

Target method
StartScan

Related Properties
PaperSupply
PatchCodeDetection

Value Setting
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.

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 the driver UI job control.

172
7.1.133 PatchCodeType .... Patch code type setting
Feature
Sets the type of patch code that is detected.

Coding Style
ricoh.fiscanner.patchCodeType

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.

Target method
StartScan

Related Properties
PaperSupply
PatchCodeDetection

Value Setting
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.

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 the driver UI job control.

173
7.1.134 PatternRemoval
.... Dynamic Threshold (iDTC) binary pattern removal setting
Feature
Sets the removal of the Dynamic Threshold (iDTC) binary pattern.

Coding Style
ricoh.fiscanner.patternRemoval

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"PatternRemoval1" for the 1st image, "PatternRemoval2" for 2nd image, and
"PatternRemoval3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PaperSupply
PixelType
Threshold

Value Setting
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.

Compatibility and Restrictions

N/A

174
7.1.135 PixelType .... pixel type
Feature
Sets the pixel type.

Coding Style
ricoh.fiscanner.pixelType

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:
-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.

Note that 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.")

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "PixelType1" for
the 1st image, "PixelType2" for 2nd image, and "PixelType3" for the 3rd image to set this
property.

Target method
StartScan

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

Value Setting
When implemented.

175
Value Reference
When implemented.

Error Recovery
Value will not be updated if set beyond the setting range.
Compatibility and Restraints
If this property is set to "3 - Automatic" or "4 - SwitchByCodeSheet", the CompressionType
property and FileType property may not always be the expected value.

176
7.1.136 PunchHoleRemoval .... Punch hole removal
Feature
Sets removal of punch holes.

Coding Style
ricoh.fiscanner.punchHoleRemoval

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.

Target method
StartScan

Related Properties
AutoBorderDetection
BackgroundColor
OverScan
PaperSupply
UndefinedScanning

Value Setting
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.

Compatibility and Restrictions

N/A

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

Coding Style
ricoh.fiscanner.punchHoleRemovalMode

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".

Target method
StartScan

Related Properties
PunchHoleRemoval

Value Setting
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.

Compatibility and Restrictions

N/A

178
7.1.138 RegionLeft .... Left Edge of the Scanning Area
Feature
Configures the left edge of the scanning area.

Coding Style
ricoh.fiscanner.regionLeft

Value
The left edge of the scanning area.

Default
0

Explanation
Specify the left edge of the scanning area.

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionTop
RegionWidth
RegionLength
Unit

Value Setting
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

179
7.1.139 RegionLength .... Length of the Scanning Area
Feature
Configures the length of the scanning area.

Coding Style
ricoh.fiscanner.regionLength

Value
The length of the scanning area.

Default
0

Explanation
Specify the length of the scanning area.

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionLeft
RegionTop
RegionWidth
Unit

Value Setting
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.
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
property, this property is adjusted to fit into the document size (area) at scanning.

Compatibility and Restraints

N/A

180
7.1.140 RegionTop .... Top Edge of the Scanning Area
Feature
Configures the top edge of the scanning area.

Coding Style
ricoh.fiscanner.regionTop

Value
The top edge of the scanning area.

Default
0

Explanation
Specify the top edge of the scanning area.

Target method
StartScan

Related Properties
AutoProfile
CustomPaperLength
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionLeft
RegionWidth
RegionLength
Unit

Value Setting
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

181
7.1.141 RegionWidth .... Width of the Scanning Area
Feature
Configures the width of the scanning area.

Coding Style
ricoh.fiscanner.regionWidth

Value
The width of the scanning area.

Default
0

Explanation
Specify the width (horizontal direction) of the scanning area.

Target method
StartScan

Related Properties
AutoProfile
CustomPaperWidth
CustomPaperLength
DivideLongPage
FrontBackMergingEnabled
PaperSize
PaperSupply
RegionLeft
RegionTop
RegionLength
Unit

Value Setting
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 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.

Compatibility and Restraints

N/A

182
7.1.142 Resolution .... Standard Resolution
Feature
Specifies the scan resolution.

Coding Style
ricoh.fiscanner.resolution

Value
0 - 200x200 [dpi]
1 - 240x240 [dpi]
2 - 300x300 [dpi]
3 - 400x400 [dpi]
4 - 500x500 [dpi]
5 - 600x600 [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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Resolution1" for
the 1st image, "Resolution2" for 2nd image, and "Resolution3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
CustomResolution
FrontBackMergingEnabled
PaperSize

Value Setting
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.

Compatibility and Restraints

N/A

183
7.1.143 Reverse .... Black and White Inversion / Color Inversion
Feature
Configures whether to invert black and white or invert color.

Coding Style
ricoh.fiscanner.reverse

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Reverse1" for
the 1st image, "Reverse2" for 2nd image, and "Reverse3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
PaperSupply
PixelType

Value Setting
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

184
7.1.144 Rotation .... Rotation Angle
Feature
Configures the rotation angle of the scanned image.

Coding Style
ricoh.fiscanner.rotation

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.

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
FrontBackMergingEnabled
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

185
7.1.145 ScanContinue .... Setting Continuous Scanning
Feature
Sets continuous scanning.

Coding Style
ricoh.fiscanner.scanContinue

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 implemented.

Value Reference
When implemented.

Error Recovery
None

Compatibility and Restraints

None

186
7.1.146 ScanContinueMode .... Setting Continuous Scanning Method
Feature
Sets the continuous scanning method.

Coding Style
ricoh.fiscanner.scanContinueMode

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.

Target method
StartScan

Related Properties
ScanContinue

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restraints

None

187
7.1.147 ScanCount .... Number of Pages to be Scanned
Feature
Configures the number of pages to scan.

Coding Style
ricoh.fiscanner.scanCount

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 while 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.

Target method
StartScan

Related Properties
FileType
PaperSupply

Value Setting
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, -1:RC_FAILURE is returned after scanning all pages from the ADF. At this time,
the ErrorCode property is set with a value "0x00000005: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.

188
7.1.148 ScanMode .... Scan mode
Feature
Sets the scan mode.

Coding Style
ricoh.fiscanner.scanMode

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.

Target method
StartScan

Related Properties
AutoProfile
DivideLongPage
FrontBackMergingEnabled
MultiStreamMode
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

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

Compatibility and Restrictions

N/A

189
7.1.149 SDTCSensitivity .... Automatic (simple) binary dispersion value
Feature
Sets the automatic (simple) binary dispersion value.

Coding Style
ricoh.fiscanner.sDTCSensitivity

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".

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"SDTCSensitivity1" for the 1st image, "SDTCSensitivity2" for 2nd image, and
"SDTCSensitivity3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PaperSupply
Threshold

Value Setting
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

190
7.1.150 SEE .... Selectable Edge Enhancement

Feature
Configures whether to apply selectable edge enhancement.

Coding Style
ricoh.fiscanner.sEE

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" and the
Halftone property is set to any value other than "0 - None".

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "SEE1" for the
1st image, "SEE2" for 2nd image, and "SEE3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
CompressionType
Halftone
PixelType

Value Setting
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".
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

191
7.1.151 SelectOutputSize .... Selecting output size

Feature
Select the method for specifying the output size used for automatic cropping.

Coding Style
ricoh.fiscanner.selectOutputSize

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.

Target method
StartScan

Related Properties
AutoBorderDetection

Value Setting
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.

Compatibility and Restraints

N/A

192
7.1.152 Shadow .... shadow
Feature
Sets shadows.

Coding Style
ricoh.fiscanner.shadow

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)".

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Shadow1" for
the 1st image, "Shadow2" for 2nd image, and "Shadow3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
AutoBright
Gamma
Highlight
PaperSupply
PixelType
Threshold

Value Setting
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.

Compatibility and Restraints

N/A

193
7.1.153 Sharpness .... Sharpness
Feature
Sets the sharpness.

Coding Style
ricoh.fiscanner.sharpness

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Sharpness1" for
the 1st image, "Sharpness2" for 2nd image, and "Sharpness3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
PaperSupply
PixelType
Threshold

Value Setting
When implemented.

194
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.

Compatibility and Restrictions

N/A

195
7.1.154 ShowSourceUI .... Source User Interface (UI) Display
Feature
Configures whether to display the source user interface (UI).

Coding Style
ricoh.fiscanner.showSourceUI

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 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 0:RC_SUCCESS in the return value.

196
Target method
StartScan

Related Properties
PaperSupply

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

197
7.1.155 SilentMode .... Silent Mode
Feature
Configures whether to execute the source in silent mode.

Coding Style
ricoh.fiscanner.silentMode

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 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)”

198
7.1.156 SimpleSlicePatternRemoval .... Simple slice binary pattern removal setting
Feature
Sets the removal of the simple slice binary pattern.

Coding Style
ricoh.fiscanner.simpleSlicePatternRemoval

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use
"SimpleSlicePatternRemoval1" for the 1st image, "SimpleSlicePatternRemoval2" for 2nd
image, and "SimpleSlicePatternRemoval3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PixelType
ScanMode
Threshold

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

199
7.1.157 SkipBlackPage .... Skip Black Pages

Feature
Configures whether to skip blank pages (black pages) when scanning continuously from an
ADF.

Coding Style
ricoh.fiscanner.skipBlackPage

Value
0 - Do not skip
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]
Set 1 or higher for the BlankPageSkip property to use this property.

Target method
StartScan

Related Properties
BlankPageSkipMode
PaperSupply
PixelType

Value Setting
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.

Compatibility and Restraints

N/A

200
7.1.158 SkipWhitePage .... Skip White Pages
Feature
Configures whether to skip blank pages (white pages) when scanning continuously from an
ADF.

Coding Style
ricoh.fiscanner.skipWhitePage

Value
0 - Do not skip
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]
Set 1 or higher for the BlankPageSkip property to use this property.

Target method
StartScan

Related Properties
BlankPageSkipMode
PaperSupply
PixelType

Value Setting
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.

Compatibility and Restraints

N/A

201
7.1.159 SourceCurrentScan .... Scan with the Source Current Value
Feature
Configures whether to scan with the source current value.

Coding Style
ricoh.fiscanner.sourceCurrentScan

Value
true Scan with the source current value
false Scan with the value set in the property

Default
false Scan with the value set in the 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
FileType
FileName
CompressionType
ScanCount
ShowSourceUI
SilentMode
FileCounterEx
JpegQuality
Indicator
Overwrite
MultiFeedNotice

If this property is set false, the following source parameter is changed and executed 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 driver.

Target method
StartScan

Related Properties
AIQCNotice
CompressionType
FileCounterEx
FileName
FileType
Indicator
JpegQuality
MultiFeedNotice
Overwrite
ScanCount
ShowSourceUI
SilentMode

202
Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
N/A

Compatibility and Restraints

N/A

203
7.1.160 sRGB .... sRGB output
Feature
Sets the sRGB output.

Coding Style
ricoh.fiscanner.sRGB

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.

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "sRGB1" for the
1st image, "sRGB2" for 2nd image, and "sRGB3" for the 3rd image to set this property.

Target method
StartScan

Related Properties
PaperSupply
PixelType

Value Setting
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.

Compatibility and Restrictions

N/A

204
7.1.161 StapleDetection .... Stapled Documents Detection
Feature
Specify whether to stop the scan when stapled documents are detected during scanning by
feeder.

Coding Style
ricoh.fiscanner.stapleDetection

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 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.

Compatibility and Restraints

N/A

205
7.1.162 SynchronizationDigitalEndorser
.... Endorser/Imprinter and Digital Endorser synchronization function setting
Feature
Sets the endorser/imprinter and digital endorser synchronization function.

Coding Style
ricoh.fiscanner.synchronizationDigitalEndorser

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

Target method
StartScan

Related Properties
DigitalEndorser
Endorser
PaperSupply

Value Setting
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.

Compatibility and Restrictions

N/A

206
7.1.163 Threshold .... Threshold
Feature
Configures the threshold.

Coding Style
ricoh.fiscanner.threshold

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."

If a value other than "0 - OFF" is set for the MultiStreamMode property, use "Threshold1" for
the 1st image, "Threshold2" for 2nd image, and "Threshold3" for the 3rd image to set this
property.

Target method
StartScan

Related Properties
CompressionType
Halftone
PixelType

Value Setting
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

207
7.1.164 TwainDS .... Data Source
Feature
Configures the TWAIN data source.

Coding Style
ricoh.fiscanner.twainDS

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
OpenScanner
OpenScanner2
SetTwainDSInfo
StartScan

Related Properties
TwainDSAnyPort

Value Setting
When implemented.

Value Reference
When implemented.

Error Recovery
An error occurs if the specified data source does not exist.
For details, refer to the RICOH Scanner Control SDK manual.

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.
After setting this property, call the SetTwainDSInfo method before calling the OpenScanner
method or the OpenScanner2 method.

208
7.1.165 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
ricoh.fiscanner.twainDSAnyPort

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
SetTwainDSInfo

Related Properties
TwainDS

Value Setting
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

209
method.)
After setting this property, call the SetTwainDSInfo method before calling the OpenScanner
method or the OpenScanner2 method.

210
7.1.166 UndefinedScanning
.... Scanning an Undefined Length (Paper End Detection)
Feature
Configures whether to scan an undefined length (paper end detection).

Coding Style
ricoh.fiscanner.undefinedScanning

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.

Target method
StartScan

Related Properties
AutoBorderDetection
AutoProfile
BackgroundColor
Deskew
DivideLongPage
FrontBackMergingEnabled
LengthDetection
OverScan
PaperSupply

Value Setting
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.

Compatibility and Restraints

N/A

211
7.1.167 Unit .... unit of size (inch/centimeter/pixel)
Feature
Sets the unit of size (inch/centimeter/pixel).

Coding Style
ricoh.fiscanner.unit

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
EdgeFillerBottom
EdgeFillerLeft
EdgeFillerRigth
EdgeFillerTop
EndorserOffset
FrontBackMergingTargetSize
MultiFeedModeChangeSize
RegionLeft
RegionLength
RegionTop
RegionWidth

Value Setting
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

212
Compatibility and Restraints
N/A

213
7.1.168 VerticalLineReduction .... Vertical line reduction setting
Feature
Sets whether the vertical lines are reduced.

Coding Style
ricoh.fiscanner.verticalLineReduction

Value
true Vertical lines are reduced.
false Vertical lines are not reduced.
Default
false Vertical lines are not reduced.

Explanation
Sets vertical line reduction.

Target method
StartScan

Related Properties
AutoBorderDetection
DivideLongPage
PaperSupply

Value Setting
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.

Compatibility and Restrictions

N/A

214
7.2 Methods

7.2.1 List of Methods

The following describes methods supported by Web API .

Method Name Description

ClearPage Ejects the document loaded on the ADF.

CloseScanner Performs the termination process after scanning.
ConvertToBase64 Returns a character string of a scanned image in a Base64 format.
This is used when uploading a scanned image in a Base64 format.
DeleteFile Deleting a Scanned Image.
FeederLoaded Notifies whether or not the document is loaded on the ADF.
GetSerialNumber Obtains a scanner serial number.
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.
Initialize Performs the Web API initialization process before scanning.
OpenScanner Performs the initialization process before scanning.
OpenScanner2 Performs initialization process before scanning and assumes control of
the scanner.
RegisterEvent Registers an event before scanning.
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.
SetSourceCurrentScan Sets the SourceCurrentScan property.
SetTopMostWindow Specify whether to display the data source selection screen or any of the
screens from the driver at the front at all times.
SetTwainDSInfo Sets the TwainDS property and the TwainDSAnyPort property.
SetTWAINTemplateSelect Configures numbers for setting files / profiles stored in the TWAIN driver.
SetupDataSourceProperties Displays the user interface with the configurable sources.
StartScan Starts scanning an image according to the specified properties.

215
7.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.

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.

216
7.2.3 ClearPage .... Document Ejection
Feature
Ejects the document.

Coding Style
ricoh.fiscanner.ClearPage().done(function (Integer){})

Parameters
N/A

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").

Compatibility and Restraints

N/A

217
7.2.4 CloseScanner .... Closing the Scanner
Feature
Performs a termination process.

Coding Style
ricoh.fiscanner.CloseScanner().done(function (Integer){ })

Parameters
N/A

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").

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.

Sample
Refer to the sample for the StartScan method.

218
7.2.5 ConvertToBase64
.... Returning a character string of a scanned image converted in a Base64
format
Feature
Returns a character string of a scanned image converted in the Base64 format.

Coding Style
ricoh.fiscanner.ConvertToBase64 (filename, asyncFinishFunc)

Parameters
filename Full path file name of scanned image
asyncFinishFunc Callback function asyncFinishFunc(ret, data)
ret Return values
Greater than 0 : Conversion successful
Less than or equal to 0 : Conversion failure
data String data in Base64 format

Return Values
N/A

Explanation
Returns a character string of a scanned image converted in the Base64 format.
This is used when uploading a scanned image in a Base64 format.

Target method
N/A

Related Properties
N/A

Error Recovery
N/A

Compatibility and Restraints

N/A

219
7.2.6 DeleteFile.... Deleting a Scanned Image
Feature
Deletes a scanned image.

Coding Style
ricoh.fiscanner.DeleteFile (filename, asyncFinishFunc)

Parameters
filename Full path file name of scanned image
asyncFinishFunc Callback function asyncFinishFunc(ret)
ret Return values
true : Deletion successful
false : Deletion failure

Return Values
N/A

Target method
N/A

Related Properties
N/A

Error Recovery
N/A

Compatibility and Restraints

N/A

220
7.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
ricoh.fiscanner.FeederLoaded().done(function (Integer){})

Parameters
N/A

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.

221
7.2.8 GetSerialNumber .... Obtaining a scanner serial number
Feature
Obtains a scanner serial number.

Coding Style
ricoh.fiscanner.GetSerialNumber().done(function(Integer){})

Parameters
N/A

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.

222
7.2.9 GetSourceCount .... Getting the total number of data source
Feature
Gets the total number of data source.

Coding Style
ricoh.fiscanner.GetSourceCount().done(function (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

Sample
[JavaScript]
function scanFunc() {
$.connection.hub.url = "http://localhost:8087/sample";
var chat = $.connection.fiHub;
ricoh.fiscanner.Initialize(chat);
ricoh.fiscanner.GetSourceCount().done(function (resultCode)
{
ricoh.fiscanner.GetSourceSelect().done(function(resultIndex)
{
ricoh.fiscanner.GetSourceName(resultIndex).done(function
(resultName)
{});
});
});
}

223
7.2.10 GetSourceName .... Getting a data source name
Feature
Gets a data source name.

Coding Style
ricoh.fiscanner.GetSourceName(Short nSourceIndex).done(function (String){})

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

224
7.2.11 GetSourceSelect .... Getting the index of a selected data source
Feature
Gets the index of a selected data source.

Coding Style
ricoh.fiscanner.GetSourceSelect().done(function (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.

225
7.2.12 GetTWAINTemplateCount .... Setting File / profile Total Number Acquisition
Feature
Acquires the total number of setting files / profiles in the TWAIN driver.

Coding Style
ricoh.fiscanner.GetTWAINTemplateCount().done(function (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

226
7.2.13 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
ricoh.fiscanner.GetTWAINTemplateName(Short nTemplateIndex).done(function (String){})

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

227
7.2.14 GetTWAINTemplateSelect
.... Selected Setting File / profile Number Acquisition
Feature
Acquires the number (0 - ) of a selected setting file / profile in the TWAIN driver."

Coding Style
ricoh.fiscanner.GetTWAINTemplateSelect().done(function (Integer){})

Parameters
N/A

Return Values
0 - : Number of the selected template / profile (0 - )
-1 : RC_FAILURE Acquisition failed

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

228
7.2.15 Initialize .... Web API Initialization Process
Feature
Performs the initialization process for the Web API.

Coding Style
ricoh.fiscanner.Initialize (Hub)

Parameters
Hub A proxy that is generated

Return Values
N/A

Explanation
Performs the initialization process for the Web API.
When using the Web API, perform the initialization process for the Web API first.

Target method
N/A

Related Properties
N/A

Error Recovery
N/A

Compatibility and Restraints

N/A

Sample

[JavaScript]
var chat = $.connection.fiHub;
ricoh.fiscanner..Initialize(chat);

229
7.2.16 OpenScanner .... Opening the Scanner
Feature
Performs the initialization process before scanning.

Coding Style
ricoh.fiscanner.OpenScanner().done(function (Integer){})

Parameters
N/A

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.

Sample
Refer to the sample for the StartScan method.

230
7.2.17 OpenScanner2 .... Open scanner (part 2)
Feature
Performs initialization process before scanning and assumes control of the scanner.

Coding Style
ricoh.fiscanner.OpenScanner2().done(function (Integer){})

Parameters
N/A

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
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").

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.
- If this method or the OpenScanner method has been called, be sure to always call the

231
CloseScanner method when exiting the application or when otherwise required. (This
method or the OpenScanner method must be paired with the CloseScanner 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.

232
7.2.18 RegisterEvent .... Registering an event to be notified
Feature
Registers an event to be notified.

Coding Style
ricoh.fiscanner.RegisterEvent(“EventName”,”EventHandler”)

Parameters
EventName ：OnAIQCResult
OnAutoProfileSelection
OnBlankPageResult
OnDetectBarcode
OnDetectBarcodeDetail
OnDetectJobSeparator
OnDetectPatchCode
OnMultiFeedResult
OnPageNumber
OnPagePartition
OnScannerReady
OnScanToFile
EventHandler ： CallBack implementation
Return Values
N/A

Explanation
Register an event to be notified. Specify an event name and an event handler as arguments.
Refer to the description of each event for details on how to specify each event and when
each event is issued.

{Example}
// Definition of an event handler which detects a barcode
function OnDetectBarcode(readcount, barcodetype, barcodetext){
console.log('OnDetectBarcode:');
console.log(' readcount: ' + readcount);
console.log(' barcodetype: ' + barcodetype);
console.log(' barcodetext: ' + barcodetext);
}
// Registering an event
ricoh.fiscanner.RegisterEvent("OnDetectBarcode",OnDetectBarcode);

Target method
N/A

Related Properties
N/A

Error Recovery
N/A

Compatibility and Restraints

N/A

233
7.2.19 ScannerAvailable .... Image Scanner Availability
Feature
Checks if the device (scanner) is in the ready status.

Coding Style
ricoh.fiscanner.ScannerAvailable().done(function (Integer){})

Parameters
N/A

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.

234
7.2.20 SelectSource .... Data source Selection
Feature
Performs the selection process of the data source.
Note: Specify the driver (data source) of the device.

Coding Style
ricoh.fiscanner.SelectSource().done(function (Integer){})

Parameters
N/A

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").

Compatibility and Restraints

N/A

235
7.2.21 SelectSourceName .... data source selection
Feature
Select a data source.

Coding Style
ricoh.fiscanner.SelectSourceName(SourceName As String).done(function (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.

236
7.2.22 SetSourceCurrentScan .... Setting the SourceCurrentScan property.
Feature
Set the SourceCurrentScan property.

Coding Style
ricoh.fiscanner.SetSourceCurrentScan().done(function (Integer){})

Parameters
N/A

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Set the SourceCurrentScan property.
Call the SetSourceCurrentScan method before calling the SetTWAINTemplateSelect method
in order to enable the SourceCurrentScan property.

Target method
SetTWAINTemplateSelect

Related Properties
SourceCurrentScan

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").

Compatibility and Restraints

N/A

237
7.2.23 SetTopMostWindow .... Displaying a screen at the front
Feature
Specify whether to display the data source selection screen or any of the screens from the
driver at the front at all times.

Coding Style
ricoh.fiscanner. SetTopMostWindow (flag)

Parameters
flag Flag that indicates whether to display a screen at the front
true A screen is displayed at the front
false A screen is not displayed at the front

Return Values
N/A

Explanation
Specify whether to display the data source selection screen or any of the screens from the
driver at the front at all times.
When "true" is set for the parameter or when this method is not executed, the setting to
display the data source selection screen or any of the screens from the driver at the front at
all times is configured.
When "false" is set for the parameter, the setting to display the data source selection screen
or any of the screens from the driver at the front at all times is not configured.
In this case, the data source selection screen or any of the screens from the driver may be
hidden behind other screens.

Target method
SelectSource
SetupDataSourceProperties

Related Properties
FileName
Indicator
MultiFeed
Overwrite
ScanContinueMode
ScanMode
ShowSourceUI
SiletMode

Error Recovery
N/A

Compatibility and Restraints

N/A

238
7.2.24 SetTwainDSInfo .... Setting the TwainDS property and the TwainDSAnyPort
property
Feature
Set the TwainDS property and the TwainDSAnyPort property.

Coding Style
ricoh.fiscanner.SetTwainDSInfo().done(function (Integer){})

Parameters
N/A

Return Values
0 : RC_SUCCESS Normal end
-1 : RC_FAILURE Error
-3 : RC_SEQUENCE_ERROR Sequence error (during the method execution)

Explanation
Set the TwainDS property and the TwainDSAnyPort property.
Call the SetTwainDSInfo method before calling the OpenScanner method or the
OpenScanner2 method in order to enable the TwainDS property and the TwainDSAnyPort
property.

Target method
StartScan

Related Properties
ErrorCode
TwainDS
TwainDSAnyPort

Error Recovery
The value can be acquired from the ErrorCode property in the event of an error ("-1:
RC_FAILURE").

Compatibility and Restraints

N/A

239
7.2.25 SetTWAINTemplateSelect .... Configuring Setting File / profile Numbers
Feature
Configures numbers for setting files / profiles stored in the TWAIN driver."

Coding Style
ricoh.fiscanner.SetTWAINTemplateSelect(nTemplateIndex As Short).done(function
(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
SetSourceCurrentScan

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.
In addition, after setting the SourceCurrentScan property, call the SetSourceCurrentScan
method before calling this method.

240
7.2.26 SetupDataSourceProperties .... Settable UI Display
Feature
Displays source configuration dialog box.

Coding Style
ricoh.fiscanner.SetupDataSourceProperties().done(function (){})

Parameters
N/A

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 driver) for the source which allows configuration of
values only. (Read startup cannot be initiated from this user interface.)

Example of the driver user interface display

If the compression specification is invalid due to 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 the RICOH
Scanner Control SDK before scanning.

241
Target method
StartScan

Related Properties
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").

Compatibility and Restraints

N/A

242
7.2.27 StartScan .... Starting an Image Scanning
Feature
Starts scanning an image.

Coding Style
ricoh.fiscanner.StartScan().done(function (Integer){})
Parameters
N/A

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.
[Note]
When multiple web browsers are used to perform a scan with Web API at the same
time, the correct StartScan error code may not be returned.

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 (0x00000027: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.

After changing the feeding method from ADF to flatbed, it takes some time for scanning to
start when this method is executed.

243
Sample

[JavaScript]
function scanFunc()
{
$.connection.hub.url = "http://localhost:8087/sample";
var chat = $.connection.fiHub;
ricoh.fiscanner.Initialize(chat);
ricoh.fiscanner.OpenScanner2().done(function (resultCode)
{
ricoh.fiscanner.brightness = $('#brightness').val();
ricoh.fiscanner.contrast = $('#contrast').val();
ricoh.fiscanner.fileCounterEx = $('#filecounter'ex).val();
ricoh.fiscanner.fileName = $('#filename').val();
ricoh.fiscanner.fileType = $('#filetype').val();
ricoh.fiscanner.paperSize = $('#papersize').val();
ricoh.fiscanner.paperSupply = $('#papersupply').val();
ricoh.fiscanner.pixelType = $('#pixeltype').val();
ricoh.fiscanner.resolution = $('#resolution').val();
ricoh.fiscanner.rotation = $('#rotation').val();

ricoh.fiscanner.StartScan().done(function (resultCode)
{
ricoh.fiscanner.CloseScanner().done(function (resultCode)
{});
});
});
}

244
7.3 Events

7.3.1 List of Events

The following describes events supported by the Web API.
Refer to the RegisterEvent method for details on how to register an event.

Event Name Description

AIQCResult Notified the image recognition check function results.

AutoProfileSelection Information about an applied profile and registered form is issued.
BlankPageResult Notified the blank page detection results.
DetectBarcode Issued when a barcode is detected.
DetectBarcodeDetail Issued when a barcode detail is detected.
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.
MultiFeedResult Notified the result of the multifeed notification function.
PageNumber Notified the number of a page that is currently being scanned.
PagePartition Issued at a page break.
ScannerReady Issued when a scanning client application is ready.
ScanToFile Issued by the scanning process (the StartScan method) for each scanned
page

245
7.3.2 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.

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.

246
7.3.3 AIQCResult .... Notify Automatic Image Quality Checker results
Feature
Notifies the Automatic Image Quality Checker results.

Coding Style
ricoh.fiscanner.RegisterEvent("OnAIQCResult",
function (ReadCount, Result) {});

Parameters
ReadCount Scanning image count
Result true An error image was detected
false An error image was not detected

Explanation
This enables a check of whether there is an error in the image.
This event is issued after the ScanToFile event is issued.
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.

Target method
StartScan

Related Properties
AIQCNotice

Compatibility and Restraints

This event is issued when [true] is set for the AIQCNotice property.
The AIQCNotice property is disabled if it is not supported on the specific device.

247
7.3.4 AutoProfileSelection .... Notification of the identified forms
Feature
Information about an applied profile and registered form is issued.

Coding Style
ricoh.fiscanner.RegisterEvent(“AutoProfileSelection”,
function(DistResult,
FormName,
ProfileName){})

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 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.

248
7.3.5 BlankPageResult .... Get blank page detection results
Feature
Gets the blank page detection results.

Coding Style
ricoh.fiscanner.RegisterEvent("OnBlankPageResult",
function (ReadCount, Result) {});

Parameters
ReadCount Scanning image count
Result 0 No blank page was detected
1 Blank page was detected

Explanation
This enables a check of whether the page is a blank page or not.
This event is issued after the ScanToFile event is issued.

Target method
StartScan

Related Properties
BlankPageNotice

Compatibility and Restraints

This event is issued only when "1 -ON" is set for the BlankPageNotice property.
The BlankPageNotice property is disabled if it is not supported on the specific device.

249
7.3.6 DetectBarcode .... Barcode detection notification
Feature
Issued when a barcode is detected.

Coding Style
ricoh.fiscanner.RegisterEvent("OnDetectBarcode",
function (ReadCount,
BarcodeType,
BarcodeText) { });

Parameters
ReadCount Number of scanned images
BarcodeType Barcode type
BarcodeText Barcode identification text

Explanation
This event is issued after the ScanToFile 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.
*For details on barcodes, refer to the User's Guide for your device.

250
7.3.7 DetectBarcodeDetail .... Barcode detail detection notification
Feature
When a barcode is detected, the barcode detail is issued.

Coding Style
ricoh.fiscanner.RegisterEvent("OnDetectBarcodeDetail",
function (ReadCount,
BarcodeCount,
BarcodeTotalCount,
BarcodeType,
BarcodeTextLength,
BarcodeText,
BarcodeX,
BarcodeY,
BarcodeRotation,
BarcodeConfidence) { });

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 ScanToFile 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

251
 BarcodeType 0 is issued
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.
*For details on barcodes, refer to the User's Guide for your device.

252
7.3.8 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
ricoh.fiscanner.RegisterEvent("OnDetectJobSeparator", function() {});

Parameters
N/A

Explanation
When "0 - Special Document" is set for JobControlMode property, this event is issued before
ScanToFile event is issued.
When "1 - Patch Code Document" is set for JobControlMode property, this event is issued
after ScanToFile 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.
* For the details of special documents (documents in a particular shape), refer to the User's
Guide for your device.

253
7.3.9 DetectPatchCode .... Patch code detection notification
Feature
Issued when a patch code is detected.

Coding Style
ricoh.fiscanner.RegisterEvent("OnDetectPatchCode",
function (ReadCount,
PatchCodeType) { });

Parameters
ReadCount Scanning image count
PatchCodeType Patch code type

Explanation
This event is issued after the ScanToFile 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.
*For details on patch codes, refer to the User's Guide for your device.

254
7.3.10 MultiFeedResult .... Getting the multifeed result
Feature
Gets the result of the multifeed notification function.

Coding Style
ricoh.fiscanner.RegisterEvent("OnMultiFeedResult ",
function (ReadCount, Result) {});

Parameters
ReadCount Scanning image count
Result true Multifeed was detected
false Multifeed was not detected

Explanation
This enables a check of whether a multifeed is detected or not.
This event is issued after the ScanToFile event is issued.

Target method
StartScan

Related Properties
MultiFeed
MultiFeedNotice

Compatibility and Restraints

This property is enabled when [true] is set for the MultiFeedNotice property.
The MultiFeedNotice property is disabled if it is not supported on the specific device.

255
7.3.11 PageNumber .... Getting a page number
Feature
Gets the number of the page that is currently being scanned.

Coding Style
ricoh.fiscanner.RegisterEvent("OnPageNumber ",
function (ReadCount, PageNumber) {});

Parameters
ReadCount Scanning image count
PageNumber The number of the page that is currently being scanned

Explanation
Gets the number of the page that is currently being scanned.
This event is issued after the ScanToFile event is issued.
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 Properties
N/A

Compatibility and Restraints

N/A

256
7.3.12 PagePartition .... Page break notification
Feature
Issued at a page break.

Coding Style
ricoh.fiscanner.RegisterEvent(“OnPagePartition”, function(){});

Parameters
N/A

Explanation
This event is issued after the
ScanToFile/DetectBarcode/DetectBarcodeDetail/DetectJobSeparator/DetectPatchCode/Auto
ProfileSelection 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.

257
7.3.13 ScannerReady
.... Completing the initialization process for a scanner application
Feature
Issued when a scanning client application is ready.

Coding Style
ricoh.fiscanner.RegisterEvent("OnScannerReady", function() {});

Parameters
N/A

Target method
N/A

Related Properties
N/A

Compatibility and Restraints

N/A

258
7.3.14 ScanToFile .... File Output
Feature
This event is issued for each page during the scanning process (the StartScan method).

Coding Style
ricoh.fiscanner.RegisterEvent("OnScanToFile", function(ReadCount, FileName){ });

Parameters
ReadCount Scanning image count
FileName Scanning file name

Target method
StartScan

Related Properties
N/A

Compatibility and Restraints

If the file is not saved, this event will not occur.

259
8. Sample
Sample program codes are included in this product.
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.

The sample program includes the files below:

Running "fiWebAPI190_smp.exe" creates the following folders and files:

Function Folder name File name

Sample programs for fiWebAPI_smp\wwwroot\Webapi ScanTest.htm
performing a scan and fiWebAPI_smp\wwwroot\Webapi Web.config
uploading a file FileUpload.aspx
fiWebAPI_smp\wwwroot\Webapi\Scripts jquery.signalR-2.2.3.min.js
jquery-1.6.4.min.js
fiWebAPI_smp\wwwroot\Webapi\Resources ricoh.fiscanner.initiate.js
fiWebAPI_smp\wwwroot\Webapi\bin Client.dll
Project for creating a fiWebAPI_smp\wwwroot\Project
program on a server to
upload a file
Web API manual fiWebAPI_smp\Document fiWebAPI_Manual_EN.pdf
fiWebAPI_smp\SDK_doc\EN Manual.pdf
RICOH Scanner Control
ManualSeparateVolume.pdf
SDK manuals
GS.pdf

260
8.1 Sample of Scanning
Start up "ScanTest.htm".
You can specify a property for Web API in each tab.

By clicking the [Scan] button on an available scanner, a document is scanned and output
file name is displayed on "Files".

Entering a decimal point

In Chrome, entering a comma (,) in this window may not be possible.
Enter a period (.) instead if it is not possible to enter a comma (,).

261
8.2 Sample of Uploading a File On a Server
Provides step-by-step instructions on how to build an environment that runs the file upload
sample program.
Windows Server is used as an example here.

The sample program is created in ASP.NET.

Please include ASP.NET in Internet Information Services (IIS).
(In Server Manager, select [ASP.NET 4.X] in [Server Roles] under [Web Server (IIS) ].)
The procedure to add an application pool to Internet Information Services (IIS) Manager
(hereinafter, IIS Manager) is explained below.

1. Run IIS Manager to display [Application Pools].

2. Add an application pool.

262
3. Right-click the added application pool to display the [Advanced Settings] window, and
set [Enable 32-Bit Applications] to "True".

4. Copy the sample program for uploading a file (folder name:

WebAPI_smp\wwwroot\Webapi) into the following folder (folder
name: %SystemDrive%\inetpub\wwwroot). In addition, create the "upload" folder
directly under the "Webapi" folder.

%SystemDrive%\inetpub\wwwroot

Webapi

bin

Resources

Scripts

upload

・・・

5. Edit the access privileges for the "upload" folder to set the write privilege for the IIS
user.

263
6. Right-click [Default Web Site] of [Sites] on the IIS Manager and select [Refresh] to
display [Webapi].

7. Right-click [Webapi] and select [Convert to Application].

8. Select the [Select] button on the [Add Application] window.

9. Select [Webapi] on the [Select Application Pool] window.

10. Start up "ScanTest.htm" from the server and click the [Scan] button on an available
scanner to scan a document and to display an output file name in [Files].

264
11. Click the [upload button next to a file name in order to convert a scanned image into a
Base64 format and upload it to a server.

265
9. Appendix

9.1 Silent Installation

This subsection explains how to install Web API silently.
"Setup folder" indicates "fiWebAPI_setup" that is created when this product is downloaded
in the following way.

Caution
Install Web API after logging in with the user name of a user that has Administrator
privileges.

1. Start the command prompt and execute the following command.

cd /d "<Setup folder>"

2. Execute the following command at the command prompt.

Setup.exe -q

Or, execute the following command.

Setup.exe /q

9.2 Silent Uninstallation

This subsection explains how to uninstall Web API silently.

Caution
Uninstall Web API after logging in with the user name of a user that has Administrator
privileges.

1. Start the command prompt and execute the following command. (Default is
C:\Windows）

cd /d "<Windows directory>"

2. Execute the following command at the command prompt.

"fi Series Web API Uninstall.exe" -q

266
Index
BarcodeRegionWidth............................................ 53
BarcodeType ........................................................ 54
A Basic Level ............................................................. 9
Binding ................................................................. 55
Black and white inversion / Color inversion
ADF .................................................................... 167
configuration .................................................. 184
ADF(CarrierSheet A3) ........................................ 167
Blank page skip settings for index-tabbed
ADF(CarrierSheet B4) ........................................ 167
pages ............................................................... 60
ADF(CarrierSheet).............................................. 168
BlankPageIgnoreAreaSize ................................... 56
ADF/FB automatic switching................................. 38
BlankPageNotice .................................................. 57
Adjusting the brightness of each color (RGB)
BlankPageResult ................................................ 249
separately ........................................................ 27
BlankPageSkip ..................................................... 58
AdjustRGB ............................................................ 27
BlankPageSkipMode ............................................ 59
AdjustRGBB ......................................................... 28
BlankPageSkipTabPage....................................... 60
AdjustRGBG ......................................................... 29
BMP.................................................................... 118
AdjustRGBR ......................................................... 30
Bottom edge area setting (edge filler)................... 96
ADTCThreshold .................................................... 31
Brightness ............................................................ 61
Advanced Level .................................................... 17
Brightness setting ................................................. 61
AIQCNotice........................................................... 32
AIQCResult......................................................... 247
Appendix ........................................................... 266
Applying a profile automatically ............................ 39 C
Auto Color Detection .......................................... 118
AutoBorderDetection ............................................ 33 CarrierSheetClippingMode ................................... 62
AutoBright ............................................................. 34 Character string .................................................... 90
Automatic (advanced) binary threshold setting ..... 31 Character thickness setting .................................. 65
Automatic (simple) binary dispersion value ........ 190 CharacterExtraction .............................................. 63
Automatic Image Quality Checker setting ............. 32 CharacterExtractionMethod .................................. 64
Automatic Skew Correction ................................ 135 CharacterThickness.............................................. 65
AutomaticColorBackground .................................. 35 Chromatic dropout color sensitivity setting ......... 122
AutomaticColorSensitivity ..................................... 36 ClearPage .......................................................... 217
AutomaticRotateMode .......................................... 37 CloseScanner ..................................................... 218
AutomaticSenseMedium ....................................... 38 CloseSourceUI ..................................................... 66
AutoProfile ............................................................ 39 ColorReproduction................................................ 67
AutoProfileSelection ........................................... 248 ColorReproductionBrightness............................... 68
ColorReproductionContrast .................................. 69
ColorReproductionCustomGamma ...................... 70
B ColorReproductionHighlight.................................. 71
ColorReproductionShadow................................... 72
Components of a Program .................................. 3
Background .......................................................... 41
CompressionType ................................................ 73
Background color (black or white background)
Continuous scanning method ............................. 187
setting .............................................................. 42
Contrast ................................................................ 75
Background color smoothing setting ..................... 43
Contrast setting .................................................... 75
Background color smoothness setting .................. 44
ConvertToBase64............................................... 219
Background color threshold setting ...................... 45
Counter default ................................................... 103
Background tracking setting ................................. 41
Counter default value ........................................... 87
BackgroundColor .................................................. 42
Counter print direction ........................................ 106
BackgroundSmoothing ......................................... 43
Counter print font ................................................ 107
BackgroundSmoothness ...................................... 44
Counter step direction .................................. 86, 102
BackgroundThreshold .......................................... 45
Creating Applications .................................... 6, 19
Barcode detection notification............................. 250
CropMarginSize .................................................... 76
Barcode detail detection notification ................... 251
CropPriority .......................................................... 77
Barcode detection setting ..................................... 46
Custom document width setting ........................... 80
Barcode direction.................................................. 47
CustomGamma .................................................... 78
Barcode maximum detection count ...................... 48
CustomPaperLength............................................. 79
Barcode type ........................................................ 54
CustomPaperWidth .............................................. 80
BarcodeDetection ................................................. 46
CustomResolution ................................................ 81
BarcodeDirection .................................................. 47
Custom-sized document length setting................. 79
BarcodeMaxSearchPriorities ................................ 48
BarcodeNotDetectionNotice ................................. 49
BarcodeRegionLeft ............................................... 50
BarcodeRegionLength .......................................... 51
BarcodeRegionTop............................................... 52

267
 Endorser/imprinter step count setting ................. 104
D Endorser/imprinter string setting ......................... 109
EndorserCountDirection ..................................... 102
Data compression type setting ............................. 73 EndorserCounter ................................................ 103
Data source selection process............................ 235 EndorserCountStep ............................................ 104
DeleteFile ........................................................... 220 EndorserDialog ................................................... 105
Deleting a scanned image .................................. 220 EndorserDirection ............................................... 106
Deskew................................................................. 82 EndorserFont ...................................................... 107
DeskewBackground.............................................. 83 EndorserOffset ................................................... 108
DeskewMode ........................................................ 84 EndorserString ................................................... 109
DetectBarcode .................................................... 250 Endoser/imprinter counter default setting ........... 103
DetectBarcodeDetail........................................... 251 Error diffusion method ........................................ 132
Detecting document feeding errors ..................... 164 Error information acquisition ............................... 110
DetectJobSeparator............................................ 253 ErrorCode ........................................................... 110
DetectPatchCode ............................................... 254 Events ................................................................ 245
Development Environment .................................. 2 Examples and notation conventions (events) ..... 246
Development Procedure ...................................... 6 Examples and notation conventions (methods) .. 216
Device (scanner) status confirmation ................. 234
Digital endorser character string setting ............... 90
Digital endorser counter default value setting ....... 87
Digital endorser counter step direction setting ...... 86
F
Digital endorser counter step value setting ........... 88
Digital endorser output direction setting ............... 89 Fading compensation setting .............................. 111
Digital endorser output start position (X offset) FadingCompensation ......................................... 111
setting .............................................................. 91 FeederLoaded .................................................... 221
Digital endorser output start position (Y offset) File format setting ............................................... 118
setting .............................................................. 92 File name setting ................................................ 116
Digital endorser setting ......................................... 85 File overwrite setting........................................... 162
DigitalEndorser ..................................................... 85 File serial number setting ........................... 112, 114
DigitalEndorserCountDirection ............................. 86 FileCounter ......................................................... 112
DigitalEndorserCounter ........................................ 87 FileCounterEx ..................................................... 114
DigitalEndorserCountStep .................................... 88 FileName ............................................................ 116
DigitalEndorserDirection ....................................... 89 FileType.............................................................. 118
DigitalEndorserString............................................ 90 Filter ................................................................... 120
DigitalEndorserXOffset ......................................... 91 FilterSaturationSensitivity ................................... 122
DigitalEndorserYOffset ......................................... 92 Flatbed ............................................................... 167
Displaying a screen at the front .......................... 238 Flatbed support information acquisition .............. 140
DivideLongPage ................................................... 93 FrontBackDetection ............................................ 123
Document ejection .............................................. 217 FrontBackMergingEnabled ................................. 124
Document orientation setting .............................. 160 FrontBackMergingLocation................................. 125
Document size setting (fixed size) ...................... 165 FrontBackMergingRotation ................................. 126
Dropout color setting .......................................... 120 FrontBackMergingTarget .................................... 127
DTCSensitivity ...................................................... 94 FrontBackMergingTargetMode ........................... 128
Duplex binding direction setting ............................ 55 FrontBackMergingTargetSize ............................. 129
Dynamic Threshold (iDTC) binary sensitivity Functions .............................................................. 2
setting .............................................................. 94

G
E
Gamma............................................................... 130
Edge filler.............................................................. 95 Gamma adjustment setting ................................. 130
Edge filler repair ................................................. 100 GammaFile ......................................................... 131
Edge filler setting .................................................. 95 Get blank page detection results ........................ 249
EdgeFiller ............................................................. 95 GetSourceCount ................................................. 223
EdgeFillerBottom .................................................. 96 GetSourceName ................................................. 224
EdgeFillerLeft ....................................................... 97 GetSourceSelect ................................................ 225
EdgeFillerRight ..................................................... 98 Getting a page number ....................................... 256
EdgeFillerTop ....................................................... 99 Getting the multifeed result................................. 255
EdgeRepair......................................................... 100 GetTWAINTemplateCount.................................. 226
Endorser ............................................................. 101 GetTWAINTemplateName.................................. 227
Endorser/imprinter and digital endorser GetTWAINTemplateSelect ................................. 228
synchronization function ................................ 206
Endorser/imprinter print direction setting ............ 106
Endorser/imprinter print font setting .................... 107
Endorser/imprinter print start position setting ..... 108
Endorser/imprinter setting .................................. 101

268
 MultiFeedNotice ................................................. 150
H MultiFeedResult ................................................. 255
MultiStreamDefaultValueMode ........................... 151
Halftone .............................................................. 132 MultiStreamFileNameMode ................................ 154
Halftone pattern setting ...................................... 132 MultiStreamMode ............................................... 155
HalftoneFile ........................................................ 133
Highlight ............................................................. 134
Highlight setting .................................................. 134
HwAutomaticDeskew .......................................... 135
N
HwCompression ................................................. 136
HwMoireReductionMode .................................... 137 Noise removal setting ......................................... 159
NoiseRejection ................................................... 159
Notification of the identified forms ...................... 248
Notifies whether or not the document is loaded
I on the ADF..................................................... 221
Notify Automatic Image Quality Checker results 247
ID card automatic detection setting .................... 123
Image quality automatic adjustment setting .......... 34
Image scanner name acquisition ........................ 138
ImageScanner .................................................... 138
O
Indicator .............................................................. 139
Initialization process ........................................... 230 Obtaining a scanner serial number ..................... 222
Initialize ............................................................. 229 OpenScanner ..................................................... 230
Install ..................................................................... 5 OpenScanner2 ................................................... 231
IsExistsFB........................................................... 140 Orientation .......................................................... 160
Outline ................................................................... 2
Outline and Functions.......................................... 2
Outline of Process .................................................. 6
J Output direction .................................................... 89
OverScan ........................................................... 161
Job control paper type setting............................. 143 Overscan setting ................................................ 161
Job control setting .............................................. 141 Overwrite ............................................................ 162
JobControl .......................................................... 141
JobControlMode ................................................. 143
JPEG .................................................................. 118
Jpeg compression level setting........................... 144
P
JpegQuality......................................................... 144
Page break notification ....................................... 257
PageCount ......................................................... 163
PageNumber ...................................................... 256
L Paper end detection ........................................... 211
Paper feed method setting ................................. 167
Left edge area setting (edge filler) ........................ 97 PaperProtection .................................................. 164
Left edge configuration (scanning area) ............. 179 PaperSize ........................................................... 165
Left edge position setting (detection area) ............ 50 PaperSupply ....................................................... 167
Length configuration (scanning area) ................. 180 Patch code detection notification ........................ 254
Length setting (detection area) ............................. 51 Patch code detection .......................................... 171
LengthDetection ................................................. 145 Patch code direction ........................................... 172
List of events ...................................................... 245 Patch code type .................................................. 173
List of methods ................................................... 215 PatchCodeDetection........................................... 171
Long page scanning setting ................................ 146 PatchCodeDirection............................................ 172
LongPage ........................................................... 146 PatchCodeType .................................................. 173
Pattern removal setting....................................... 174
PatternRemoval .................................................. 174
M PDF .................................................................... 118
Pixel type setting ................................................ 175
Manual Feed Mode............................................. 147 PixelType............................................................ 175
ManualFeedMode............................................... 147 Preparing for Applications Development ........... 6
Method ............................................................... 216 Print settings window display .............................. 105
Mode for keeping the default value for each Priority setting during automatic paper size
image ............................................................. 151 detection .......................................................... 77
Moire Reduction(Advanced) ............................... 137 Profile name acquisition (TWAIN Driver) ............ 227
Multi feed detection setting ................................. 148 Profile number acquisition (TWAIN Driver) ......... 228
Multi Image Output ............................................. 118 Profile numbers (TWAIN Driver) ......................... 240
MultiFeed ............................................................ 148 Profiles total number acquisition (TWAIN
Multifeed notification setting ............................... 150 Driver) ............................................................ 226
MultiFeedModeChangeSize ............................... 149 Progress indicator setting ................................... 139

269
Property ................................................................ 26 Setting file total number acquisition (TWAIN
Property list........................................................... 20 Driver) ............................................................ 226
Punch hole removal mode setting ...................... 178 Setting for displaying the endorser/imprinter
Punch hole removal setting ................................ 177 print settings window when scanning starts24, 105
PunchHoleRemoval ............................................ 177 Setting for dividing long pages ............................. 93
PunchHoleRemovalMode ................................... 178 Setting for merging the front and back side
images ........................................................... 124
Setting for the angle to rotate the back side
R when merging the front and back side
images ........................................................... 126
Setting for the way of merging the front and
RegionLeft .......................................................... 179
back side images ........................................... 125
RegionLength ..................................................... 180
Setting the automatic border detection ................. 33
RegionTop .......................................................... 181
Setting the brightness of the color blue when
RegionWidth ....................................................... 182
the brightness of each color (RGB) is
RegisterEvent ..................................................... 233
adjusted separately.......................................... 28
Registering an event to be notified ..................... 233
Setting the brightness of the color green when
Resolution........................................................... 183
the brightness of each color (RGB) is
Returns a scanned image in a Base64 format. ... 219
adjusted separately.......................................... 29
Reverse .............................................................. 184
Setting the brightness of the color red when the
Right edge area setting (edge filler) ...................... 98
brightness of each color (RGB) is adjusted
Rotation .............................................................. 185
separately ........................................................ 30
Rotation angle configuration ............................... 185
Setting the color reproduction............................... 67
Setting the criteria for determining a type of
document whose front and back side
S images are to be merged ............................... 128
Setting the endoser/counter step direction ......... 102
Sample ............................................................... 260 Setting the length for the criteria for
Sample of Scanning ......................................... 261 determining a type of document whose front
Sample of Uploading a File .............................. 262 and back images are to be merged ............... 129
Scan mode setting .............................................. 189 Setting the sensitivity for auto color detection ...... 36
Scan page count acquisition ............................... 163 Setting the SourceCurrentScan .......................... 237
Scan pages configuration ................................... 188 Setting whether or not to lock the TWAIN data
Scan resolution setting (custom) .......................... 81 source name .................................................. 209
Scan with the current value ................................ 202 Setting whether to send a barcode detection
ScanContinue ..................................................... 186 notification even if a barcode is not detected ... 49
ScanContinueMode ............................................ 187 SetTopMostWindow ........................................... 238
ScanCount .......................................................... 188 SetTwainDSInfo ................................................. 239
ScanMode .......................................................... 189 SetTWAINTemplateSelect.................................. 240
ScannerAvailable................................................ 234 SetupDataSourceProperties ............................... 241
ScannerReady .................................................... 258 Shadow .............................................................. 193
ScanToFile ......................................................... 259 Shadow setting ................................................... 193
SDTCSensitivity.................................................. 190 Sharpness .......................................................... 194
SEE .................................................................... 191 Sharpness setting ............................................... 194
Selectable edge enhancement configuration ...... 191 ShowSourceUI ................................................... 196
SelectOutputSize ................................................ 192 Sides undetected during blank page detection ..... 56
SelectSource ...................................................... 235 Silent Installation .............................................. 266
SelectSourceName ........................................... 236 Silent mode configuration ................................... 198
Silent Uninstallation ......................................... 266
Sensitivity level for identifying a form when a
SilentMode ......................................................... 198
profile is applied automatically ......................... 40
Simple slice binary pattern removal setting ........ 199
Set the TwainDS................................................. 239
SimpleSlicePatternRemoval ............................... 199
Set the TwainDSAnyPort .................................... 239
Simultaneous setting of paper end
Sets a file name and file counter for a file
detection/background color/overscan ............ 145
created from each output image. ................... 154
Skew correction .................................................... 82
SetSourceCurrentScan ....................................... 237
Skip blank page configuration (white pages) ...... 201
Setting a mode for detecting the orientation of
Skip blank pages configuration (black pages) .... 200
an image .......................................................... 37
SkipBlackPage ................................................... 200
Setting a type of document whose front and
SkipWhitePage ................................................... 201
back side images are to be merged ............... 127
SourceCurrentScan ............................................ 202
Setting auto color detection which ignores
Special document ............................................... 141
background color ............................................. 35
Special document detection notification (job
Setting continuous scanning ............................... 186
control) ........................................................... 253
Setting file name acquisition (TWAIN Driver)...... 227
Specifying a highlight when a color hue is
Setting file number acquisition (TWAIN Driver) .. 228
prioritized ......................................................... 71
Setting file numbers (TWAIN Driver) .................. 240
Specifying a shadow when a color hue is

270
 prioritized ......................................................... 72 Transfer mode of the hardware .......................... 136
Specifying the brightness when a color hue is TWAIN data source configuration ....................... 208
prioritized ......................................................... 68 TWAIN driver ...................................................... 226
Specifying the color contrast when a color hue TWAIN driver ...................................................... 227
is prioritized...................................................... 69 TWAIN driver ...................................................... 228
Specifying the gamma pattern file ...................... 131 TWAIN driver ...................................................... 240
Specifying the gamma value (custom) .................. 78 TwainDS ............................................................. 208
Specifying the gamma value when a color hue TwainDSAnyPort ................................................ 209
is prioritized...................................................... 70
Specifying the halftone pattern file...................... 133
Specifying the output size ................................... 192 U
Specifying the paper length to disable
multifeed detection ......................................... 149
Undefined length scan configuration .................. 211
Specifying the size of cropping margins ............... 76
UndefinedScanning ............................................ 211
sRGB .................................................................. 204
Uninstall ................................................................ 5
sRGB output ....................................................... 204
Unit ..................................................................... 212
Stapled Documents Detection ............................ 205
Unit of size (inch/centimeter/pixel) ...................... 212
StapleDetection .................................................. 205
Uploading a File ................................................... 19
Starting a scan.................................................... 243
Use examples and conventions (Property) ........... 26
StartScan ............................................................ 243
User interface display ......................................... 196
Step count .......................................................... 104
User interface display (for configuration) ............ 241
Step value............................................................. 88
User interface exit setting ..................................... 66
String .................................................................. 109
Supported Languages .......................................... 1
Supported Models ................................................ 1
SynchronizationDigitalEndorser .......................... 206 V
System Requirements .......................................... 1
Vertical line reduction setting .............................. 214
VerticalLineReduction......................................... 214
T
Termination process ........................................... 218 W
Threshold............................................................ 207
Threshold configuration ...................................... 207 Web API initialization process ............................ 229
TIFF .................................................................... 118 Width configuration (scanning area) ................... 182
Top edge area setting (edge filler) ........................ 99 Width setting (detection area)............................... 53
Top edge configuration (scanning area) ............. 181
Top edge position setting (detection area) ........... 52

271
 fi Series Web API
Reference Manual

First Edition September 2024

© PFU Limited 2024