Thanks for Downloading Dynamic Web TWAIN 30-Day Trial!

Your download will start shortly. If your download does not begin, click here to retry.

Some old APIs are deprecated, check out Deprecated Features and APIs

API List

Desktop Service
Android Service

Global

Methods

`CreateDWTObject()`	`CreateDWTobjectEx()`	`DeleteDWTObject()`	`GetWebTwain()`
`Load()`	`RegisterEvent()`	`Unload()`

Properties

`Autoload`	`Containers`	`CustomizableDisplayInfo`	`DeviceFriendlyName`
`Host`	`IfAddMD5InUploadHeader`	`IfConfineMaskWithinTheViewer`	`IfUseActiveXForIE10Plus`
`JSVersion`	`ProductKey`	`ResourcesPath`	`ServiceInstallerLocation`
`UseDefaultViewer`	`IfCheckCORS`

Events

OnWebTwainReady

OnWebTwainError

OnWebTwainPostExecute

OnWebTwainPreExecute

Buffer

Methods

`ClearImageTags()`	`RenameTag()`	`RemoveTag()`	`GetTagList()`
`FilterImagesByTag()`	`ClearFilter()`	`SetDefaultTag()`	`TagImages()`
`GetImageBitDepth()`	`GetImageSize()`	`GetImageSizeWithSpecifiedType()`	`GetSelectedImagesSize()`
`GetImageHeight()`	`GetImageWidth()`	`GetImagePartURL()`	`GetImageURL()`
`GetImageXResolution()`	`GetImageYResolution()`	`GetSkewAngle()`	`GetSkewAngleEx()`
`ImageIDToIndex()`	`IndexToImageID()`	`IsBlankImage()`	`IsBlankImageExpress()`
`SelectAllImages()`	`MoveImage()`	`SwitchImage()`	`RemoveImage()`
`RemoveAllImages()`	`RemoveAllSelectedImages()`	`SelectImages()`	`GetTagListByIndex()`
`CreateDocument()`	`OpenDocument()`	`GetCurrentDocumentName()`	`RenameDocument()`
`RemoveDocument()`	`GetDocumentInfoList()`	`IsBlankImageAsync()`	`CopyToDocumentAsync()`
`MoveToDocumentAsync()`	`updateImage()`

Properties

`BlankImageCurrentStdDev`	`BlankImageMaxStdDev`	`BlankImageThreshold`	`BufferMemoryLimit`
`CurrentImageIndexInBuffer`	`HowManyImagesInBuffer`	`IfAllowLocalCache`	`SelectedImagesIndices`
`MaxImagesInBuffer`

Events

`OnBufferChanged`	`OnBitmapChanged`	`OnIndexChangeDragDropDone`	`OnTopImageInTheViewChanged`
`OnDiskExceedLimit`

Edit

Methods

`Crop()`	`CropToClipboard()`	`CutFrameToClipboard()`	`CutToClipboard()`
`CopyToClipboard()`	`Erase()`	`Flip()`	`Mirror()`
`Rotate()`	`RotateEx()`	`RotateLeft()`	`RotateRight()`
`ChangeBitDepth()`	`SetDPI()`	`ConvertToBW()`	`ConvertToGrayScale()`
`ChangeImageSize()`	`Invert()`	`SetImageWidth()`	`ChangeBrightnessAsync()`
`ChangeContrastAsnyc()`

Properties

BackgroundFillColor

Scan

Methods

`GetSourceNameItems()`	`GetSourceNames()`	`GetSourceNamesAsync()`	`SelectSource()`
`SelectSourceAsync()`	`SelectSourceByIndex()`	`SelectSourceByIndexAsync()`	`SetOpenSourceTimeout()`
`OpenSource()`	`OpenSourceAsync()`	`EnableSourceUI()`	`EnableSource()`
`AcquireImage()`	`startScan()`	`DisableSource()`	`CloseSource()`
`CloseSourceAsync()`	`CloseWorkingProcess()`	`GetDevicesAsync()`	`SelectDeviceAsync()`
`AcquireImageAsync()`

Properties

`CurrentSourceName`	`IfDisableSourceAfterAcquire`	`IfDuplexEnabled`	`IfFeederEnabled`
`PageSize`	`PixelType`	`Resolution`	`SourceCount`

Events

`OnPostAllTransfers`	`OnPostTransfer`	`OnPostTransferAsync`
`OnPreAllTransfers`	`OnPreTransfer`

The following APIs are compatible with TWAIN and ICA

Methods

getCapabilities()

setCapabilities()

The following APIs are compatible with TWAIN (mostly Windows, but could also be macOS)

Methods

`OpenSourceManager()`	`OpenSourceManagerAsync()`	`CloseSourceManager()`	`CloseSourceManagerAsync()`
`GetCustomDSData()`	`GetCustomDSDataEx()`	`CancelAllPendingTransfers()`	`FeedPage()`
`ResetImageLayout()`	`RewindPage()`	`SetCustomDSData()`	`SetCustomDSDataEx()`
`SetFileXferInfo()`	`SetImageLayout()`

Properties

`BitDepth`	`Brightness`	`Contrast`	`DataSourceStatus`
`DefaultSourceName`	`Duplex`	`IfAutoBright`	`IfAutoDiscardBlankpages`
`IfAutoFeed`	`IfAutomaticBorderDetection`	`IfAutomaticDeskew`	`IfAutoScan`
`IfFeederLoaded`	`IfPaperDetectable`	`IfShowIndicator`	`IfShowUI`
`IfUIControllable`	`IfUseTwainDSM`	`ImageCaptureDriverType`	`ImageLayoutDocumentNumber`
`ImageLayoutFrameBottom`	`ImageLayoutFrameLeft`	`ImageLayoutFrameNumber`	`ImageLayoutFrameRight`
`ImageLayoutFrameTop`	`ImageLayoutPageNumber`	`ImagePixelType`	`MagData`
`MagType`	`PendingXfers`	`PixelFlavor`	`TransferMode`
`Unit`	`XferCount`	`IfAppendImage`

Events

OnSourceUIClose

Input/Output

Input

Methods

`LoadImage()`	`LoadImageEx()`	`LoadImageFromBase64Binary()`	`LoadImageFromBinary()`
`LoadDibFromClipboard()`	`FTPDownload()`	`FTPDownloadEx()`	`HTTPDownload()`
`HTTPDownloadEx()`	`HTTPDownloadThroughPost()`	`loadFromLocalStorage()`

Output

Methods

`ConvertToBase64()`	`ConvertToBlob()`	`FTPUpload()`
`FTPUploadEx()`	`FTPUploadAllAsMultiPageTIFF()`	`FTPUploadAllAsPDF()`
`FTPUploadAsMultiPagePDF()`	`FTPUploadAsMultiPageTIFF()`	`HTTPUpload()`
`HTTPUploadThroughPutEx()`	`HTTPUploadThroughPost()`	`HTTPUploadThroughPostEx()`
`HTTPUploadAllThroughPostAsMultiPageTIFF()`	`HTTPUploadAllThroughPostAsPDF()`	`HTTPUploadThroughPostAsMultiPagePDF()`
`HTTPUploadThroughPostAsMultiPageTIFF()`	`OutputSelectedAreaAsync()`	`SaveAsBMP()`
`SaveAsJPEG()`	`SaveAsPDF()`	`SaveAsPNG()`
`SaveAsTIFF()`	`SaveSelectedImagesAsMultiPagePDF()`	`SaveSelectedImagesAsMultiPageTIFF()`
`SaveAllAsMultiPageTIFF()`	`SaveAllAsPDF()`	`httpUploadBlob()`
`saveBlob()`	`saveToLocalStorage()`

Others

Methods

`ClearTiffCustomTag()`	`SetTiffCustomTag()`	`ClearAllHTTPFormField()`	`SetHTTPFormField()`
`SetHTTPHeader()`	`SetUploadSegment()`	`ShowFileDialog()`	`Print()`
`PrintEx()`	`createLocalStorage()`	`localStorageExist()`	`removeLocalStorage()`

Properties

`FTPPassword`	`FTPPort`	`FTPUserName`	`IfPASVMode`
`HttpFieldNameOfUploadedImage`	`HTTPPort`	`IfSSL`	`HTTPPostResponseString`
`IfShowFileDialog`	`IfShowCancelDialogWhenImageTransfer`	`IfShowProgressBar`	`JPEGQuality`
`IfTiffMultiPage`	`TIFFCompressionType`	`MaxUploadImageSize`	`IfSortBySelectionOrder`

Events

OnGetFilePath

OnPostLoad

OnInternetTransferPercentage

Util

Methods

isUsingActiveX()

RegisterEvent()

UnregisterEvent()

GenerateURLForUploadData()

Properties

`ErrorCode`	`ErrorString`	`LogLevel`	`Manufacturer`
`ProductFamily`	`ProductName`	`VersionInfo`

Viewer

Methods

`bind()`	`clearSelectedAreas()`	`createCustomElement()`	`createImageEditor()`
`createThumbnailViewer()`	`first()`	`fitWindow()`	`gotoPage()`
`hide()`	`last()`	`next()`	`off()`
`on()`	`previous()`	`render()`	`setButtonClass()`
`setSelectedAreas()`	`setViewMode()`	`show()`	`unbind()`
`createDocumentEditor()`	`updateCheckboxStyle()`	`updatePageNumberStyle()`	`updateSelectionBoxStyle()`

Properties

`acceptDrop`	`allowSlide`	`allowPageDragging`	`background`
`border`	`cursor`	`height`	`idPostfix`
`ifAutoScroll`	`innerBorder`	`pageMargin`	`selectedAreaBorderColor`
`selectedPageBackground`	`selectedPageBorder`	`selectionRectAspectRatio`	`singlePageMode`
`width`	`zoom`	`autoChangeIndex`	`selectionMode`
`zoomOrigin`

Events

`click`	`contextmenu`	`dblclick`	`mousemove`
`mousedown`	`mouseup`	`mouseout`	`mouseover`
`keydown`	`keyup`	`pageAreaSelected`	`pageAreaUnselected`
`pageRendered`	`resize`

Addon

BarcodeReader

Methods

`decode()`	`getRuntimeSettings()`	`updateRuntimeSettings()`
`resetRuntimeSettings()`	`initRuntimeSettingsWithString()`

PDF

Methods

`GetConvertMode()`	`IsModuleInstalled()`	`IsTextBasedPDF()`	`SetConvertMode()`
`SetPassword()`	`SetResolution()`	`Write.Setup()`	`GetReaderOptions()`
`SetReaderOptions()`

Webcam

Methods

`CaptureImage()`	`CloseSource()`	`GetCameraControlPropertySetting()`	`GetCameraControlPropertyMoreSetting()`
`GetVideoPropertySetting()`	`GetVideoPropertyMoreSetting()`	`SetCameraControlPropertySetting()`	`SetVideoPropertySetting()`
`GetFrameRate()`	`SetFrameRate()`	`GetMediaType()`	`SetMediaType()`
`GetResolution()`	`SetResolution()`	`GetFramePartURL()`	`GetFrameURL()`
`GetSourceList()`	`SelectSource()`	`PauseVideo()`	`PlayVideo()`
`SetVideoRotateMode()`	`StopVideo()`

Dynamsoft.FileUploader

Methods

`Init()`	`CreateJob()`	`Run()`	`Cancel()`
`CancelAllUpload()`

The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition.

Global

Methods

`CreateDWTObject()`	`CreateDWTobjectEx()`	`DeleteDWTObject()`	`GetWebTwain()`
`Load()`	`RegisterEvent()`	`Unload()`

Properties

`Autoload`	`Containers`	`CustomizableDisplayInfo`	`DeviceFriendlyName`
`Host`	`IfAddMD5InUploadHeader`	`IfConfineMaskWithinTheViewer`	`IfUseActiveXForIE10Plus`
`JSVersion`	`ProductKey`	`ResourcesPath`	`ServiceInstallerLocation`
`UseDefaultViewer`	`IfCheckCORS`

Events

OnWebTwainReady

OnWebTwainError

OnWebTwainPostExecute

OnWebTwainPreExecute

Buffer

Methods

`ClearImageTags()`	`RenameTag()`	`RemoveTag()`	`GetTagList()`
`FilterImagesByTag()`	`ClearFilter()`	`SetDefaultTag()`	`TagImages()`
`GetImageBitDepth()`	`GetImageSize()`	`GetImageSizeWithSpecifiedType()`	`GetSelectedImagesSize()`
`GetImageHeight()`	`GetImageWidth()`	`GetImagePartURL()`	`GetImageURL()`
`GetImageXResolution()`	`GetImageYResolution()`	`GetSkewAngle()`	`GetSkewAngleEx()`
`ImageIDToIndex()`	`IndexToImageID()`	`IsBlankImage()`	`IsBlankImageExpress()`
`SelectAllImages()`	`MoveImage()`	`SwitchImage()`	`RemoveImage()`
`RemoveAllImages()`	`RemoveAllSelectedImages()`	`SelectImages()`	`GetTagListByIndex()`
`CreateDocument()`	`OpenDocument()`	`GetCurrentDocumentName()`	`RenameDocument()`
`RemoveDocument()`	`GetDocumentInfoList()`	`CopyToDocumentAsync()`	`MoveToDocumentAsync()`
`updateImage()`

Properties

`BlankImageCurrentStdDev`	`BlankImageMaxStdDev`	`BlankImageThreshold`	`BufferMemoryLimit`
`CurrentImageIndexInBuffer`	`HowManyImagesInBuffer`	`IfAllowLocalCache`	`SelectedImagesIndices`
`MaxImagesInBuffer`

Events

`OnBufferChanged`	`OnBitmapChanged`	`OnIndexChangeDragDropDone`	`OnTopImageInTheViewChanged`
`OnDiskExceedLimit`

Edit

Methods

`Crop()`	`CropToClipboard()`	`CutFrameToClipboard()`	`CutToClipboard()`
`CopyToClipboard()`	`Erase()`	`Flip()`	`Mirror()`
`Rotate()`	`RotateEx()`	`RotateLeft()`	`RotateRight()`
`ChangeBitDepth()`	`SetDPI()`	`ConvertToBW()`	`ConvertToGrayScale()`
`ChangeImageSize()`	`Invert()`	`SetImageWidth()`	`ChangeBrightnessAsync()`
`ChangeContrastAsnyc()`

Properties

BackgroundFillColor

Scan

Methods

`SelectSourceAsync()`	`CloseSourceAsync()`	`GetDevicesAsync()`	`SelectDeviceAsync()`
`AcquireImageAsync()`	`getCapabilities()`	`setCapabilities()`

Events

OnPostTransferAsync

Input/Output

Input

Methods

`LoadImageEx()`	`LoadImageFromBase64Binary()`	`LoadImageFromBinary()`	`LoadDibFromClipboard()`
`HTTPDownload()`	`HTTPDownloadEx()`	`HTTPDownloadThroughPost()`	`loadFromLocalStorage()`

Output

Methods

`ConvertToBase64()`	`ConvertToBlob()`	`HTTPUpload()`
`HTTPUploadThroughPutEx()`	`HTTPUploadThroughPost()`	`HTTPUploadThroughPostEx()`
`HTTPUploadAllThroughPostAsMultiPageTIFF()`	`HTTPUploadAllThroughPostAsPDF()`	`HTTPUploadThroughPostAsMultiPagePDF()`
`HTTPUploadThroughPostAsMultiPageTIFF()`	`SaveAsBMP()`	`SaveAsJPEG()`
`SaveAsPDF()`	`SaveAsPNG()`	`SaveAsTIFF()`
`SaveSelectedImagesAsMultiPagePDF()`	`SaveSelectedImagesAsMultiPageTIFF()`	`SaveAllAsMultiPageTIFF()`
`SaveAllAsPDF()`	`ShareImages()`	`OutputSelectedAreaAsync()`
`httpUploadBlob()`	`saveToLocalStorage()`

Others

Methods

`ClearTiffCustomTag()`	`SetTiffCustomTag()`	`ClearAllHTTPFormField()`	`SetHTTPFormField()`
`SetHTTPHeader()`	`SetUploadSegment()`	`Print()`	`PrintEx()`
`createLocalStorage()`	`localStorageExist()`	`removeLocalStorage()`

Properties

`HttpFieldNameOfUploadedImage`	`HTTPPort`	`IfSSL`	`HTTPPostResponseString`
`IfShowCancelDialogWhenImageTransfer`	`IfShowProgressBar`	`JPEGQuality`	`IfTiffMultiPage`
`TIFFCompressionType`	`MaxUploadImageSize`

Events

OnPostLoad

OnInternetTransferPercentage

Util

Methods

isUsingActiveX()

RegisterEvent()

UnregisterEvent()

GenerateURLForUploadData()

Properties

`ErrorCode`	`ErrorString`	`LogLevel`	`Manufacturer`
`ProductFamily`	`ProductName`	`VersionInfo`

Viewer

Methods

`bind()`	`clearSelectedAreas()`	`createCustomElement()`	`createImageEditor()`
`createThumbnailViewer()`	`first()`	`fitWindow()`	`gotoPage()`
`hide()`	`last()`	`next()`	`off()`
`on()`	`previous()`	`render()`	`setButtonClass()`
`setSelectedAreas()`	`setViewMode()`	`show()`	`unbind()`
`createDocumentEditor()`	`updateCheckboxStyle()`	`updatePageNumberStyle()`	`updateSelectionBoxStyle()`

Properties

`acceptDrop`	`allowSlide`	`allowPageDragging`	`background`
`border`	`cursor`	`height`	`idPostfix`
`ifAutoScroll`	`innerBorder`	`pageMargin`	`selectedAreaBorderColor`
`selectedPageBackground`	`selectedPageBorder`	`selectionRectAspectRatio`	`singlePageMode`
`width`	`zoom`	`autoChangeIndex`	`selectionMode`
`zoomOrigin`

Events

`click`	`contextmenu`	`dblclick`	`mousemove`
`mousedown`	`mouseup`	`mouseout`	`mouseover`
`keydown`	`keyup`	`pageAreaSelected`	`pageAreaUnselected`
`pageRendered`	`resize`

Addon

PDF

Methods

`GetConvertMode()`	`IsModuleInstalled()`	`IsTextBasedPDF()`	`SetConvertMode()`
`SetPassword()`	`SetResolution()`	`Write.Setup()`	`GetReaderOptions()`
`SetReaderOptions()`