| RequestOutputItem Class |
» Asprise Scan Home · Developer's Guide
Specifies an output target in a scan request.
Inheritance HierarchyNamespace: 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)
SyntaxThe RequestOutputItem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RequestOutputItem | Initializes a new instance of the RequestOutputItem class |
| RequestOutputItem(String, String) |
Constructor.
|
Methods| Name | Description | |
|---|---|---|
| AddExifTag |
Exif tags, key should be any of AspriseImaging#EXIF_NAME_DocumentName
|
| Clone | |
| Equals | (Inherited from Object.) |
 | FromJsonMap |
Deserialize from JSON.
|
| GetExifTags |
Exif tags, key should be any of AspriseImaging#EXIF_NAME_DocumentName
|
| GetFormat |
Image format, any of AspriseImaging#FORMAT_JPG
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetJpegQuality |
Only for JPG format; default value: 80
|
| GetOutputType |
Output type, any of AspriseImaging#OUTPUT_SAVE ...
|
| GetPdfOwnerPassword |
PDF owner password
|
| GetPdfTextLine |
Optionally prints a line of text at the bottom of the first page.
|
| GetPdfUserPassword |
PDF user password
|
| GetSavePath |
Target output file path, may contain variable for expansion, e.g., C:\\tmp\\${TMS}${EXT}.
|
| GetThumbnailHeight |
Only for thumbnail output types; default value: 200.
|
| GetTiffCompression |
Any of AspriseImaging#TIFF_COMPRESSION_CCITT_G4 ... Only for TIF format; default value: (null)
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUploadSetting |
must be set when type is AspriseImaging#OUTPUT_UPLOAD or AspriseImaging#OUTPUT_UPLOAD_THUMB.
|
| IsPdfaCompliant |
Set to true to output PDF/A compliant PDF.
|
| IsPdfForceBlackWhite |
Force to output black/white PDF to save space.
|
| IsTiffForceSinglePage |
Force to save images into individual single-image tiff files.
|
| IsUploadAfterAllDone |
Perform upload after all scans. Default is true.
|
| IsUploadOneByOne |
Set to true to upload one image per HTTP request; otherwise upload all images in one HTTP request. Default: false.
|
| SetFormat |
Image format, any of AspriseImaging#FORMAT_JPG*/
|
| SetJpegQuality |
Only for JPG format; default value: 80
|
| SetPdfaCompliant |
Set to true to output PDF/A compliant PDF.
|
| SetPdfForceBlackWhite |
Force to output black/white PDF to save space.
|
| SetPdfOwnerPassword |
PDF owner password
|
| SetPdfTextLine |
Optionally prints a line of text at the bottom of the first page.
|
| SetPdfUserPassword |
PDF user password
|
| SetSavePath |
Target output file path, may contain variable for expansion, e.g., C:\\tmp\\${TMS}${EXT}.
|
| SetThumbnailHeight |
Only for thumbnail output types; default value: 200.
|
| SetTiffCompression |
Any of AspriseImaging#TIFF_COMPRESSION_CCITT_G4 ... Only for TIF format; default value: (null)
|
| setTiffForceSinglePage |
Force to save images into individual single-image tiff files.
|
| SetType |
Output type, any of AspriseImaging#OUTPUT_SAVE ...
|
| SetUploadAfterAllDone |
Perform upload after all scans. Default is true.
|
| SetUploadOneByOne |
Set to true to upload one image per HTTP request; otherwise upload all images in one HTTP request. Default: false.
|
| SetUploadSetting |
must be set when type is AspriseImaging#OUTPUT_UPLOAD AspriseImaging#OUTPUT_UPLOAD_THUMB.
|
| ToJsonObject |
Serialize to JSON.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | DEFAULT_JPEG_QUALITY |
Default JPEG quality.
|
| DEFAULT_THUMBNAIL_HEIGHT |
Default thumbnail height
|
See Also