ISX_ScanSetting Enumeration

Description

Option values for determining which scanner setting to query or set.

Members

Member	Value	Description
ISX_AdvancedTag	16	Specifies the scanner's advanced tag number.
ISX_BitsPerSample	15	Indicates how big a sample is. Typical values are: 1 = Binary; 4 = four-bit gray scale (16 shades of gray); 8 = eight-bit gray scale (256 shades of gray); 8 = 24-bit color.
ISX_Brightness	3	The scanner's brightness. If available, -3 will set to auto brightness, -2 will auto darken, and -1 will auto lighten. Values from 0 to RangeMaximumLong Property will incrementally change the brightness.
ISX_Contrast	4	The scanner's contrast. A value of 0 means auto contrast or no contrast control is available.
ISX_ImageLength	8	Specifies the number of rows of pixels (height) in an image.
ISX_ImageWidth	7	Specifies the number of columns of pixels (width) in an image.
ISX_PageSize	2	The total area available to the scanner.
ISX_ResUnit	9	Specifies the unit of measurement for XResolution and YResolution. This setting is not available for all scanners and if it is not available the units are assumed to be DPI. 1. No absolute unit of measurement. Used for images that may have a non-square aspect ratio, but no meaningful absolute dimensions. 2. Resolution is specified in dots per inch. 3. Resolution is specified in dots per centimeter.
ISX_SamplesPerPixel	14	Indicates how many values each pixel uses to represent its data. Possible values are: 1 sample per pixel = Binary black/white) and gray scale images; 3 samples per pixel = RGB color images.
ISX_ScanAhead	11	Specifies if the scanning source should enable the ability to continuously scan pages ahead of the current page the application is processing on those scanners that support this functionality. See the ISX_ScanAheadChoice Enumeration for more information.
ISX_ScanAheadMaxPages	12	If ScanAhead is enabled, this setting specifies the maximum number of pages to scan ahead. A zero value means to scan until the feeder is empty.
ISX_ScanAheadPages	13	If ScanAhead is enabled and this setting is supported, it will determine how many pages have been scanned in ahead. On some scanners this value will not be an accurate measurement for how many pages are scanned in ahead. Therefore, use this setting as a general indicator that there are pages waiting that have been scanned in ahead. This setting is read-only.
ISX_Type	10	Specifies the scanning source (flatbed, feeder, and etc.) on those scanners that support this functionality. See the ISX_Source Enumeration more information.
ISX_XPosition	5	Specifies the distance in pixels from the left edge of the page to the start of the image.
ISX_XResolution	0	The scanner's horizontal resolution in DPI.
ISX_YPosition	6	Specifies the distance in pixels from the top edge of the page to the start of the image.
ISX_YResolution	1	The scanner's vertical resolution in DPI.

Remarks

All scanner settings are modified by setting the ScanSetting Property to the appropriate setting and then using one of the setting properties such as the SettingLong Property or the SettingString Property to set up the scanner.

Before modifying a setting, the setting should be checked to see if it is supported and the choices for a setting should be queried to make sure the desired value is legal for the particular scanner.

The following table illustrates how to set a scanner mode. This information assumes that the scanner is capable of each mode.

Mode                    SamplesPerPixel                    BitsPerSample
Black/White                       1                                          1
16 Level Gray                    1                                          4
256 Level Gray                  1                                          8
24-bit Color                       3                                          8

Note: Palletized color images are not supported.

See the Overview topic for more information on Scanner Settings and examples.

Example

The following code could be used to set the scanner mode to 256-level gray scale.

ISISXpress.ScanSetting = ISX_ScanSetting.ISX_SamplesPerPixel
ISISXpress.SettingLong = 1
ISISXpress.ScanSetting = ISX_ScanSetting.ISX_BitsPerSample
ISISXpress.SettingLong = 8

The following code could be used to set the Brightness for the scanner.

ISISXpress.ScanSetting = ISX_ScanSetting.ISX_Brightness
ISISXpress.SettingLong = 23

Not all settings have an integer setting such as Brightness. The ISX_ScanSetting.ISX_PageSize property is usually a string and must be set with the SettingString property. For Example:

ISISXpress.ScanSetting = ISX_ScanSetting.ISX_PageSize
ISISXpress.SettingString = "scanners maximum"