Class: HTML2PDF_WebPageSettings

PDFNet. HTML2PDF_WebPageSettings


new HTML2PDF_WebPageSettings()

Settings that control how a web page is opened and converted to PDF.

Methods


destroy()

Frees the native memory of the object.


setAllowJavaScript(enable)

Allow javascript from this web page to be run.

Parameters:
Name Type Description
enable boolean

If true javascript's are allowed.


setAllowPlugins(enable)

Allow Netscape and flash plugins from this web page to be run. Enabling will have limited success.

Parameters:
Name Type Description
enable boolean

If true Netscape & flash plugins will be run.


setBlockLocalFileAccess(block)

Allow local and piped files access to other local files.

Parameters:
Name Type Description
block boolean

If true local files will be inaccessible.


setDebugJavaScriptOutput(forward)

Forward javascript warnings and errors to output.

Parameters:
Name Type Description
forward boolean

If true javascript errors and warnings will be forwarded to stdout and the log.


setDefaultEncoding(encoding)

Default encoding to be used when not specified by the web page.

Parameters:
Name Type Description
encoding string

Default encoding, e.g. utf-8 or iso-8859-1.


Convert external links in HTML document to external PDF links.

Parameters:
Name Type Description
convert boolean

If true PDF pages produced from this web page can have external links.


setIncludeInOutline(include)

Add sections from this web page to the outline and table of contents.

Parameters:
Name Type Description
include boolean

If true PDF pages created from this web page will show up in the outline, and table of contents, otherwise, produced PDF pages will be excluded.


Convert internal links in HTML document into PDF references.

Parameters:
Name Type Description
convert boolean

If true PDF pages produced from this web page will have links to other PDF pages.


setJavaScriptDelay(msec)

Amount of time to wait for a web page to start printing after it's completed loading. Converter will wait a maximum of msec milliseconds for javascript to call window.print().

Parameters:
Name Type Description
msec number

Maximum wait time in milliseconds, e.g. 1200.


setLoadImages(load)

Print the images of this web page.

Parameters:
Name Type Description
load boolean

If true images are printed.


setMinimumFontSize(size)

Set the smallest font size allowed, e.g 9.

Parameters:
Name Type Description
size number

No fonts will appear smaller than this.


setPassword(password)

HtTP authentication password to use when logging into the website.

Parameters:
Name Type Description
password string

The login password to use with the server, e.g. "elbarto".


setPrintBackground(background)

Print the background of this web page.

Parameters:
Name Type Description
background boolean

If true background is printed.


setPrintMediaType(print)

Controls how content will be printed from this web page.

Parameters:
Name Type Description
print boolean

If true the print media type will be used, otherwise the screen media type will be used to print content.


setProduceForms(forms)

Turn HTML forms into PDF forms.

Parameters:
Name Type Description
forms boolean

If true PDF pages produced from this web page will have PDF forms for any HTML forms the web page has.


setProxy(proxy)

Use this proxy to load content from this web page.

Parameters:
Name Type Description
proxy PDFNet.HTML2PDF_Proxy

Contains settings for proxy


setSmartShrinking(enable)

Allow intelligent shrinking to fit more content per page.

Parameters:
Name Type Description
enable boolean

If true intelligent shrinking is enabled and the pixel/dpi ratio is non constant.


setStopSlowScripts(stop)

Stop slow running javascript's.

Parameters:
Name Type Description
stop boolean

If true, slow running javascript's will be stopped.


setUsername(username)

HtTP authentication username to use when logging into the website.

Parameters:
Name Type Description
username string

The login name to use with the server, e.g. "bart".


setUserStyleSheet(url)

Url or path to user specified style sheet.

Parameters:
Name Type Description
url string

URL or file path to user style sheet to be used with this web page.


setZoom(zoom)

Zoom factor to use when loading object.

Parameters:
Name Type Description
zoom number

How much to magnify the web content by, e.g. 2.2.