{WebTwainObject} Util

The properties and methods on this page live in the namespace {WebTwainObject}. {WebTwainObject} denotes the WebTwain instance. Learn about how to create a web twain object.

Methods

Properties

isUsingActiveX

Syntax

/**
 * Return whether the WebTwain object is running the ActiveX edition.
 */
isUsingActiveX(): boolean;

Availability

RegisterEvent

Syntax

/**
 * Specify an event listener for the specified built-in event.
 * @param name Specify the event
 * @param callback The event listener
 */
RegisterEvent(name: string, callback: () => void): boolean;

Availability

UnregisterEvent

Syntax

/**
 * Remove an event listener from the specified built-in event.
 * @param name Specify the event
 * @param callback The event listener
 */
UnregisterEvent(name: string, callback: () => void): boolean;

Availability

Usage notes

There can only be one listener for each built-in event. If you call RegisterEvent on the same event again, the new callback will replace the old one.

SetProductKeyAsync

Syntax

/**
 * Set the product key.
 * @param productKey Specify the key.
 */
SetProductKeyAsync(
    productKey: string
): Promise<any>;

Availability

SetLanguage

Syntax

/**
 * Set the language for the authorization dialogs.
 * @param language Specify the language.
 */
SetLanguage(
    language: Dynamsoft.DWT.EnumDWT_Language | number
): boolean;

Availability

Usage notes

The language set with this method is only for the built-in security dialogs which show up when the user tries to access a scanner, a camera or a local file.

GenerateURLForUploadData

Syntax

/**
 * Generate a URL to be used by a FileUpoader instance to fetch the data to upload.
 * @param indices Specify the images to upload.
 * @param type Specify the file type.
 * @param successCallback A callback function that is executed if the request succeeds.
 * @param failureCallback A callback function that is executed if the request fails.
 * @argument resultURL The generated URL.
 * @argument indices The indices of the images.
 * @argument type The file type.
 */
GenerateURLForUploadData(
    indices: number[],
    type: Dynamsoft.DWT.EnumDWT_ImageType | number,
    successCallback: (
        resultURL: string,
        indices: number[],
        type: Dynamsoft.DWT.EnumDWT_ImageType | number
    ) => void,
    failureCallback: (
        errorCode: number,
        errorString: string
    ) => void
): void;

Availability

Usage notes

The language set with this method is only for the built-in security dialogs which show up when the user tries to access a scanner, a camera or a local file.

ErrorCode

Syntax

/**
 * Return the error code.
 */
readonly ErrorCode: number;

Availability

Usage notes

The ErrorCode and ErrorString always reflect the result of the last API call. So make sure you read them in time.

ErrorString

Syntax

/**
 * Return the error string.
 */
readonly ErrorString: string;

Availability

Usage notes

The ErrorCode and ErrorString always reflect the result of the last API call. So make sure you read them in time.

LogLevel

Syntax

/**
 * Return or set the log level for debugging.
 */
LogLevel: number;

Availability

Usage notes

The logs for the Dynamic Web TWAIN library are saved in the directory C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\log\. By default, LogLevel is 0 and nothing is recorded. When it is set to 1, all debugging information is recorded. This setting in your application will apply to all machines.

To enable logging on a specific machine, you can set LogLevel to 14 in this file: C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\DSConfiguration.ini.

Manufacturer

Syntax

/**
 * Manufacturer in the identity string of the Dynamic Web TWAIN library.
 */
readonly Manufacturer: string;

Availability

Usage notes

Manufacturer , ProductFamily , ProductName and VersionInfo together form the identity string of the Dynamic Web TWAIN library.

ProductFamily

Syntax

/**
 * ProductFamily in the identity string of the Dynamic Web TWAIN library.
 */
readonly ProductFamily: string;

Availability

Usage notes

Manufacturer , ProductFamily , ProductName and VersionInfo together form the identity string of the Dynamic Web TWAIN library.

ProductName

Syntax

/**
 * ProductName in the identity string of the Dynamic Web TWAIN library.
 */
readonly ProductName: string;

Availability

Usage notes

Manufacturer , ProductFamily , ProductName and VersionInfo together form the identity string of the Dynamic Web TWAIN library.

VersionInfo

Syntax

/**
 * VersionInfo in the identity string of the Dynamic Web TWAIN library.
 */
readonly VersionInfo: string;

Availability

Usage notes

Manufacturer , ProductFamily , ProductName and VersionInfo together form the identity string of the Dynamic Web TWAIN library.

ProductKey

Syntax

/**
 * Return or set the ProductKey.
 */
ProductKey: string;

Availability

Usage notes

The ProductKey contains the license to use the Dynamic Web TWAIN library. From version 16.1, if the license needs to be changed at runtime, use the method SetProductKeyAsync() instead.

UseLocalService

Syntax

/**
 * Return whether this WebTwain instance is in Local-Service mode or WASM mode.
 */
UseLocalService: boolean;

Availability