Scanner Class |
Namespace: Kofax.OmniPageCSDK.IproPlus
The Scanner type exposes the following members.
Name | Description | |
---|---|---|
![]() | ADFMode |
This property is used to get or set whether the scanner loads the next sheet of paper automatically or scans ahead if these capabilities are supported and
scanning is being done from an ADF. |
![]() | ADFStatus |
This property returns the status of the ADF and transparency adapter of the scanner. |
![]() | AvailableADFModes |
This property returns additional information about the scanner models that have ADF support. |
![]() | AvailableAutoBrightness |
This property returns True if the scanner itself or its associated software has the built-in automatic brightness control capability or if the scanner supports grayscale scanning.
|
![]() | AvailableColorModes |
This property returns the supported color modes of the scanner. |
![]() | AvailableDropouts |
This property returns the supported dropout color capabilities of the scanner. |
![]() | AvailableDuplexModes |
This property returns the supported duplex modes supported by the scanner. |
![]() | AvailableOrientations |
This property returns the supported orientation capabilities of the scanner model. |
![]() | AvailablePaperSources |
This property returns the supported paper sources of the scanner. |
![]() | AvailableResolutions |
This property returns the available scanning resolutions. |
![]() | AvailableUIModes |
This property returns the supported UI modes. |
![]() | BrightnessDefault |
This property returns the default brightness value. |
![]() | BrightnessMax |
This property returns the number of supported brightness steps of the scanner. |
![]() | ColorMode |
This property is used to get or set the current color mode. |
![]() | ContrastDefault |
This property returns the default contrast value. |
![]() | ContrastMax |
This property returns the number of available contrast steps of the scanner model. |
![]() | Dropout |
This property is used to get or set the current dropout color. |
![]() | DuplexMode |
This property is used to get or set the duplex mode of the scanner. |
![]() | Initialized |
This property returns True if the scanner is already initialized. |
![]() | MarginsAdjustable |
This property checks whether the margin is adjustable.
|
![]() | Name |
This property returns the unique name of the scanner.
|
![]() | Orientation |
This property is used to get or set the current orientation mode. |
![]() | PaperSizeAdjustable |
This property checks whether the paper size is adjustable.
|
![]() | PaperSource |
This property is used to get or set the scanner's current paper source. |
![]() | Resolution |
This property is used to get or set the current scan resolution. |
![]() | Scanning |
This property returns True if the scanner is scanning. |
![]() | Selected |
This method displays the selected scanner from the scanner list.
|
![]() | Version |
This property returns the version string of the scanner which is returned by the scanning subsystem.
|
Name | Description | |
---|---|---|
![]() | CloneAt |
Use this method to modify the settings of a given Scanner in the context of the target SettingManager. |
![]() | CopyFrom |
This method is used to copy the current values of the same Scanner's settings from the source SettingManager. |
![]() | CopyTo |
This method is used to copy the current values of the Scanner's settings to the target SettingManager.
|
![]() | Dispose | Releases all resources used by the Scanner |
![]() | GetADFSize |
This method is used to retrieve the maximum ADF scanning area size into the Width and Height parameters, measured in 1/1200 inches. |
![]() | GetBrightness |
This property is used to get or set the scan brightness value. |
![]() | GetContrast |
This property is used to get or set the current scan contrast. |
![]() | GetEngine |
Returns the Engine object.
|
![]() | GetFlatbedSize |
This method is used to retrieve the maximum flat-bed scanning area size into the Width and Height parameters, measured in 1/1200 inches. |
![]() | GetPaperSize |
This method returns the selected paper size. |
![]() | GetScanArea |
This method retrieves the current scanning area measured in 1/1200 inches.
|
![]() | GetScannerSize |
This method is used to retrieve the maximum scanning area size into the Width and Height parameters, measured in 1/1200 inches. |
![]() | GetStandardPaperSize |
This property checks the standard paper size of the scanner.
|
![]() | GetTransparencySize |
This method is used to retrieve the maximum transparency adapter scanning area size into the Width and Height parameters, measured in 1/1200 inches. |
![]() | GetUIMode |
This method is used to retrieve the current UI mode of the scanner, which can be RSDST_UI_SHOW, RSDST_UI_HIDE or RSDST_UI_ONCE. |
![]() | Init |
This method initializes the scanner. |
![]() | IsPaperSizeSupported |
This method returns True if the scanner supports the given paper size. |
![]() | LoadSettings |
This method loads the settings for a specified scanner from an external file. |
![]() | PreloadADF |
This method pre-loads paper from a storage bin into the ADF if the scanner supports this capability.
|
![]() | ReleaseScanner |
This method releases the previously reserved scanner. |
![]() | ReloadADF |
This method reloads paper back into the ADF from the output tray if the scanner supports this capability.
|
![]() | ReserveScanner |
This method reserves the scanner for the IPRO environment. |
![]() | ResetScanner |
This method resets the scanner. |
![]() | SaveSettings |
This method saves the settings of the particular scanner into an external file. |
![]() | ScanPages |
This method is used to Scan one or more pages. |
![]() | Select |
This method is used when selecting a scanner from the available scanner list.
|
![]() | SetBrightness |
This property is used to get or set the scan brightness value. |
![]() | SetContrast |
This property is used to get or set the current scan contrast. |
![]() | SetDefaults |
This method sets all scanner settings to the default values.
|
![]() | SetPaperSize |
This method sets the paper size for subsequent scanning operations. |
![]() | SetScanArea |
This method sets the scanning area of the scanner. |
![]() | SetUIMode |
This method is used to set the UI mode of the scanner, which can be RSDST_UI_SHOW, RSDST_UI_HIDE or RSDST_UI_ONCE. |
![]() | SupportedPapers |
This property lists the supported paper sizes of the scanner.
|
![]() | UnloadADF |
This method unloads the paper from the ADF if the scanner supports this capability.
|
![]() | Unselect |
Returns the state when no scanner is selected.
|
Name | Description | |
---|---|---|
![]() | OnScanContinue | |
![]() | OnScanFinished | |
![]() | OnScanInitFinished |
The Init method fires this event when the initialization procedure is finished. |
![]() | OnScanProgress |
This event is fired repeatedly during scanning to indicate the progress of the current operation. |
The Name property uniquely identifies the scanner. Prior to invoking scanner methods or accessing scanner properties, the particular scanner must be initialized calling the Init method. Depending on the scanner model this may take several seconds. Each scanner manages its scanning properties individually. To load or save a scanning profile using external files, invoke the Scanner object you can either scan images into image files - using the ScanPages method - or you can pass the Scanner object to the Document object's ScanImage method to scan pages directly into a particular document.