Dev Center
Table of contents

Thanks for Downloading Dynamic Web TWAIN 30-Day Trial!

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

All Deprecated Features & APIs

All deprecated APIs are considered unsupported as of the version they are deprecated. They may be removed at any time with no further notice.

18.4

PDF Rasterizer

[Alternative] Use the SetReaderOptions() and GetReaderOptions() functions instead.

  • GetConvertMode()
  • SetConvertMode()
  • SetPassword()
  • SetResolution()

Viewer

This API has been deprecated as of release 18.4. Please use the updateSelectionBoxStyle() function.

  • selectedAreaBorderColor

18.2

Global

  • Dynamsoft.DWT.GetWebTwainEx()

18.0

Dynamic Web TWAIN

[Alternative] Use Dynamsoft.DWT.ProductKey instead.

  • Dynamsoft.DWT.licenseServer
  • Dynamsoft.DWT.sessionPassword
  • Dynamsoft.DWT.organizationID
  • Dynamsoft.DWT.handshakeCode

Util

  • Deprecated Method: DWObject.SetProductKeyAsync
  • Deprecated Property: DWObject.ProductKey

Scan

  • Deprecated Method: DWObject.GetDeviceType

17.3

Dynamic Web TWAIN

  • Deleted property: Dynamsoft.DWT.UseDefaultInstallUI

Viewer

[Alternative] Use updateCheckboxStyle and updatePageNumberStyle instead.

  • Viewer.showPageNumber
  • Viewer.showCheckbox
  • thumbnailViewer.showCheckbox
  • thumbnailViewer.showPageNumber

Camera Add-on

[Alternative] Use scanDocument instead.

  • Camera.showVideo()

17.0

Viewer

  • New APIs in v17.0 replace old APIs in v16.2-, all old APIs are deprecated.
v17.0 v16.2-
Viewer.autoChangeIndex Viewer.topPageChanged()
  • The following APIs are new in v17.0

16.2

  • Internet Explorer 8 is no longer supported.

Camera Add-on

  • New APIs in v16.2 replace old APIs in v16.1-, all old APIs are deleted.
v16.2 v16.1-
Addon.Camera.showVideo() Viewer.showVideo()
Addon.Camera.closeVideo() Viewer.closeVideo()
Addon.Camera.off() Viewer.off()
Addon.Camera.on("video-closed") Viewer.on("video-closed")
Addon.Camera.on("video-error") Viewer.on("video-error")

Viewer

  • New APIs in v16.2 replace old APIs in v16.1-, all old APIs are deprecated.
v16.2 v16.1-
Viewer.background BackgroundColor
Viewer.bind() , Viewer.show() , Viewer.hide() BindViewer()
Viewer.cursor MouseShape
Viewer.fitWindow() FitWindowType , IfFitWindow
Viewer.height Height
Viewer.ifAutoScroll IfAutoScroll
Viewer.on("click", callback) RegisterEvent("OnMouseClick", callback)
Viewer.on("contextmenu", callback) RegisterEvent("OnMouseRightClick", callback)
Viewer.on("dblclick", callback) RegisterEvent("OnMouseDoubleClick", callback)
Viewer.on("mousemove", callback) RegisterEvent("OnMouseMove", callback)
Viewer.on("pageAreaSelected", callback) RegisterEvent("OnImageAreaSelected", callback)
Viewer.on("pageAreaUnselected", callback) RegisterEvent("OnImageAreaDeSelected", callback)
Viewer.pageMargin ImageMargin
Viewer.selectedPageBorder SelectionImageBorderColor
Viewer.selectionRectAspectRatio SelectionRectAspectRatio
Viewer.setSelectedAreas() SetSelectedImageArea()
Viewer.showPageNumber ShowPageNumber
Viewer.unbind() UnbindView()
Viewer.width Width
Viewer.zoom Zoom
ViewerEvent.imageX MouseX
ViewerEvent.imageY MouseY

NOTE

ViewerEvent.imageX and ViewerEvent.imageY are only available as the first argument in callback functions for the mouse events “click”, “dblclick”, “contextMenu” and “mousemove”.

  /* Set the size of the viewer */
  DWObject.Viewer.height = 800;
  DWObject.Viewer.width = 600;
  /* Create a thumbnail viewer, note that this viewer can be hidden or disposed */
  var objThumbnailViewer = DWObject.Viewer.createThumbnailViewer(thumbnailViewerSettings);
  objThumbnailViewer.show();
  //objThumbnailViewer.hide();
  //objThumbnailViewer.dispose();
  /* updateViewMode() is used to change only the view mode of the thumbnail viewer */
  objThumbnailViewer.updateViewMode(viewMode: ViewMode);
  /* The following two are used to hook or unhook events to the thumbnail viewer */
  objThumbnailViewer.on()
  objThumbnailViewer.off()
  • ShowImageEditor()

While this method still works, it’s deprecated and the alternative is shown in the code below

  /* The image editor is now created on the fly and can be hidden or disposed */
  var objImageEditor = DWObject.Viewer.createImageEditor(editorSettings);
  objImageEditor.show();
  objImageEditor.hide();
  objImageEditor.dispose();
  • Viewer.bindCustomElement()
  • Viewer.showCustomElement()
  • Viewer.hideCustomElement()
  • Viewer.toggleCustomElement()

As already mentioned, these four methods are removed and the alternative implementation is shown in the code below

  var objCustomElement = DWObject.Viewer.createCustomElement(document.getElementById("divCustomElement"));
  objCustomElement.show();
  objCustomElement.hide();
  objCustomElement.dispose();

16.1.1

TWAIN Capability Negotiation

[Alternative] Use getCapabilities() and setCapabilities() instead.

  • CapGet()
  • CapGetHelp()
  • CapGetCurrent()
  • CapGetDefault()
  • CapGetFrameBottom()
  • CapGetFrameLeft()
  • CapGetFrameRight()
  • CapGetFrameTop()
  • CapGetLabel()
  • CapGetLabels()
  • CapSet()
  • CapReset()
  • CapSetFrame()
  • CapIfSupported()
  • GetCapItems()
  • GetCapItemsString()
  • SetCapItems()
  • SetCapItemsString()
  • Capability
  • CapNumItems
  • CapMaxValue
  • CapMinValue
  • CapCurrentValue
  • CapCurrentIndex
  • CapDefaultValue
  • CapDefaultIndex
  • CapType
  • CapValueType
  • CapStepSize
  • CapValue
  • CapValueString

Buffer Management

[Alternative] Use SelectedImagesIndices, SelectAllImages() and SelectImages() instead.

  • GetSelectedImageIndex()
  • SetSelectedImageIndex
  • SelectedImagesCount

Image Editing

  • AddText()
  • CreateTextFont()
  • OverlayRectangle()

Input and Output

[Alternative] Use new methods like ConvertToBase64(), PDF.Write.Setup()

  • SaveSelectedImagesToBase64Binary()
  • SetCookie()
  • IfOpenImageWithGDIPlus
  • PDFAuthor
  • PDFCompressionType
  • PDFCreationDate
  • PDFCreator
  • PDFKeywords
  • PDFModifiedDate
  • PDFProducer
  • PDFSubject
  • PDFTitle
  • PDFVersion
  • MaxInternetTransferThreads

Viewer

[Alternative] Use methods like Viewer.setViewMode(), Viewer.setViewMode()

  • SetViewMode()
  • SetSelectedImageArea()

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest Version (18.4)
    • Version 18.3
    • Version 18.1
    • Version 18.0
    • Version 17.3
    • Version 17.2.1
    • Version 17.1.1
    • Version 17.0
    • Version 16.2
    • Version 16.1.1
    Change +