VintaSoftTwain Object Members

In This Topic

Public Methods

AcquiredImages_ChangeBrightness	Changes the brightness of the image.
AcquiredImages_ChangeContrast	Changes the contrast of the image.
AcquiredImages_Clear	Clears acquired image collection and deletes all acquired images.
AcquiredImages_Crop	Crops specified region of an image.
AcquiredImages_Delete	Deletes acquired image.
AcquiredImages_Deskew	Deskew an image, i.e. detects correct position of image.
AcquiredImages_Despeckle	Removes noise from image.
AcquiredImages_DetectBorder	Detects and removes border around the image.
AcquiredImages_GetImage	Returns acquired image as Picture object.
AcquiredImages_GetImageAsBase64String	Returns acquired image as Base64 string.
AcquiredImages_GetImageAsByteArray	Returns acquired image as byte array.
AcquiredImages_GetImageAsDIB	Returns acquired image as DIB object.
AcquiredImages_GetImageAsHBitmap	Returns acquired image as HBitmap object.
AcquiredImages_GetImageAsHDIB	Returns acquired image as HDIB object.
AcquiredImages_GetImageBitDepth	Returns bits count in acquired image.
AcquiredImages_GetImageHeight	Returns height of acquired image.
AcquiredImages_GetImageThumbnailAsBase64String	Returns thumbnail of acquired image as Base64 string.
AcquiredImages_GetImageTileAsBase64String	Returns tile of acquired image as Base64 string.
AcquiredImages_GetImageWidth	Returns width of acquired image.
AcquiredImages_GetImageXRes	Returns horizontal resolution of acquired image.
AcquiredImages_GetImageYRes	Returns vertical resolution of acquired image.
AcquiredImages_InvertImage	Inverts the image.
AcquiredImages_IsBlank	Determines that this image is a blank image.
AcquiredImages_ResizeCanvas	Changes size of image canvas.
AcquiredImages_Rotate	Rotates this image to specified angle.
AcquiredImages_Save	Saves acquired image to a file.
AcquiredImages_Swap	Swaps 2 acquired images in acquired image collection.
ConvertArrayToString	Converts array to a string.
Device_AcquireImage	Acquires images from the device asynchronously.
Device_AcquireImageModal	Acquires images from the device synchronously.
Device_Camera_GetName	Gets name of device camera.
Device_Camera_GetType	Gets type of device camera.
Device_Cameras_DisableSelectedCamera	Disables the selected camera.
Device_Cameras_EnableSelectedCamera	Enables the selected camera.
Device_CancelImageTransfer	Sends the cancel current transfer command to the device (transfer will not be canceled right after execution of this method).
Device_Cap_Get	Returns current value of device capability.
Device_Cap_GetUsageMode	Returns usage mode of device capability.
Device_Cap_IsSupported	Gets a value indicating whether device capability is supported.
Device_Cap_Set	Sets device capability.
Device_Caps_Deserialize	Deserializes (loads) current values of capabilities from the stream.
Device_Caps_Serialize	Serializes (saves) information about current values of capabilites to the stream.
Device_ClearBuffers	Clears the device buffers according to the specified mode.
Device_Close	Closes the device.
Device_Disable	Disables the device.
Device_Enable	Enables the device.
Device_Feeder_Stop	Stops the automatic document feeder if possible.
Device_GetImageLayout	Returns an image layout for current scan session.
Device_GetImageLayoutAsString	Returns string that defines image layout for current scan session.
Device_GetSettings	Returns the current device settings as string.
Device_GetSupportedAsyncEvents	Returns an array of asynchronous events supported by device.
Device_GetSupportedBitDepths	Returns an array of bit depths supported by device.
Device_GetSupportedImageCompressions	Returns an array of image compressions supported by device in File transfer mode.
Device_GetSupportedImageFileFormats	Returns an array of supported file formats for images acquired in File transfer mode.
Device_GetSupportedPageSizes	Returns an array of page sizes supported by device.
Device_GetSupportedPixelTypes	Returns an array of pixel types supported by device.
Device_GetSupportedResolutions	Returns an array of resolutions supported by device.
Device_GetSupportedTransferModes	Returns an array of transfer modes supported by device.
Device_GetSupportedUnitsOfMeasure	Returns an array of units of measure supported by device.
Device_Info_GetDriverVersion	Returns version of the device driver.
Device_Info_GetManufacturer	Returns the device manufacturer name.
Device_Info_GetProductFamily	Returns the device product family.
Device_Info_GetProductName	Returns the device product name.
Device_Info_GetTwainVersion	Returns version of TWAIN protocol with which device driver is compatible.
Device_Info_IsTwain2Compatible	Determines that device is TWAIN 2.0 compatible.
Device_Info_IsWia	Determines that device driver is WIA driver.
Device_Open	Opens the device.
Device_SetImageLayout	Sets an image layout for current scan session.
Device_SetSettings	Loads device settings from string.
Device_ShowSetupDialog	Displays the device setup dialog if device supports setup dialog.
DeviceManager_Close	Closes the TWAIN device manager.
DeviceManager_FindDevice	Finds the device by device's name.
DeviceManager_Open	Opens the TWAIN device manager.
DeviceManager_ShowDefaultDeviceSelectionDialog	Displays the default device selection dialog so the user can change the default device.
DisableDebugging	Disables the debugging.
EnableDebugging	Enables the debuging.
FtpUpload_AddFile	Adds an acquired image, as a file, to FTP request.
FtpUpload_AddImageToExistingFile	Adds an acquired image to a multipage file in FTP request.
FtpUpload_Cancel	Cancels current image uploading process to FTP server.
FtpUpload_ClearAllFiles	Removes all files from FTP request.
FtpUpload_PostData	Uploads acquired image to FTP server.
FtpUpload_SetProxyServerParams	Sets parameters that should be used for connecting to FTP proxy server.
FtpUpload_SetServerAdvancedParams	Sets advanced parameters that should be used for connecting to FTP server.
FtpUpload_SetServerParams	Sets parameters that should be used for connecting to FTP server.
GetPathToTempDir	Returns path to Windows temporary directory.
HttpUpload_AddFileField	Adds an acquired image, as an image file, to a HTTP form.
HttpUpload_AddImageToExistingFileField	Adds an acquired image to a multipage file in HTTP form.
HttpUpload_AddTextField	Sets a text field of HTTP form.
HttpUpload_Cancel	Cancels current image uploading process to HTTP server.
HttpUpload_ClearAllFileFields	Clears all file fields of HTTP form.
HttpUpload_ClearAllTextFields	Clears all text fields of HTTP form.
HttpUpload_PostData	Uploads acquired image to HTTP server.
HttpUpload_SetCookie	Adds cookie to HTTP header of image uploading session.
HttpUpload_SetProxyServerParams	Sets parameters that should be used for connecting to HTTP proxy server.
HttpUpload_SetServerParams	Sets parameters that should be used for connecting to HTTP server.
Register	Registers ActiveX.

Public Properties

AcquiredImages_Count	Gets image count in acquired image collection.
DEBUGLEVEL	Get or sets a level of debug information.
Device_AsyncEvents	Gets an array with asynchronous events which the application wants the device to report.
Device_Cameras_GetCount	Gets count of device cameras.
Device_Cameras_SelectedCamera	Gets or sets the selected camera.
Device_Cap_DefaultValue	Gets the default value of device capability.
Device_Cap_FrameItems	Gets a string array that represents Frame values of device capability.
Device_Cap_FrameValue	Gets or sets Frame value of device capability.
Device_Cap_Id	Gets or sets device capability ID.
Device_Cap_Items	Gets or sets an array of float values that represents numeric values of device capability.
Device_Cap_Items_Count	Gets the number of value items of device capability.
Device_Cap_MaxValue	Gets the maximum value of device capability.
Device_Cap_MinValue	Gets the minumum value of device capability.
Device_Cap_Name	Gets or sets device capability name.
Device_Cap_StepSize	Gets the step size for range value of device capability.
Device_Cap_StringItems	Gets a string array that represents string values of device capability.
Device_Cap_StringValue	Gets or sets string value of device capability.
Device_Cap_Value	Gets or sets numeric value of device capability.
Device_Cap_ValueContainerType	Gets or sets type of container that is used for storing device capability value.
Device_Cap_ValueType	Gets value type of device capability.
Device_Caps_Get	Gets a numeric array that represents identifiers of capabilities supported by device.
Device_Caps_GetCount	Gets count of capabilities supported by device.
Device_DisableAfterAcquire	Gets or sets a value indicating whether device must be disabled after acquisition of images.
Device_EndOfJob	Gets a value indicating whether the end of job is reached.
Device_Feeder_AutoFeed	Gets or sets a value indicating whether the auto feed feature of document feeder is enabled.
Device_Feeder_DuplexEnabled	Gets or sets a value indicating whether the duplex feature of document feeder is enabled.
Device_Feeder_DuplexMode	Gets the duplex mode supported by the device.
Device_Feeder_Enabled	Gets or sets a value indicating whether document feeder is enabled.
Device_Feeder_Loaded	Gets a value indicating whether documents are loaded in the document feeder.
Device_Feeder_PaperDetectable	Gets a value indicating whether device can detect paper in the document feeder.
Device_Feeder_Present	Gets a value indicating whether device has automatic document feeder.
Device_FileFormat	Gets or sets file format for image acquired in File transfer mode.
Device_FileJpegQuality	Gets or sets the JPEG quality for image acquired in Memory or File transfer mode.
Device_FileName	Gets or sets a file path where image acquired in File transfer mode will be saved.
Device_FlatbedPresent	Gets a value indicating whether device has flatbed.
Device_ImageAutoBright	Gets a value indicating whether brightness should be detected automatically.
Device_ImageBitDepth	Gets or sets the bit depth of images for current scan session.
Device_ImageBrightness	Gets or sets the brightness of gray/palette/color images for current scan session.
Device_ImageBrightnessMaxValue	Gets maximum value of brightness.
Device_ImageBrightnessMinValue	Gets minimum value of brightness.
Device_ImageCompression	Gets or sets image compression for image acquired in Memory or File transfer mode.
Device_ImageContrast	Gets or sets the contrast of gray/palette/color images for current scan session.
Device_ImageContrastMaxValue	Gets maximum value of contrast.
Device_ImageContrastMinValue	Gets minimum value of contrast.
Device_ImagePixelFlavor	Gets or sets the value of pixel flavor for current scan session.
Device_ImagePixelType	Gets or sets the pixel type of images for current scan session.
Device_ImageResolution	Gets or sets the resolution of images for current scan session.
Device_IsAsyncEventsSupported	Gets a value indicating whether the device supports asynchronous events.
Device_JobControl	Gets or sets a code that defines how to work with batch job separators.
Device_LightPath	Gets or sets a value indicating whether the image must be captured transmissively or reflectively.
Device_ModalUI	Gets or sets a value indicating whether the User Interface of device must be shown in modal state.
Device_Online	Gets a value indicating whether device is online.
Device_PageSize	Gets or sets the page size for current scan session.
Device_ShowIndicators	Gets or sets a value indicating whether progress indicator of scan process must be shown.
Device_ShowUI	Gets or sets a value indicating whether the User Interface of device must be shown.
Device_State	Gets the state of device.
Device_TransferMode	Gets or sets the transfer mode of device.
Device_UnitOfMeasure	Gets or sets the unit of measure for current scan session.
Device_XferCount	Specifies how many images application wants to receive from the device.
DeviceManager_ApplicationProductName	Gets or sets the name of application which uses ActiveX.
DeviceManager_Country	Gets or sets the country for TWAIN device manager.
DeviceManager_DefaultDeviceIndex	Gets index of default TWAIN device.
DeviceManager_DeviceCount	Gets count of available TWAIN devices.
DeviceManager_DllPath	Gets or sets path to the TWAIN Data Source Manager.
DeviceManager_IsAvailable	Gets a value indicating whether TWAIN is installed in the system.
DeviceManager_IsTwain2Compatible	Gets or sets a value indicating whether TWAIN 2.x Data Source Manager must be used.
DeviceManager_Language	Gets or sets the language for TWAIN device manager.
DeviceManager_ParentWindowHandle	Gets or sets handle of parent window.
DeviceManager_SelectedDeviceIndex	Gets or sets index of device selected in device manager.
DeviceManager_State	Gets the state of the TWAIN device manager.
Error	Gets a value that indicates whether the error occured during last operation.
errorString	Gets a string that describes error occured during last operation.
FtpUpload_BytesTotal	Gets length, in bytes, of data which will be uploaded to FTP server.
FtpUpload_BytesUploaded	Gets length, in bytes, of data already uploaded to FTP server.
FtpUpload_ErrorCode	Gets a code that defines error occured during image uploading to FTP server.
FtpUpload_ErrorString	Gets a string that describes error occured during image uploading to FTP server.
FtpUpload_Status	Gets a code that defines state of image uploading process to FTP server.
FtpUpload_StatusString	Gets a string that describes state of image uploading process to FTP server.
HttpUpload_BytesTotal	Gets length, in bytes, of data which will be uploaded to HTTP server.
HttpUpload_BytesUploaded	Gets length, in bytes, of data already uploaded to HTTP server.
HttpUpload_ErrorCode	Gets a code that defines error occured during image uploading to HTTP server.
HttpUpload_ErrorString	Gets a string that describes error occured during image uploading to HTTP server.
HttpUpload_ResponseCode	Gets a code that defines response from HTTP server.
HttpUpload_ResponseString	Gets a string that describes response from HTTP server.
HttpUpload_Status	Gets a code that defines state of image uploading process to HTTP server.
HttpUpload_StatusString	Gets a string that describes state of image uploading process to HTTP server.
IsDebuggingEnabled	Gets a value indicating whether the debugging is enabled.
JpegEncoder_JpegColorSpace	Gets or sets image color space that JPEG encoder must use when acquired image is encoded.
JpegEncoder_JpegQuality	Gets or sets image quality that JPEG encoder must use when acquired image is encoded.
PdfEncoder_Compression	Gets or sets image compression that PDF encoder must use when acquired image is encoded.
PdfEncoder_DocumentAuthor	Gets or sets the name of the person who created PDF document.
PdfEncoder_DocumentCreationDate	Gets or sets the date and time when PDF document was created.
PdfEncoder_DocumentCreator	Gets or sets the application that created or modified PDF document.
PdfEncoder_DocumentKeywords	Gets or sets the keywords associated with PDF document.
PdfEncoder_DocumentModificationDate	Gets or sets the date and time when PDF document was modified.
PdfEncoder_DocumentProducer	Gets or sets the application that converted the document to PDF format.
PdfEncoder_DocumentSubject	Gets or sets the subject of PDF document.
PdfEncoder_DocumentTitle	Gets or sets the title of PDF document.
PdfEncoder_MultiPage	Gets or sets a value indicating whether PDF encoder must create multipage PDF document.
PdfEncoder_PdfACompatible	Gets or sets a value indicating whether PDF encoder must create PDF/A document.
PngEncoder_CompressionLevel	Gets or sets image compression level that PNG encoder must use when acquired image is encoded.
TiffEncoder_Compression	Gets or sets image compression that TIFF encoder must use when acquired image is encoded.
TiffEncoder_MultiPage	Gets or sets a value indicating whether TIFF encoder must create multipage TIFF file.
Version	Gets ActiveX version.

Events

AcquiredImagesImageProcessingProgress	Occurs when progress of image processing is changed.
DeviceAsyncEvent	Occurs when the asynchronous device event is occurs.
DeviceImageAcquired	Occurs when image is acquired from device.
DeviceImageAcquiring	Occurs when image acquisition starts.
DeviceImageAcquiringProgress	Occurs when image acquisition is in progress (only if Memory transfer mode is used).
DeviceManagerOpenedDeviceChanged	Occurs when the opened device is changed.
DeviceManagerOpenedDeviceChanging	Occurs before the opened device is changing.
DeviceScanCanceled	Occurs when scan process is canceled.
DeviceScanCompleted	Occurs when scan process is completed successfully.
DeviceScanFailed	Occurs when scan process is failed.
DeviceScanFinished	Occurs when Scan process is finished (scan session is completed; scan is canceled; scan is failed; user interface is closed).
DeviceUserInterfaceClosed	Occurs when the User Interface of device is closed.
FtpUploadCompleted	Occurs when image uploading process to FTP server is completed.
FtpUploadProgressChanged	Occurs when progress of image uploading process to FTP server is changed.
FtpUploadStatusChanged	Occurs when status of image uploading process to FTP server is changed.
HttpUploadCompleted	Occurs when image uploading process to HTTP server is completed.
HttpUploadProgressChanged	Occurs when progress of image uploading process to HTTP server is changed.
HttpUploadStatusChanged	Occurs when status of image uploading process to HTTP server is changed.