VintaSoft Twain .NET SDK v10.2
Vintasoft.Twain Namespace / DeviceCapabilityId Enumeration




In This Topic
    DeviceCapabilityId Enumeration
    In This Topic
    Specifies available device capabilities.
    Syntax
    'Declaration
     
    Public Enum DeviceCapabilityId 
       Inherits System.Enum
    'Usage
     
    Dim instance As DeviceCapabilityId
    public enum DeviceCapabilityId : System.Enum 
    __value public enum DeviceCapabilityId : public System.Enum 
    public enum class DeviceCapabilityId : public System.Enum 
    Members
    MemberValueDescription
    Alarms4120Turns specific audible alarms on and off.
    AlarmVolume4121The 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.
    Author4096The name or other identifying information about the Author of the image. It may include a copyright string.
    AutoFeed4103If 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.
    AutomaticCapture4122The 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.
    AutomaticSenseMedium4155Specifies whether to acquire images from the Automatic Document Feeder or from the Flatbed.
    AutoScan4112This capability is intended to boost the performance of a Source.
    BatteryMinutes4146The minutes of battery power remaining to the device.
    BatteryPercentage4147When 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.
    CameraEnabled4150Delivers images from the current camera. Supported from TWAIN 2.0.
    CameraOrder4151Selects the order of output for Single Document Multiple Image mode. Supported from TWAIN 2.0.
    CameraPreviewUI4129This capability queries the Source for UI support for preview mode. If TRUE, the Source supports preview UI.
    CameraSide4148Sets the top and bottom values of cameras in a scanning device. Supported from TWAIN 1.91.
    Caption4097A general note about the acquired image.
    ClearBuffers4125MSG_GET reports the presence of data in the scanner's buffers. MSG_SET with a value of TWCB_CLEAR immediately clears the buffers.
    ClearPage4104If TRUE, the Source will eject the current page being acquired from and will leave the feeder acquire area empty.
    CustomDsData4117Allows the application to query the data source to see if current settings of device can be get/set.
    CustomInterfaceGuid4156Uniquely identifies an interface for a Data Source. Supported from TWAIN 2.1.
    DeviceEvents4130Specifies which events the Application wants the Source to report.
    DeviceOnline4111If TRUE, the physical hardware (e.g., scanner, digital camera, image database, etc.) that represents the image source is attached, powered on, and communicating.
    DeviceTimeDate4127The date and time of the device's clock.
    DoubleFeedDetection4159Controls the way the data source detects double feed events.
    DoubleFeedDetectionLength4160Adjusts double feed detection for document length.
    DoubleFeedDetectionResponse4162Adjusts how the data source handles double feed events.
    DoubleFeedDetectionSensitivity4161Adjusts double feed detection for ultrasonic.
    Duplex4114This indicates whether the scanner supports duplex. If so, it further indicates whether one-path or two-path duplex is supported.
    DuplexEnabled4115The 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.
    EnableDsUiOnly4116Queries an application to see if it implements the new user interface settings dialog.
    EndOrSer4118Allows the application to specify the starting endorser / imprinter number. All other endorser/imprinter properties should be handled through the data source's user interface.
    ExtendedCaps4102Allows the application and Source to negotiate capabilities to be used in States 5 and 6.
    FeederAlignment4141Helps the Application determine any special actions it may need to take when negotiating frames with the Source.
    FeederEnabled4098If 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.
    FeederLoaded4099Reflect whether there are documents loaded in the Source's feeder.
    FeederOrder4142TWFO_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.
    FeederPocket4154Report what pockets are available as paper leaves a device. Supported from TWAIN 2.0.
    FeederPrep4153Improve the movement of paper through a scanner ADF. Supported from TWAIN 2.0.
    FeedPage4105If TRUE, the Source will eject the current page and advance the next page in the document feeder into the feeder acquire area.
    IAutoBright4352TRUE enables and FALSE disables the Source's Auto-brightness function (if any).
    IAutoDiscardBlankPages4404Discards blank pages. Supported from TWAIN 2.0.
    IAutomaticBorderDetection4432Turns automatic border detection on and off. Supported from TWAIN 1.8.
    IAutomaticColorEnabled4441Detects 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.
    IAutomaticColorNonColorPixelType4442Specifies the non-color pixel type to use when automatic color is enabled. Supported from TWAIN 2.1.
    IAutomaticCropUsesFrame4439Reduces the amount of data captured from the device, potentially improving the performance of the driver. Supported from TWAIN 2.1.
    IAutomaticDeskew4433Turns automatic deskew correction on and off. Supported from TWAIN 1.8.
    IAutomaticLengthDetection4440Controls the automatic detection of the length of a document, this is intended for use with an Automatic Document Feeder. Supported from TWAIN 2.1.
    IAutomaticRotate4434When TRUE this capability depends on intelligent features within the Source to automatically rotate the image to the correct position. Supported from TWAIN 1.8.
    IAutoSize4438Force the output image dimensions to match either the current value of ISupportedSizes or any of its current allowed values. Supported from TWAIN 2.0.
    IBarCodeDetectionEnabled4407Turns bar code detection on and off. Supported from TWAIN 1.8.
    IBarCodeMaxRetries4412Restricts the number of times a search will be retried if none are found on each page. Supported from TWAIN 1.8.
    IBarCodeMaxSearchPriorities4409The maximum number of supported search priorities. Supported from TWAIN 1.8.
    IBarCodeSearchMode4411Restricts bar code searching to certain orientations, or prioritizes one orientation over the other. Supported from TWAIN 1.8.
    IBarCodeSearchPriorities4410A prioritized list of bar code types dictating the order in which bar codes will be sought. Supported from TWAIN 1.8.
    IBarCodeTimeout4413Restricts the total time spent on searching for a bar code on each page. Supported from TWAIN 1.8.
    IBitDepth4395Specifies the pixel bit depths for the Current value of IPixelType.
    IBitDepthReduction4396Specifies 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.
    IBitOrder4380Specifies 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.
    IBitOrderCodes4390Used for CCITT data compression only. Indicates the bit order representation of the stored compressed codes.
    IBrightness4353The brightness values available within the Source.
    ICcittKFactor4381Used 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.
    IColorManagementEnabled4443Disables 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.
    ICompression256Allows the application and Source to identify which compression schemes they have in common for Buffered Memory and File transfers.
    IContrast4355The contrast values available within the Source.
    ICustomHalftone4356Specifies the square-cell halftone (dithering) matrix the Source should use to halftone the image.
    IExposureTime4357Specifies the exposure time used to capture the image, in seconds.
    IExtImageInfo4399Allows 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.
    IFeederType4436Allows the Application to set scan parameters depending upon the type of feeder. Supported from TWAIN 1.91.
    IFilmType4447Specify the type of transmissive media (positive or negative). Supported from TWAIN 2.2.
    IFilter4358Describes the color characteristic of the subtractive filter applied to the image data. Multiple filters may be applied to a single acquisition.
    IFlashUsed4359Specifies whether or not the image was acquired using a flash.
    IFlashUsed24422For 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.
    IFlipRotation4406Flip rotation is used to properly orient images that flip orientation every other image. Supported from TWAIN 1.8.
    IFrames4372The list of frames the Source will acquire on each page.
    IGamma4360Gamma correction value for the image data.
    IHalftones4361A list of names of the halftone patterns available within the Source.
    IHighlight4362Specifies which value in an image should be interpreted as the lightest "highlight."
    IIccProfile4437Embeds or links ICC profiles into files. Supported from TWAIN 1.91.
    IImageDataSet4398Gets 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.
    IImageFileFormat4364Informs the application which file formats the Source can generate (MSG_GET). Tells the Source which file formats the application can handle (MSG_SET).
    IImageFilter4423For devices that support image enhancement filtering. This capability selects the algorithm used to improve the quality of the image. Supported from TWAIN 1.8.
    IImageMerge4444Merges the front and rear image of a document in one of four orientations: front on the top. Supported from TWAIN 2.1.
    IImageMergeHeightThreshold4445Specifies a Y-Offset in ICAP_UNITS units. Supported from TWAIN 2.1.
    IJpegPixelType4392Specifies the JPEG pixel type.
    IJpegQuality4435Specifies quality for JPEG images. Supported from TWAIN 1.91.
    IJpegSubsampling4449Selects JPEG quantization. Supported from TWAIN 2.2.
    ILampState4365TRUE means the lamp is currently, or should be set to ON. Sources may not support MSG_SET operations.
    ILightPath4382Describes whether the image was captured transmissively or reflectively.
    ILightSource4366Describes the general color characteristic of the light source used to acquire the image.
    IMaxFrames4378The 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.
    IMinimumHeight4400Allows the source to define the minimum height (Y-axis) that the source can acquire. Supported from TWAIN 1.7.
    IMinimumWidth4401Allows the source to define theminimum width (X-axis) that the source can acquire. Supported from TWAIN 1.7.
    IMirror4448Controls output of a mirror image of the input document. Supported from TWAIN 2.2.
    Indicators4107If 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.
    IndicatorsMode4164Controls GUI messages allowed when the full GUI isn't being displayed. Supported from TWAIN 2.2.
    INoiseFilter4424For devices that support noise filtering. This capability selects the algorithm used to remove noise. Supported from TWAIN 1.8.
    IOrientation4368Defines 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.
    IOverScan4425Overscan 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.
    IPatchCodeDetectionEnabled4415Turns patch code detection on and off. Supported from TWAIN 1.8.
    IPatchCodeMaxRetries4420Restricts the number of times a search will be retried if none are found on each page. Supported from TWAIN 1.8.
    IPatchCodeMaxSearchPriorities4417The maximum number of supported search priorities. Supported from TWAIN 1.8.
    IPatchCodeSearchMode4419Restricts patch code searching to certain orientations, or prioritizes one orientation over the other. Supported from TWAIN 1.8.
    IPatchCodeSearchPriorities4418A prioritized list of patch code types dictating the order in which patch codes will be sought. Supported from TWAIN 1.8.
    IPatchCodeTimeout4421Restricts the total time spent on searching for a patch code on each page. Supported from TWAIN 1.8.
    IPhysicalHeight4370The maximum physical height (Y-axis) the Source can acquire (measured in units of IUnits).
    IPhysicalWidth4369The maximum physical width (X-axis) the Source can acquire (measured in units of IUnits).
    IPixelFlavor4383Sense of the pixel whose numeric value is zero (minimum data value).
    IPixelFlavorCodes4391Used only for CCITT data compression. Specifies whether the compressed codes' pixel "sense" will be inverted from the Current value of IPixelFlavor prior to transfer.
    IPixelType257The type of pixel data that a Source is capable of acquiring (for example, black and white, gray, RGB, etc.).
    IPlanarChunky4384Allows the application and Source to identify which color data formats are available. There are two options, "planar" and "chunky."
    IRotation4385How 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.
    IShadow4371Specifies which value in an image should be interpreted as the darkest "shadow." All values "darker" than this value will be clipped to this value.
    ISupportedBarCodeTypes4408Provides a list of bar code types that can be detected by the current Data Source. Supported from TWAIN 1.8.
    ISupportedExtImageInfo4446Lists all of the information that the Source is capable of returning from a call to DAT_EXTIMAGEINFO. Supported from TWAIN 2.1.
    ISupportedPatchCodeTypes4416A list of patch code types that may be detected by the current Data Source. Supported from TWAIN 1.8.
    ISupportedSizes4386For 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.
    IThreshold4387Specifies the dividing line between black and white.
    ITiles4379This is used with buffered memory transfers. If TRUE, Source can provide application with tiled image data.
    ITimeFill4394Used only with CCITT data compression. Specifies the minimum number of words of compressed codes (compressed data) to be transmitted per line.
    IUndefinedImageSize4397If TRUE the Source will issue a MSG_XFERREADY before starting the scan. Supported from TWAIN 1.6.
    IUnits258Determines the unit of measure for all quantities.
    IXferMech259Allows the application and Source to identify which transfer mechanisms they have in common.
    IXNativeResolution4374The 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).
    IXResolution4376All the X-axis resolutions the Source can provide.
    IXScaling4388All 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.
    IYNativeResolution4375The native optical resolution along the Y-axis of the device being controlled by the Source.
    IYResolution4377All the Y-axis resolutions the Source can provide.
    IYScaling4389All 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.
    IZoomFactor4414Returns all camera supported lens zooming range or sets zooming value. Supported from TWAIN 1.8.
    JobControl4119Allows multiple jobs in batch mode.
    Language4140Allows 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.
    MaxBatchBuffers4126Describes the number of pages that the scanner can buffer when DeviceCapability.AutoScan is enabled.
    MicrEnabled4152Enables actions needed to support check scanning. Supported from TWAIN 2.0.
    PaperDetectable4109This capability determines whether the device has a paper sensor that can detect documents on the ADF or Flatbed.
    PaperHandling4163Control paper handling.
    PowerSaveTime4166Gets or sets the camera power down timer in seconds. Supported from TWAIN 1.8.
    PowerSupply4128MSG_GET reports the kinds of power available to the device. MSG_GETCURRENT reports the current power supply in use.
    Printer4134MSG_GET returns the current list of available printer devices, along with the one currently being used for negotiation.
    PrinterCharRotation4167Rotates characters printed on documents. Supported from TWAIN 2.3.
    PrinterEnabled4135Turns the current DeviceCapability.Printer device on or off.
    PrinterFontStyle4168Selects characteristics of the font printed on documents (ex: bold, italic). Supported from TWAIN 2.3.
    PrinterIndex4136The User can set the starting number for the current DeviceCapability.Printer device.
    PrinterIndexLeadChar4169Selects the left side padding of numeric values printed on documents (ex: zero fill). Supported from TWAIN 2.3.
    PrinterIndexMaxValue4170Maximum allowed value for DeviceCapabilityId.PrintIndex. Supported from TWAIN 2.3.
    PrinterIndexNumDigits4171Total number of digits allowed in DeviceCapabilityId.PrinterIndex. Supported from TWAIN 2.3.
    PrinterIndexStep4172Step size when incrementing DeviceCapabilityId.PrinterIndex for each document. Supported from TWAIN 2.3.
    PrinterIndexTrigger4173Kinds of documents that cause DeviceCapabilityId.PrinterIndex to increment. Supported from TWAIN 2.3.
    PrinterMode4137Specifies the appropriate current DeviceCapability.Printer device mode.
    PrinterString4138Specifies the string(s) that are to be used in the string component when the current DeviceCapability.Printer device is enabled.
    PrinterStringPreview4174A sample string representing the currently selected printing options. Supported from TWAIN 2.3.
    PrinterSuffix4139Specifies the string that shall be used as the current DeviceCapability.Printer device's suffix.
    PrinterVerticalOffset4165Y-Offset for current Printer device. Supported from TWAIN 2.2.
    ReacquireAllowed4144Indicates 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.
    RewindPage4106If 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.
    Segmented4149Describes the segmentation setting for captured images. Supported from TWAIN 1.91.
    SerialNumber4132A string containing the serial number of the currently selected device in the Source. Multiple devices may all report the same serial number.
    SupportedCaps4101Returns 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.
    SupportedCapsExt4108Returns a list of all the capabilities for which the Source will answer inquiries.
    SupportedCapsSegmentUnique4157For 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.
    SupportedDats4158Returns a list of all the Data Argument Types (DAT_xxx) for which the Source will answer inquiries.
    Supported from TWAIN 2.2.
    ThumbnailsEnabled4113Allows an application to request the delivery of thumbnail representations for the set of images that are to be delivered.
    TimeBeforeFirstCapture4123For 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.
    TimeBetweenCaptures4124For automatic capture, this value selects the milliseconds to wait between pictures taken, or images scanned.
    TimeDate4100The date and time the image was acquired.
    UIControllable4110If 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.
    XferCount1The application is willing to accept this number of images.
    Inheritance Hierarchy

    System.Object
       System.ValueType
          System.Enum
             Vintasoft.Twain.DeviceCapabilityId

    Requirements

    Target Platforms: Windows 8, Windows 7, Windows Vista, Windows XP, Windows Server 2012, Windows Server 2008, Windows Server 2003

    See Also