VintaSoft Twain .NET SDK v10.2
WebDeviceCapabilityIdJS Enumeration
Vintasoft.Twain Namespace : WebDeviceCapabilityIdJS Enumeration
Specifies available device capabilities.
Members
MemberDescription
AlarmsTurns specific audible alarms on and off.
AlarmVolumeThe volume of a device's audible alarm. Note that this control affects the volume of all alarms; no specific volume control for individual types of alarms is provided.
AuthorThe name or other identifying information about the Author of the image. It may include a copyright string.
AutoFeedIf TRUE, the Source will automatically feed the next page from the document feeder after the number of frames negotiated for capture from each page are acquired.
AutomaticCaptureThe number of images to automatically capture. This does not refer to the number of images to be sent to the Application, use DeviceCapability.XferCount for that.
AutomaticSenseMediumSpecifies whether to acquire images from the Automatic Document Feeder or from the Flatbed.
AutoScanThis capability is intended to boost the performance of a Source.
BatteryMinutesThe minutes of battery power remaining to the device.
BatteryPercentageWhen used with MSG_GET, return the percentage of battery power level on camera. If -1 is returned, it indicates that the battery is not present.
CameraEnabledDelivers images from the current camera. Supported from TWAIN 2.0.
CameraOrderSelects the order of output for Single Document Multiple Image mode. Supported from TWAIN 2.0.
CameraPreviewUIThis capability queries the Source for UI support for preview mode. If TRUE, the Source supports preview UI.
CameraSideSets the top and bottom values of cameras in a scanning device. Supported from TWAIN 1.91.
CaptionA general note about the acquired image.
ClearBuffersMSG_GET reports the presence of data in the scanner's buffers. MSG_SET with a value of TWCB_CLEAR immediately clears the buffers.
ClearPageIf TRUE, the Source will eject the current page being acquired from and will leave the feeder acquire area empty.
CustomDsDataAllows the application to query the data source to see if current settings of device can be get/set.
CustomInterfaceGuidUniquely identifies an interface for a Data Source. Supported from TWAIN 2.1.
DeviceEventsSpecifies which events the Application wants the Source to report.
DeviceOnlineIf TRUE, the physical hardware (e.g., scanner, digital camera, image database, etc.) that represents the image source is attached, powered on, and communicating.
DeviceTimeDateThe date and time of the device's clock.
DoubleFeedDetectionControls the way the data source detects double feed events.
DoubleFeedDetectionLengthAdjusts double feed detection for document length.
DoubleFeedDetectionResponseAdjusts how the data source handles double feed events.
DoubleFeedDetectionSensitivityAdjusts double feed detection for ultrasonic.
DuplexThis indicates whether the scanner supports duplex. If so, it further indicates whether one-path or two-path duplex is supported.
DuplexEnabledThe user can set the duplex option to be TRUE or FALSE. If TRUE, the scanner scans both sides of a paper; otherwise, the scanner will scan only one side of the image.
EnableDsUiOnlyQueries an application to see if it implements the new userinterface settings dialog.
EndOrSerAllows the application to specify the starting endorser / imprinter number. All other endorser/imprinter properties should be handled through the data source's user interface.
ExtendedCapsAllows the application and Source to negotiate capabilities to be used in States 5 and 6.
FeederAlignmentHelps the Application determine any special actions it may need to take when negotiating frames with the Source.
FeederEnabledIf TRUE, Source must acquire data from the document feeder acquire area and other feeder capabilities can be used. If FALSE, Source must acquire data from the non-feeder acquire area and no other feeder capabilities can be used.
FeederLoadedReflect whether there are documents loaded in the Source's feeder.
FeederOrderTWFO_FIRSTPAGEFIRST if the feeder starts with the top of the first page. TWFO_LASTPAGEFIRST is the feeder starts with the top of the last page.
FeederPocketReport what pockets are available as paper leaves a device. Supported from TWAIN 2.0.
FeederPrepImprove the movement of paper through a scanner ADF. Supported from TWAIN 2.0.
FeedPageIf TRUE, the Source will eject the current page and advance the next page in the document feeder into the feeder acquire area.
IAutoBrightTRUE enables and FALSE disables the Source's Auto-brightness function (if any).
IAutoDiscardBlankPagesDiscards blank pages. Supported from TWAIN 2.0.
IAutomaticBorderDetectionTurns automatic border detection on and off. Supported from TWAIN 1.8.
IAutomaticColorEnabledDetects the pixel type of the image and returns either a color image or a non-color image specified by AutomaticColorNonColorPixelType. Supported from TWAIN 2.1.
IAutomaticColorNonColorPixelTypeSpecifies the non-color pixel type to use when automatic color is enabled. Supported from TWAIN 2.1.
IAutomaticCropUsesFrameReduces the amount of data captured from the device, potentially improving the performance of the driver. Supported from TWAIN 2.1.
IAutomaticDeskewTurns automatic deskew correction on and off. Supported from TWAIN 1.8.
IAutomaticLengthDetectionControls the automatic detection of the length of a document, this is intended for use with an Automatic Document Feeder. Supported from TWAIN 2.1.
IAutomaticRotateWhen TRUE this capability depends on intelligent features within the Source to automatically rotate the image to the correct position. Supported from TWAIN 1.8.
IAutoSizeForce the output image dimensions to match either the current value of ISupportedSizes or any of its current allowed values. Supported from TWAIN 2.0.
IBarCodeDetectionEnabledTurns bar code detection on and off. Supported from TWAIN 1.8.
IBarCodeMaxRetriesRestricts the number of times a search will be retried if none are found on each page. Supported from TWAIN 1.8.
IBarCodeMaxSearchPrioritiesThe maximum number of supported search priorities. Supported from TWAIN 1.8.
IBarCodeSearchModeRestricts bar code searching to certain orientations, or prioritizes one orientation over the other. Supported from TWAIN 1.8.
IBarCodeSearchPrioritiesA prioritized list of bar code types dictating the order in which bar codes will be sought. Supported from TWAIN 1.8.
IBarCodeTimeoutRestricts the total time spent on searching for a bar code on each page. Supported from TWAIN 1.8.
IBitDepthSpecifies the pixel bit depths for the Current value of IPixelType.
IBitDepthReductionSpecifies the Reduction Method the Source should use to reduce the bit depth of the data. Most commonly used with IPixelType = PixelType.BW to reduce gray data to black and white. Supported from TWAIN 1.5.
IBitOrderSpecifies how the bytes in an image are filled by the Source. TWBO_MSBFIRST indicates that the leftmost bit in the byte (usually bit 7) is the byte's Most Significant Bit.
IBitOrderCodesUsed for CCITT data compression only. Indicates the bit order representation of the stored compressed codes.
IBrightnessThe brightness values available within the Source.
ICcittKFactorUsed for CCITT Group 3 2-dimensional compression. The K factor indicates how often the new compression baseline should be re-established. A value of 2 or 4 is common in facsimile communication. A value of zero in this field will indicate an infinite K factor the baseline is only calculated at the beginning of the transfer.
IColorManagementEnabledDisables the Source's color and gamma tables for color and grayscale images, resulting in output that that could be termed "raw". Supported from TWAIN 2.1.
ICompressionAllows the application and Source to identify which compression schemes they have in common for Buffered Memory and File transfers.
IContrastThe contrast values available within the Source.
ICustomHalftoneSpecifies the square-cell halftone (dithering) matrix the Source should use to halftone the image.
IExposureTimeSpecifies the exposure time used to capture the image, in seconds.
IExtImageInfoAllows the application to query the data source to see if it supports the new operation triplet DG_IMAGE/DAT_EXTIMAGEINFO/MSG_GET. Supported from TWAIN 1.7.
IFeederTypeAllows the Application to set scan parameters depending upon the type of feeder. Supported from TWAIN 1.91.
IFilmTypeSpecify the type of transmissive media (positive or negative). Supported from TWAIN 2.2.
IFilterDescribes the color characteristic of the subtractive filter applied to the image data. Multiple filters may be applied to a single acquisition.
IFlashUsedSpecifies whether or not the image was acquired using a flash.
IFlashUsed2For devices that support flash. MSG_SET selects the flash to be used (if any). MSG_GET reports the current setting. This capability replaces IFlashUsed, which is only able to negotiate the flash being on or off. Supported from TWAIN 1.8.
IFlipRotationFlip rotation is used to properly orient images that flip orientation every other image. Supported from TWAIN 1.8.
IFramesThe list of frames the Source will acquire on each page.
IGammaGamma correction value for the image data.
IHalftonesA list of names of the halftone patterns available within the Source.
IHighlightSpecifies which value in an image should be interpreted as the lightest "highlight."
IIccProfileEmbeds or links ICC profiles into files. Supported from TWAIN 1.91.
IImageDataSetGets or sets the image indices that will be delivered during the standard image transfer done in States 6 and 7. Supported from TWAIN 1.7.
IImageFileFormatInforms the application which file formats the Source can generate (MSG_GET). Tells the Source which file formats the application can handle (MSG_SET).
IImageFilterFor devices that support image enhancement filtering. This capability selects the algorithm used to improve the quality of the image. Supported from TWAIN 1.8.
IImageMergeMerges the front and rear image of a document in one of four orientations: front on the top. Supported from TWAIN 2.1.
IImageMergeHeightThresholdSpecifies a Y-Offset in ICAP_UNITS units. Supported from TWAIN 2.1.
IJpegPixelTypeSpecifies the JPEG pixel type.
IJpegQualitySpecifies quality for JPEG images. Supported from TWAIN 1.91.
IJpegSubsamplingSelects JPEG quantization. Supported from TWAIN 2.2.
ILampStateTRUE means the lamp is currently, or should be set to ON. Sources may not support MSG_SET operations.
ILightPathDescribes whether the image was captured transmissively or reflectively.
ILightSourceDescribes the general color characteristic of the light source used to acquire the image.
IMaxFramesThe maximum number of frames the Source can provide or the application can accept per page. This is a bounding capability only. It does not establish current or future behavior.
IMinimumHeightAllows the source to define the minimum height (Y-axis) that the source can acquire. Supported from TWAIN 1.7.
IMinimumWidthAllows the source to define theminimum width (X-axis) that the source can acquire. Supported from TWAIN 1.7.
IMirrorControls output of a mirror image of the input document. Supported from TWAIN 2.2.
IndicatorsIf TRUE, the Source will display a progress indicator during acquisition and transfer, regardless of whether the Source's user interface is active. If FALSE, the progress indicator will be suppressed if the Source's user interface is inactive.
IndicatorsModeControls GUI messages allowed when the full GUI is not being displayed. Supported from TWAIN 2.2.
INoiseFilterFor devices that support noise filtering. This capability selects the algorithm used to remove noise. Supported from TWAIN 1.8.
IOrientationDefines which edge of the "paper" the image's "top" is aligned with. This information is used to adjust the frames to match the scanning orientation of the paper.
IOverScanOverscan is used to scan outside of the boundaries described by IFrames, and is used to help acquire image data that may be lost because of skewing. Supported from TWAIN 1.8.
IPatchCodeDetectionEnabledTurns patch code detection on and off. Supported from TWAIN 1.8.
IPatchCodeMaxRetriesRestricts the number of times a search will be retried if none are found on each page. Supported from TWAIN 1.8.
IPatchCodeMaxSearchPrioritiesThe maximum number of supported search priorities. Supported from TWAIN 1.8.
IPatchCodeSearchModeRestricts patch code searching to certain orientations, or prioritizes one orientation over the other. Supported from TWAIN 1.8.
IPatchCodeSearchPrioritiesA prioritized list of patch code types dictating the order in which patch codes will be sought. Supported from TWAIN 1.8.
IPatchCodeTimeoutRestricts the total time spent on searching for a patch code on each page. Supported from TWAIN 1.8.
IPhysicalHeightThe maximum physical height (Y-axis) the Source can acquire (measured in units of IUnits).
IPhysicalWidthThe maximum physical width (X-axis) the Source can acquire (measured in units of IUnits).
IPixelFlavorSense of the pixel whose numeric value is zero (minimum data value).
IPixelFlavorCodesUsed only for CCITT data compression. Specifies whether the compressed codes' pixel "sense" will be inverted from the Current value of IPixelFlavor prior to transfer.
IPixelTypeThe type of pixel data that a Source is capable of acquiring (for example, black and white, gray, RGB, etc.).
IPlanarChunkyAllows the application and Source to identify which color data formats are available. There are two options, "planar" and "chunky."
IRotationHow the Source can/should rotate the scanned image data prior to transfer. This doesn't use IUnits. It is always measured in degrees. Any applied value is additive with any rotation specified in IOrientation.
IShadowSpecifies which value in an image should be interpreted as the darkest "shadow." All values "darker" than this value will be clipped to this value.
ISupportedBarCodeTypesProvides a list of bar code types that can be detected by the current Data Source. Supported from TWAIN 1.8.
ISupportedExtImageInfoLists all of the information that the Source is capable of returning from a call to DAT_EXTIMAGEINFO. Supported from TWAIN 2.1.
ISupportedPatchCodeTypesA list of patch code types that may be detected by the current Data Source. Supported from TWAIN 1.8.
ISupportedSizesFor devices that support fixed frame sizes. Defined sizes match typical page sizes. This specifies the size(s) the Source can/should use to acquire image data.
IThresholdSpecifies the dividing line between black and white.
ITilesThis is used with buffered memory transfers. If TRUE, Source can provide application with tiled image data.
ITimeFillUsed only with CCITT data compression. Specifies the minimum number of words of compressed codes (compressed data) to be transmitted per line.
IUndefinedImageSizeIf TRUE the Source will issue a MSG_XFERREADY before starting the scan. Supported from TWAIN 1.6.
IUnitsDetermines the unit of measure for all quantities.
IXferMechAllows the application and Source to identify which transfer mechanisms they have in common.
IXNativeResolutionThe native optical resolution along the X-axis of the device being controlled by the Source. Most devices will respond with a single value (TW_ONEVALUE).
IXResolutionAll the X-axis resolutions the Source can provide.
IXScalingAll the X-axis scaling values available. A value of '1.0' is equivalent to 100% scaling. Do not use values less than or equal to zero.
IYNativeResolutionThe native optical resolution along the Y-axis of the device being controlled by the Source.
IYResolutionAll the Y-axis resolutions the Source can provide.
IYScalingAll the Y-axis scaling values available. A value of '1.0' is equivalent to 100% scaling. Do not use values less than or equal to zero.
IZoomFactorReturns all camera supported lens zooming range or sets zooming value. Supported from TWAIN 1.8.
JobControlAllows multiple jobs in batch mode.
LanguageAllows Application and Source to identify which languages they have in common for the exchange of string data, and to select the language of the internal UI.
MaxBatchBuffersDescribes the number of pages that the scanner can buffer when DeviceCapability.AutoScan is enabled.
MicrEnabledEnables actions needed to support check scanning. Supported from TWAIN 2.0.
PaperDetectableThis capability determines whether the device has a paper sensor that can detect documents on the ADF or Flatbed.
PaperHandlingControl paper handling.
PowerSaveTimeGets or sets the camera power down timer in seconds. Supported from TWAIN 1.8.
PowerSupplyMSG_GET reports the kinds of power available to the device. MSG_GETCURRENT reports the current power supply in use.
PrinterMSG_GET returns the current list of available printer devices, along with the one currently being used for negotiation.
PrinterCharRotationRotates characters printed on documents. Supported from TWAIN 2.3.
PrinterEnabledTurns the current DeviceCapability.Printer device on or off.
PrinterFontStyleSelects characteristics of the font printed on documents (ex: bold, italic). Supported from TWAIN 2.3.
PrinterIndexThe User can set the starting number for the current DeviceCapability.Printer device.
PrinterIndexLeadCharSelects the left side padding of numeric values printed on documents (ex: zero fill). Supported from TWAIN 2.3.
PrinterIndexMaxValueMaximum allowed value for DeviceCapabilityId.PrintIndex. Supported from TWAIN 2.3.
PrinterIndexNumDigitsTotal number of digits allowed in DeviceCapabilityId.PrinterIndex. Supported from TWAIN 2.3.
PrinterIndexStepStep size when incrementing DeviceCapabilityId.PrinterIndex for each document. Supported from TWAIN 2.3.
PrinterIndexTriggerKinds of documents that cause DeviceCapabilityId.PrinterIndex to increment. Supported from TWAIN 2.3.
PrinterModeSpecifies the appropriate current DeviceCapability.Printer device mode.
PrinterStringSpecifies the string(s) that are to be used in the string component when the current DeviceCapability.Printer device is enabled.
PrinterStringPreviewA sample string representing the currently selected printing options. Supported from TWAIN 2.3.
PrinterSuffixSpecifies the string that shall be used as the current DeviceCapability.Printer device's suffix.
PrinterVerticalOffsetY-Offset for current Printer device. Supported from TWAIN 2.2.
ReacquireAllowedIndicates whether the physical hardware (e.g. scanner, digital camera) is capable of acquiring multiple images of the same page without changes to the physical registration of that page.
RewindPageIf TRUE, the Source will return the current page to the input side of the document feeder and feed the last page from the output side of the feeder back into the acquisition area.
SegmentedDescribes the segmentation setting for captured images. Supported from TWAIN 1.91.
SerialNumberA string containing the serial number of the currently selected device in the Source. Multiple devices may all report the same serial number.
SupportedCapsReturns a list of all the capabilities for which the Source will answer inquiries. Does not indicate which capabilities the Source will allow to be set by the application.
SupportedCapsExtReturns a list of all the capabilities for which the Source will answer inquiries.
SupportedCapsSegmentUniqueFor Sources that allow unique values to be set for things like the top and bottom or for each segment on a page. Returns a list of all the capabilities for which the Source allows to have unique values. Supported from TWAIN 2.2.
SupportedDatsReturns a list of all the Data Argument Types (DAT_xxx) for which the Source will answer inquiries. Supported from TWAIN 2.2.
ThumbnailsEnabledAllows an application to request the delivery of thumbnail representations for the set of images that are to be delivered.
TimeBeforeFirstCaptureFor automatic capture, this value selects the number of milliseconds before the first picture is to be taken, or the first image is to be scanned.
TimeBetweenCapturesFor automatic capture, this value selects the milliseconds to wait between pictures taken, or images scanned.
TimeDateThe date and time the image was acquired.
UIControllableIf TRUE, indicates that this Source supports acquisition with the UI disabled. If FALSE, indicates that this Source can only support acquisition with the UI enabled.
XferCountThe application is willing to accept this number of images.
Inheritance Hierarchy

Object
   Vintasoft.Twain.WebDeviceCapabilityIdJS

Browser Compatibility
9
5
11
5
See Also

Reference

Vintasoft.Twain Namespace