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

API List

Global

Dynamsoft.DWT	Dynamsoft.DWT.Enum

WebTwain

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()
CreateFile()	OpenFile()	GetCurrentFileName()	RemoveFile()
GetFileInfoList()

Properties

BlankImageCurrentStdDev	BlankImageMaxStdDev	BlankImageThreshold	BufferMemoryLimit
CurrentImageIndexInBuffer	HowManyImagesInBuffer	IfAllowLocalCache	SelectedImagesIndices
MaxImagesInBuffer

Events

OnBufferChanged	OnBitmapChanged	OnIndexChangeDragDropDone	OnTopImageInTheViewChanged

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()	GetDeviceType()
SelectSource()	SelectSourceAsync()	SelectSourceByIndex()	SelectSourceByIndexAsync()
SetOpenSourceTimeout()	OpenSource()	OpenSourceAsync()	EnableSourceUI()
EnableSource()	AcquireImage()	startScan()	DisableSource()
CloseSource()	CloseSourceAsync()	CloseWorkingProcess()

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

Events

OnSourceUIClose

Input

Methods

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

Output

Methods

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

Others

Methods

ClearTiffCustomTag()	SetTiffCustomTag()	ClearAllHTTPFormField()	SetHTTPFormField()
SetHTTPHeader()	SetUploadSegment()	ShowFileDialog()	Print()
PrintEx()

Properties

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

Events

OnGetFilePath	OnPostLoad	OnInternetTransferPercentage

Util

Methods

RegisterEvent()	UnregisterEvent()	SetProductKeyAsync()
SetLanguage()	GenerateURLForUploadData()

Properties

ErrorCode	ErrorString	LogLevel	Manufacturer
ProductFamily	ProductName	VersionInfo	ProductKey
UseLocalService

Viewer

Methods

bind()	clearSelectedAreas()	createCustomElement()	createImageEditor()
createThumbnailViewer()	first()	fitWindow()	gotoPage()
hide()	last()	next()	off()
on()	previous()	render()	setButtonClass()
setSelectedAreas()	setViewMode()	show()	unbind()
createTemplate()

Properties

acceptDrop	allowSlide	background	border
cursor	height	idPostfix	ifAutoScroll
innerBorder	pageMargin	selectedAreaBorderColor	selectedPageBackground
selectedPageBorder	selectionRectAspectRatio	showPageNumber	singlePageMode
width	zoom	autoChangeIndex	showCheckbox

Events

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

Addon

BarcodeReader

Methods

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

OCR

Methods

Download()	DownloadLangData()	IsModuleInstalled()	SetLanguage()
SetOutputFormat()	SetPageSetMode()	GetIfUseDetectedFont()	SetIfUseDetectedFont()
GetUnicodeFontName()	SetUnicodeFontName()	GetMinFontSizeforMoreAccurateResult()	SetMinFontSizeforMoreAccurateResult()
Recognize()	RecognizeFile()	RecognizeRect()	RecognizeSelectedImages()

OCRPro

Methods

Download()	IsModuleInstalled()	Recognize()
RecognizeFile()	RecognizeRect()	RecognizeSelectedImages()

Properties

Settings

PDF

Methods

GetConvertMode()	IsModuleInstalled()	IsTextBasedPDF()	SetConvertMode()
SetPassword()	SetResolution()	Write.Setup()

Camera

Methods

getSourceList()	selectSource()	getCurrentSource()	closeSource()
getResolution()	setResolution()	getCurrentResolution()	play()
pause()	resume()	stop()	getStatus()
capture()	showVideo()	closeVideo()	scanDocument()

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()