Request Class
Click or drag to resize
Request Class

» Asprise Scan Home · Developer's Guide

Represents a scan request.
Inheritance Hierarchy
SystemObject
  asprise_imaging_apiRequest

Namespace: asprise_imaging_api
Assembly: asprise-imaging-scan.net-api (in asprise-imaging-scan.net-api.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class Request : ICloneable

The Request type exposes the following members.

Constructors
  NameDescription
Public methodRequest
Initializes a new instance of the Request class
Top
Methods
  NameDescription
Public methodAddImageFile
Adds an image file.
Public methodaddImageFiles
Adds list of image files.
Public methodAddOutputItem
Adds an output specification.
Public methodAddOutputItems
Adds output specifications.
Public methodAddRetrieveExtendedImageAttributes
Adds an extended image attribute to be retrieved.
Public methodClone
Deep clones.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberFromJson
Deserialize from JSON strings.
Public methodGetBlankPageMarginPercent
Percentage of margin to be excluded when calculating ink coverage.
Public methodGetBlankPageThreshold
Ink coverage threshold to determine if a page is blank.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetId
Request ID
Public methodGetImageFiles
Returns all image files.
Public methodGetModalScannerUI
Whether scanner UI should be modal.
Public methodGetOutputItems
Output specifications.
Public methodGetRetrieveCaps
Names of caps to be retrieved.
Public methodGetRetrieveExtendedImageAttributes
Name of extended image attributes to be retrieved.
Public methodGetShowScannerUI
Whether scanner UI should be shown.
Public methodGetSourceName
Source name
Public methodGetTwainCapSetting
Map of cap name (could be appended with operation and priority, e.g., /RESET, /SET/3456).
Public methodGetTwainCapValueAsInt
Returns the cap value setting specified in the request as int or -1 if failed to convert to int.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsDiscardBlankPages
Whether blank pages should be discard.
Public methodisOnWebServer
Public methodIsProcessImagesAfterAllScans
By default images will be processed after each scan; Set to true to process images after all scans. Processing images after all scan could speed up the scanning process.
Public methodisPromptScanMore
Whether to prompt scan more dialog.
Public methodIsRecognizeBarcodes
Whether barcodes should be recognized.
Public methodRemoveAllOutputItems
Clears all output items.
Public methodRetrieveCap
Add a cap to be retrieved.
Public methodSetBlankPageMarginPercent
Percentage of margin to be excluded when calculating ink coverage.
Public methodSetBlankPageThreshold
Ink coverage threshold to determine if a page is blank.
Public methodSetDiscardBlankPages
Whether blank pages should be discard.
Public methodSetId
Request ID
Public methodSetModalScannerUI
Whether scanner UI should be modal.
Public methodSetOnWebServer
Public methodSetProcessImagesAfterAllScans
By default images will be processed after each scan; Set to true to process images after all scans. Processing images after all scan could speed up the scanning process.
Public methodSetPromptScanMore
Whether to prompt scan more dialog.
Public methodSetRecognizeBarcodes
Whether barcodes should be recognized.
Public methodSetShowScannerUI
Whether scanner UI should be shown.
Public methodSetSourceName
The source name.
Public methodSetTwainCap(Int32, Object)
Set twain capability.
Public methodSetTwainCap(Int32, Object, Boolean)
Set or reset twain capability.
Public methodToJson
JSON serialization.
Public methodToJsonObject
Serializes to JSON.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberDEFAULT_BLANK_PAGE_MARGIN_PERCENT
Default blank page margin percent.
Public fieldStatic memberDEFAULT_BLANK_PAGE_THRESHOLD
Defaule blank page threshold
Top
See Also