ScannedFileSettings

ScannedFileSettings

Contains the settings for the downloaded file or the file to be saved/retrieved.

Constructor

# new ScannedFileSettings()

Creates an instance of ScannedFileSettings.

Source:

Members

# fileName :String

The name of the file. From its extension, the file type will be determined. It is mandatory field.

Type:
  • String
Default Value:
  • "TWTwainJSDownloadedFile.pdf"
Source:

# imageQuality :Number

The quality of the image file. Ignored if the file type is not JPEG or PDF. If the value is NOT_SET (-1), image quality will be determined by the TWTwainClient app.

Type:
  • Number
Source:

# isMultiPageFile :Boolean

Whether to create the file as multi-page file or not. If true, the file will be created as multi-page file. Only PDF and TIFF files can be multi-page files.

Type:
  • Boolean
Default Value:
  • false
Source:

# pages :String

The pages to be included in generated file. If not set, all pages will be used. Example: "1-3,5,7-10". Invalid values are ignored.

Leaving it empty is the recommended way to say "every page". The page count is then resolved by the client, which is the side that holds the pages; deriving it in the browser would silently drop any page whose transfer failed.

Type:
  • String
Source:

# pdfProtection :PdfProtection

The pdf protection settings. Ignored if the file type is not PDF. If not set, pdf protection will be determined by the TWTwainClient app.

Type:
Source:

# tiffCompression :TiffCompression

The compression of the created TIFF file. Ignored if the file type is not TIFF. If the value is TiffCompression.NOT_SET, tiff compression will be determined by the TWTwainClient app.

Type:
  • TiffCompression
Source: