VintaSoft Twain .NET SDK 15.1: Documentation for Web developer
In This Topic
    Changes in version 12.0
    In This Topic

    Changes in JavaScript API (Vintasoft.Twain.js)

    New classes:

    public class Vintasoft.Twain.WebTwainGlobalSettingsJS Contains information about TWAIN global settings.
    public class Vintasoft.Twain.WebTwainCapabilityInfoJS Contains information about value of TWAIN device capability.
    public class Vintasoft.Twain.WebTwainCapabilitySupportedValuesJS Contains information about supported values of TWAIN device capability.
    public class Vintasoft.Twain.WebTwainImageLayoutJS Contains information about image layout of TWAIN device.
    public class Vintasoft.Twain.WebTwainRangeJS Contains information about range of values.
    public class Vintasoft.Twain.WebTwainDeviceAcquireModalResultJS Contains information about execution result of WebTwainDeviceJS.acquireModalSync() function.
    public class Vintasoft.Twain.WebAcquiredImageJS Represents an image acquired from TWAIN device.
    public class Vintasoft.Twain.WebAcquiredImageCollectionJS Represents a collection of instances of WebAcquiredImageJS class.
    public class Vintasoft.Twain.WebAcquiredImageIsBlankResultJS Contains information about execution result of WebAcquiredImageJS.isBlank() function.
    public class Vintasoft.Twain.WebHttpFormFieldInfoJS Contains information about HTTP form field.
    public class Vintasoft.Twain.WebHttpFormFileFieldInfoJS Contains information about HTTP form file field.


    Changed classes:

    Vintasoft.Twain.WebTwainDeviceManagerJS
    Added properties
    public string get_TwainServiceVersion { get ; } Gets version of TWAIN web service.
    Renamed properties
    public string get_TwainSessionID { get ; } public string get_TwainSessionId { get ; }
    Added methods
    public object get_DefaultDevice() Gets the default TWAIN device.
    public object get_Devices() Gets a list of TWAIN devices installed in the system.
    public object open(object) Synchronously opens TWAIN device manager.
    Changed methods
    public object close(object, object) public object close()
    Renamed methods
    public object open(object, object, object) public object openAsync(object, object, object)
    Removed methods
    public object getDefaultDevice() Use get_DefaultDevice property instead.
    public object getDevices() Use get_Devices property instead.
    public boolean isDevicesReceived() Use get_Devices property instead.
    public object requestDevices(object, object) Use get_Devices property instead.


    Vintasoft.Twain.WebTwainDeviceManagerInitSettingsJS
    Added properties
    public boolean get_Is32BitDevicesSupported { get ; } Gets a value indicating whether TWAIN device manager supports 32-bit devices.
    public boolean get_Is64BitDevicesSupported { get ; } Gets a value indicating whether TWAIN device manager supports 64-bit devices.
    public boolean set_Is32BitDevicesSupported { set ; } Sets a value indicating whether TWAIN device manager should support 32-bit devices.
    public boolean set_Is64BitDevicesSupported { set ; } Sets a value indicating whether TWAIN device manager should support 64-bit devices.
    Removed properties
    public string get_ApplicationProductName { get ; } This property is not used any more.
    public string set_ApplicationProductName { set ; } This property is not used any more.


    Vintasoft.Twain.WebTwainDeviceJS
    Added properties
    public boolean get_AutoBright { get ; } Gets a value indicating whether the brightness should be automatically detected.
    public boolean get_AutoScan { get ; } Gets a value indicating whether the device should capture the number of images indicated by the value of XferCount without waiting for the Application to request the image transfers.
    public number get_BitDepth { get ; } Gets bit depth of images for current scan session.
    public object get_BitDepthReductionMode { get ; } Gets bit depth reduction mode of images for current scan session.
    public number get_Brightness { get ; } Gets brightness of gray/palette/color images for current scan session.
    public number get_BufferedImageCount { get ; } Gets count of images in the device buffer.
    public number get_Contrast { get ; } Gets contrast of gray/palette/color images for current scan session.
    public object get_FileFormat { get ; } Gets file format for images when File transfer mode is used.
    public number get_FileJpegQuality { get ; } Gets the JPEG quality for acquired images saved as JPEG files when File transfer mode is used.
    public string get_Halftones { get ; } Gets halftones for bit depth reduction of images for current scan session.
    public object get_ImageCompression { get ; } Gets image compression for images when Memory or File transfer mode is used.
    public object get_ImageFilter { get ; } Gets image filter for current scan session.
    public boolean get_Is64Bit { get ; } Gets a value indicating whether device is 64-bit.
    public object get_JobControl { get ; } Gets a value that defines how the batch job must be processed.
    public boolean get_LampState { get ; } Gets a value indicating whether the lamp of device is on.
    public object get_LightPath { get ; } Gets the light path, which must be used for the image capturing.
    public object get_LightSource { get ; } Gets a value that defines general color characteristic of the light source for current scan session.
    public number get_MaxBatchBuffers { get ; } Gets number of images that the device can buffer when AutoScan is enabled.
    public object get_NoiseFilter { get ; } Gets the noise filter for current scan session.
    public boolean get_Online { get ; } Gets a value indicating whether the device is powered up and available.
    public object get_PageAutoSize { get ; } Gets the page size detection mode for current scan session.
    public object get_PageOrientation { get ; } Gets orientation of images for current scan session.
    public object get_PageSize { get ; } Gets page size for current scan session.
    public object get_PixelFlavor { get ; } Gets pixel flavor for current scan session.
    public object get_PixelType { get ; } Gets pixel type of images for current scan session.
    public number get_Threshold { get ; } Gets threshold of black-white images for current scan session.
    public object get_TransferMode { get ; } Gets transfer mode for current scan session.
    public object get_UnitOfMeasure { get ; } Gets unit of measure for current scan session.
    public number get_XferCount { get ; } Gets count of images application wants to receive from the device.
    public number get_XResolution { get ; } Gets X-axis resolution of images for current scan session.
    public number get_YResolution { get ; } Gets Y-axis resolution of images for current scan session.
    public boolean set_AutoBright { set ; } Sets a value indicating whether the brightness should be automatically detected.
    public boolean set_AutoScan { set ; } Sets a value indicating whether the device should capture the number of images indicated by the value of XferCount without waiting for the Application to request the image transfers.
    public number set_BitDepth { set ; } Sets bit depth of images for current scan session.
    public object set_BitDepthReductionMode { set ; } Sets bit depth reduction mode of images for current scan session.
    public number set_Brightness { set ; } Sets brightness of gray/palette/color images for current scan session.
    public object set_ClearBuffers { set ; } Sets a value that defines how device buffers must be cleared.
    public number set_Contrast { set ; } Sets contrast of gray/palette/color images for current scan session.
    public object set_FileFormat { set ; } Sets file format for images when File transfer mode is used.
    public number set_FileJpegQuality { set ; } Sets the JPEG quality for acquired images saved as JPEG files when File transfer mode is used.
    public string set_Halftones { set ; } Sets halftones for bit depth reduction of images for current scan session.
    public object set_ImageCompression { set ; } Sets image compression for images when Memory or File transfer mode is used.
    public object set_ImageFilter { set ; } Sets image filter for current scan session.
    public object set_JobControl { set ; } Sets a value that defines how the batch job must be processed.
    public boolean set_LampState { set ; } Sets a value indicating whether the lamp of device is on.
    public object set_LightPath { set ; } Sets the light path, which must be used for the image capturing.
    public object set_LightSource { set ; } Sets a value that defines general color characteristic of the light source for current scan session.
    public number set_MaxBatchBuffers { set ; } Sets number of images that the device can buffer when AutoScan is enabled.
    public object set_NoiseFilter { set ; } Sets the noise filter for current scan session.
    public object set_PageAutoSize { set ; } Sets the page size detection mode for current scan session.
    public object set_PageOrientation { set ; } Sets orientation of images for current scan session.
    public object set_PageSize { set ; } Sets page size for current scan session.
    public object set_PixelFlavor { set ; } Sets pixel flavor for current scan session.
    public object set_PixelType { set ; } Sets pixel type of images for current scan session.
    public number set_Threshold { set ; } Sets threshold of black-white images for current scan session.
    public object set_TransferMode { set ; } Sets transfer mode for current scan session.
    public object set_UnitOfMeasure { set ; } Sets unit of measure for current scan session.
    public number set_XferCount { set ; } Sets count of images application wants to receive from the device.
    public number set_XResolution { set ; } Sets X-axis resolution of images for current scan session.
    public number set_YResolution { set ; } Sets Y-axis resolution of images for current scan session.
    Added methods
    public object acquireModalAsync(boolean, object, object) Sends an asynchronous request for doing one step of synchronous image acquisition from TWAIN device.
    public object acquireModalSync(boolean) Does one step of synchronous image acquisition from TWAIN device.
    public object getSupportedBitDepths() Returns supported bit depths.
    public object getSupportedBrightnesValues() Returns supported brightness values.
    public object getSupportedContrastValues() Returns supported contrast values.
    public object getSupportedFileFormats() Returns supported file formats.
    public object getSupportedImageCompressions() Returns supported image compressions.
    public object getSupportedImageFilters() Returns supported image filters.
    public object getSupportedPageOrientations() Returns supported page orientations.
    public object getSupportedPageSizes() Returns supported page sizes.
    public object getSupportedPixelFlavors() Returns supported pixel flavors.
    public object getSupportedPixelTypes() Returns supported pixel types.
    public object getSupportedTransferModes() Returns supported transfer modes.
    public object getSupportedUnitOfMeasures() Returns supported units of measure.
    public object getSupportedXResolutions() Returns supported X-axis resolution for images.
    public object getSupportedYResolutions() Returns supported Y-axis resolution for images.
    public object setImageLayout(number, number, number, number) Sets the image layout rectangle of TWAIN device.
    Removed methods
    public object acquireModal(object, object) Use acquireModalAsync method instead.
    public object getAutoBright(object, object) Use get_AutoBright property instead.
    public object getAutoScan(object, object) Use get_AutoScan property instead.
    public object getBitDepth(object, object) Use get_BitDepth property instead.
    public object getBitDepthReductionMode(object, object) Use get_BitDepthReductionMode property instead.
    public object getBrightness(object, object) Use get_Brightness property instead.
    public object getBufferedImageCount(object, object) Use get_BufferedImageCount property instead.
    public object getContrast(object, object) Use get_Contrast property instead.
    public object getFileFormat(object, object) Use get_FileFormat property instead.
    public object getFileJpegQuality(object, object) Use get_FileJpegQuality property instead.
    public object getHalftones(object, object) Use get_Halftones property instead.
    public object getImageCompression(object, object) Use get_ImageCompression property instead.
    public object getImageFilter(object, object) Use get_ImageFilter property instead.
    public object getJobControl(object, object) Use get_JobControl property instead.
    public object getLampState(object, object) Use get_LampState property instead.
    public object getLightPath(object, object) Use get_LightPath property instead.
    public object getLightSource(object, object) Use get_LightSource property instead.
    public object getMaxBatchBuffers(object, object) Use get_MaxBatchBuffers property instead.
    public object getNoiseFilter(object, object) Use get_NoiseFilter property instead.
    public object getOnline(object, object) Use get_Online property instead.
    public object getPageAutoSize(object, object) Use get_PageAutoSize property instead.
    public object getPageOrientation(object, object) Use get_PageOrientation property instead.
    public object getPageSize(object, object) Use get_PageSize property instead.
    public object getPixelFlavor(object, object) Use get_PixelFlavor property instead.
    public object getPixelType(object, object) Use get_PixelType property instead.
    public object getThreshold(object, object) Use get_Threshold property instead.
    public object getTransferMode(object, object) Use get_TransferMode property instead.
    public object getUnitOfMeasure(object, object) Use get_UnitOfMeasure property instead.
    public object getXferCount(object, object) Use get_XferCount property instead.
    public object getXResolution(object, object) Use get_XResolution property instead.
    public object getYResolution(object, object) Use get_YResolution property instead.
    public object setAutoBright(boolean, object, object) Use set_AutoBright property instead.
    public object setAutoScan(boolean, object, object) Use set_AutoScan property instead.
    public object setBitDepth(number, object, object) Use set_BitDepth property instead.
    public object setBitDepthReductionMode(object, object, object) Use set_BitDepthReductionMode property instead.
    public object setBrightness(number, object, object) Use set_Brightness property instead.
    public object setClearBuffers(object, object, object) Use set_ClearBuffers property instead.
    public object setContrast(number, object, object) Use set_Contrast property instead.
    public object setFileFormat(object, object, object) Use set_FileFormat property instead.
    public object setFileJpegQuality(number, object, object) Use set_FileJpegQuality property instead.
    public object setHalftones(string, object, object) Use set_Halftones property instead.
    public object setImageCompression(object, object, object) Use set_ImageCompression property instead.
    public object setImageFilter(object, object, object) Use set_ImageFilter property instead.
    public object setImageLayout(object, object, object) Use set_ImageLayout property instead.
    public object setJobControl(object, object, object) Use set_JobControl property instead.
    public object setLampState(boolean, object, object) Use set_LampState property instead.
    public object setLightPath(object, object, object) Use set_LightPath property instead.
    public object setLightSource(object, object, object) Use set_LightSource property instead.
    public object setMaxBatchBuffers(number, object, object) Use set_MaxBatchBuffers property instead.
    public object setNoiseFilter(object, object, object) Use set_NoiseFilter property instead.
    public object setPageAutoSize(object, object, object) Use set_PageAutoSize property instead.
    public object setPageOrientation(object, object, object) Use set_PageOrientation property instead.
    public object setPageSize(object, object, object) Use set_PageSize property instead.
    public object setPixelFlavor(object, object, object) Use set_PixelFlavor property instead.
    public object setPixelType(object, object, object) Use set_PixelType property instead.
    public object setThreshold(number, object, object) Use set_Threshold property instead.
    public object setTransferMode(object, object, object) Use set_TransferMode property instead.
    public object setUnitOfMeasure(object, object, object) Use set_UnitOfMeasure property instead.
    public object setXferCount(number, object, object) Use set_XferCount property instead.
    public object setXResolution(number, object, object) Use set_XResolution property instead.
    public object setYResolution(number, object, object) Use set_YResolution property instead.
    Changed methods
    public object cancelTransfer(object, object) public object cancelTransfer()
    public object close(object, object) public object close()
    public object getCapabilities(object, object, object, object) public object getCapabilities(object, object)
    public object getCapability(object, object, object, object) public object getCapability(object, object)
    public object getDefaultImageLayout(object, object) public object getDefaultImageLayout()
    public object getImageLayout(object, object) public object getImageLayout()
    public object getSupportedCapabilities(object, object, object) public object getSupportedCapabilities(object)
    public object open(boolean, object, object) public object open(boolean)
    public object resetImageLayout(object, object) public object resetImageLayout()
    public object setCapability(object, string, object, object) public object setCapability(object, string)


    Vintasoft.Twain.WebTwainDeviceDocumentFeederJS
    Added properties
    public boolean get_AutoFeed { get ; } Gets a value that indicates whether the auto feed feature is enabled.
    public boolean set_AutoFeed { set ; } Sets a value that indicates whether the auto feed feature is enabled.
    public boolean get_DuplexEnabled { get ; } Gets a value that indicates whether the duplex scanning is enabled.
    public boolean set_DuplexEnabled { set ; } Sets a value that indicates whether the duplex scanning is enabled.
    public object get_DuplexMode { get ; } Gets the duplex mode supported by device.
    public boolean get_Enabled { get ; } Gets a value that indicates whether the document feeder is enabled.
    public boolean set_Enabled { set ; } Sets a value that indicates whether the document feeder is enabled.
    public boolean get_Loaded { get ; } Gets a value that indicates whether the document feeder is loaded.
    public boolean get_PaperDetectable { get ; } Gets a value that indicates whether the document feeder can detect paper.
    Removed methods
    public object getAutoFeed(object, object) Use get_AutoFeed property instead.
    public object getDuplexEnabled(object, object) Use get_DuplexEnabled property instead.
    public object getDuplexMode(object, object) Use get_DuplexMode property instead.
    public object getEnabled(object, object) Use get_Enabled property instead.
    public object getLoaded(object, object) Use get_Loaded property instead.
    public object getPaperDetectable(object, object) Use get_PaperDetectable property instead.
    public object setAutoFeed(boolean, object, object) Use set_AutoFeed property instead.
    public object setDuplexEnabled(boolean, object, object) Use set_DuplexEnabled property instead.
    public object setEnabled(boolean, object, object) Use set_Enabled property instead.
    Changed methods
    public object clearPage(object, object) public object clearPage()
    public object feedPage(object, object) public object feedPage()
    public object rewindPage(object, object) public object rewindPage()




    Support of Vintasoft.Twain.Web.Services assembly is ended

    Support of Vintasoft.Twain.Web.Services assembly (Vintasoft.Twain.Web.Services.dll) is ended. If you still use the assembly, please contact our support team.
    Use VintaSoft Web TWAIN service instead of Vintasoft.Twain.Web.Services assembly.




    Support of Vintasoft.Twain.Web.WcfServices assembly is ended

    Support of Vintasoft.Twain.Web.WcfServices assembly (Vintasoft.Twain.Web.WcfServices.dll) is ended. If you still use the assembly, please contact our support team.
    Use VintaSoft Web TWAIN service instead of Vintasoft.Twain.Web.WcfServices assembly.




    Support of Vintasoft.Twain.Web.ApiControllers assembly is ended

    Support of Vintasoft.Twain.Web.ApiControllers assembly (Vintasoft.Twain.Web.ApiControllers.dll) is ended. If you still use the assembly, please contact our support team.
    Use VintaSoft Web TWAIN service instead of Vintasoft.Twain.Web.ApiControllers assembly.




    Support of Vintasoft.Twain.Web.Api2Controllers assembly is ended

    Support of Vintasoft.Twain.Web.Api2Controllers assembly (Vintasoft.Twain.Web.Api2Controllers.dll) is ended. If you still use the assembly, please contact our support team.
    Use VintaSoft Web TWAIN service instead of Vintasoft.Twain.Web.Api2Controller assembly.




    Support of Vintasoft.Twain.AspNetCore.ApiControllers assembly is ended

    Support of Vintasoft.Twain.AspNetCore.ApiControllers.dll assembly (Vintasoft.Twain.AspNetCore.ApiControllers.dll) is ended. If you still use the assembly, please contact our support team.
    Use VintaSoft Web TWAIN service instead of Vintasoft.Twain.AspNetCore.ApiControllers assembly.