deprecated.md

layout	default-layout
needAutoGenerateSidebar	true
noTitleIndex	true
title	Dynamic Web TWAIN SDK Schedule - Deprecated Features
keywords	Dynamic Web TWAIN, Documentation, Schedule, Deprecated Features
breadcrumbText	Deprecated
description	Dynamic Web TWAIN SDK Documentation Deprecated Features Page

All Deprecated Features & APIs

Note

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

19.3

Deprecated Method: DWTObject.Print

19.0

Global

• Deprecated Property: Dynamsoft.DWT.IfUseActiveXForIE10Plus

Util

• Deprecated Method: DWTObject.isUsingActiveX

18.4

PDF Rasterizer

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

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

Deprecate the enum value CM_RENDERALLWITHANNOTATION from Dynamsoft.DWT.EnumDWT_ConvertMode.

Viewer

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

• selectedAreaBorderColor

18.2

Global

• Dynamsoft.DWT.GetWebTwainEx()

18.1

The WASM edition (camera add-on) is removed from Web TWAIN. The following API is deprecated: UseLocalService.

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: DWTObject.SetProductKeyAsync
• Deprecated Property: DWTObject.ProductKey

Scan

• Deprecated Method: DWTObject.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 Mobile Document Scanner instead.

• Camera.showVideo()

OCR Add-On

OCR Basic and OCR Pro client-side are deprecated.

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
  • RemoveTag
  • GetTagList
  • DWT.licenseServer
  • DWT.handshakeCode
  • DWT.sessionPassword
  • DWT.licenseException

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".

• The following APIs are new in v16.2

  • Viewer.acceptDrop
  • Viewer.allowSlide
  • Viewer.clearSelectedAreas()
  • Viewer.createThumbnailViewer()
  • Viewer.border
  • Viewer.first()
  • Viewer.getUISettings()
  • Viewer.gotoPage()
  • Viewer.idPostfix
  • Viewer.innerBorder
  • Viewer.last()
  • Viewer.next()
  • Viewer.on("pageRendered", callback)
  • Viewer.on("resize", callback)
  • Viewer.previous()
  • Viewer.render()
  • Viewer.resetUISettings()
  • Viewer.selectedAreaBorderColor
  • Viewer.selectedPageBackground
  • Viewer.singlePageMode

• The following APIs in v16.2 are improved based on old APIs in v16.1-.

  • Viewer.setViewMode()

    It also accepts the values "-1, -1" which is equivalent to setting Viewer.singlePageMode to true .

  • Viewer.updateUISettings()

• The following APIs are also deprecated in v16.2

  • SetViewMode()

    Use Viewer.setViewMode() instead.

• The following APIs from v16.1- are removed

  • Viewer.bOnlyShowThumbnailsView
  • Viewer.cursorOverThumbnailsView
  • Viewer.bindCustomElement()
  • Viewer.showCustomElement()
  • Viewer.hideCustomElement()
  • Viewer.toggleCustomElement()
  • Viewer.setSelectedImageArea()
  • Viewer.zoomIn()
  • Viewer.zoomOut()

• The following APIs in v16.1- are implemented differently in v16.2

  • BindViewer() with two parameters
  • UpdateViewer()

  The two methods above were used to set the size of the viewer or to show the thumbnail viewer. In v16, 2, different APIs are used as shown below:

  /* Set the size of the viewer */
  DWTObject.Viewer.height = 800;
  DWTObject.Viewer.width = 600;
  /* Create a thumbnail viewer, note that this viewer can be hidden or disposed */
  var objThumbnailViewer = DWTObject.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 = DWTObject.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 = DWTObject.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()