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.

{WebTwainObject}.Addon.PDF

{WebTwainObject} denotes the WebTwain instance.

Methods

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

GetConvertMode()

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

Return the convert mode.

Syntax

GetConvertMode(): number;

Please refer to EnumDWT_ConvertMode.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
not supported v17.2+ v17.2+ v17.2+ v17.2+ v18.2+

GetReaderOptions()

Returns the current PDF reader options. Please refer to ReaderOptions.

Syntax

GetReaderOptions(): ReaderOptions;

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
not supported v18.4+ v18.4+ v18.4+ v18.4+ v18.4+

IsModuleInstalled()

Return whether the PDF module has been installed.

Syntax

IsModuleInstalled(): boolean;

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
v14.1+ v14.1+ v14.1+ v14.1+ v14.1+ v18.2+

IsTextBasedPDF()

Detect whether a local PDF file is text based or not.

Syntax

IsTextBasedPDF(path: string): boolean;

Parameters

path: Specify the path of the PDF file.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
v11.2+ v11.2+ v11.2+ v11.2+ v11.2+ v18.2+

SetConvertMode()

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

Set the convert mode.

Syntax

SetConvertMode(mode: Dynamsoft.DWT.EnumDWT_ConvertMode | number): boolean;

Parameters

mode: Specify the mode. Please refer to EnumDWT_ConvertMode. The default value is 3 (Dynamsoft.DWT.EnumDWT_ConvertMode.CM_AUTO)

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
v11.2+ v11.2+ v11.2+ v11.2+ v11.2+ v18.2+

Usage notes

There are three conversion modes

  • CM_RENDERALL (1): All the content in the target PDF file will be rasterized.
  • CM_IMAGEONLY (2): The PDF Rasterizer is turned off.
  • CM_AUTO (3): The library automatically detect whether a file needs to be rasterized or not and then process the file accordingly.

Use this method before you import a PDF into the viewer with methods such as LoadImage() , HTTPDownload() and FTPDownload().


SetReaderOptions()

Sets the current PDF reader options.

Syntax

SetReaderOptions(options: ReaderOptions): boolean;

Parameters options: Please see the ReaderOptions interface.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
not supported v18.4+ v18.4+ v18.4+ v18.4+ v18.4+

Usage Notes Use this method before you import a PDF into the viewer with methods such as LoadImage() , HTTPDownload() and FTPDownload().

Example

DWObject.Addon.PDF.SetReaderOptions({
    convertMode: Dynamsoft.DWT.EnumDWT_ConvertMode.CM_RENDERALL,
    renderOptions: {
        renderAnnotations: false,
        renderGrayscale: true,
    }
});

SetPassword()

This API has been deprecated as of release 18.4. Please SetReaderOptions() function.

Set the password for reading encrypted PDF files.

Syntax

SetPassword(password: string): boolean;

Parameters

password: Specify the password.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
v11.2+ v11.2+ v11.2+ v11.2+ v11.2+ v18.2+

Usage notes

Use this method before you import a PDF into the viewer with methods such as LoadImage() , HTTPDownload() and FTPDownload().


SetResolution()

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

Set the resolution for rasterizing.

Syntax

SetResolution(resolution: number): boolean;

Parameters

resolution: Specify the resolution.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
v11.2+ v11.2+ v11.2+ v11.2+ v11.2+ v18.2+

Usage notes

The default resolution for the conversion is 200. We recommend that you set a value smaller than 300, otherwise it might slow down the program or cause the process to fail.

Use this method before you import a PDF into the viewer with methods such as LoadImage() , HTTPDownload() and FTPDownload().


Write.Setup()

Set up the PDF writing engine.

Syntax

Write.Setup(settings: PDFWSettings): boolean;

Parameters

settings: Configures how the PDF is generated. Please refer to PDFWSettings.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux) Android
not supported v15.0+ v15.1+ v15.1+ v15.1+ v18.2+

Example

DWObject.Addon.PDF.Write.Setup({
    author: "Dynamsoft",
    compression: Dynamsoft.DWT.EnumDWT_PDFCompressionType.PDF_JPEG,
    pageType: Dynamsoft.DWT.EnumPDF_Page.Page_A4,
    creator: "DWT",
    creationDate: "D:20230101085959",
    keyWords: "samplepdf",
    modifiedDate: "D:20230101090101",
    producer: "Dynamic Web TWAIN",
    subject: "SamplePdf",
    title: "SamplePdf",
    version: "1.5",
    quality: 90,
    });

DWObject.SaveAllAsPDF("DynamicWebTWAIN.pdf", OnSuccess, OnFailure);

function OnSuccess() {
    console.log('successful');
}

function OnFailure(errorCode, errorString) {
    if(errorCode != -2326)
    alert(errorString);
}

Usage notes

Use this method before you create a PDF with methods such as HTTPUpload(), SaveAsPDF(), and SaveAllAsPDF().

Only the core module license is required to use this method.

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 +