Request Class

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

C++

Copy

public class Request : ICloneable

Public Class Request
	Implements ICloneable

public ref class Request : ICloneable

type Request =  
    class
        interface ICloneable
    end

The Request type exposes the following members.

Constructors

	Name	Description
	Request	Initializes a new instance of the Request class

Top

Methods

	Name	Description
	AddImageFile	Adds an image file.
	addImageFiles	Adds list of image files.
	AddOutputItem	Adds an output specification.
	AddOutputItems	Adds output specifications.
	AddRetrieveExtendedImageAttributes	Adds an extended image attribute to be retrieved.
	Clone	Deep clones.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FromJson	Deserialize from JSON strings.
	GetBlankPageMarginPercent	Percentage of margin to be excluded when calculating ink coverage.
	GetBlankPageThreshold	Ink coverage threshold to determine if a page is blank.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetId	Request ID
	GetImageFiles	Returns all image files.
	GetModalScannerUI	Whether scanner UI should be modal.
	GetOutputItems	Output specifications.
	GetRetrieveCaps	Names of caps to be retrieved.
	GetRetrieveExtendedImageAttributes	Name of extended image attributes to be retrieved.
	GetShowScannerUI	Whether scanner UI should be shown.
	GetSourceName	Source name
	GetTwainCapSetting	Map of cap name (could be appended with operation and priority, e.g., /RESET, /SET/3456).
	GetTwainCapValueAsInt	Returns the cap value setting specified in the request as int or -1 if failed to convert to int.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDiscardBlankPages	Whether blank pages should be discard.
	isOnWebServer
	IsProcessImagesAfterAllScans	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.
	isPromptScanMore	Whether to prompt scan more dialog.
	IsRecognizeBarcodes	Whether barcodes should be recognized.
	RemoveAllOutputItems	Clears all output items.
	RetrieveCap	Add a cap to be retrieved.
	SetBlankPageMarginPercent	Percentage of margin to be excluded when calculating ink coverage.
	SetBlankPageThreshold	Ink coverage threshold to determine if a page is blank.
	SetDiscardBlankPages	Whether blank pages should be discard.
	SetId	Request ID
	SetModalScannerUI	Whether scanner UI should be modal.
	SetOnWebServer
	SetProcessImagesAfterAllScans	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.
	SetPromptScanMore	Whether to prompt scan more dialog.
	SetRecognizeBarcodes	Whether barcodes should be recognized.
	SetShowScannerUI	Whether scanner UI should be shown.
	SetSourceName	The source name.
	SetTwainCap(Int32, Object)	Set twain capability.
	SetTwainCap(Int32, Object, Boolean)	Set or reset twain capability.
	ToJson	JSON serialization.
	ToJsonObject	Serializes to JSON.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	DEFAULT_BLANK_PAGE_MARGIN_PERCENT	Default blank page margin percent.
	DEFAULT_BLANK_PAGE_THRESHOLD	Defaule blank page threshold

Top

Reference

asprise_imaging_api Namespace