Class PDFNet.HTML2PDF_WebPageSettings
PDFNet.HTML2PDF_WebPageSettings
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Settings that control how a web page is opened and converted to PDF.
|
| Method Attributes | Method Name and Description |
|---|---|
|
destroy()
Frees the native memory of the object.
|
|
|
setAllowJavaScript(enable)
Allow javascript from this web page to be run?
|
|
|
setAllowPlugins(enable)
Allow Netscape and flash plugins from this web page to
be run? Enabling will have limited success.
|
|
|
setBlockLocalFileAccess(block)
Allow local and piped files access to other local files?
|
|
|
setDebugJavaScriptOutput(forward)
Forward javascript warnings and errors to output?
|
|
|
setDefaultEncoding(encoding)
Default encoding to be used when not specified by the web page.
|
|
|
setExternalLinks(convert)
Convert external links in HTML document to external
PDF links?
|
|
|
setIncludeInOutline(include)
Add sections from this web page to the outline and
table of contents?
|
|
|
setInternalLinks(convert)
Should internal links in HTML document be converted
into PDF references?
|
|
|
setJavaScriptDelay(msec)
Amount of time to wait for a web page to start printing after
it's completed loading.
|
|
|
setLoadImages(load)
Print the images of this web page?
|
|
|
setMinimumFontSize(size)
Set the smallest font size allowed, e.g 9.
|
|
|
setPassword(password)
HtTP authentication password to use when logging into the website.
|
|
|
setPrintBackground(background)
Print the background of this web page?
|
|
|
setPrintMediaType(print)
Controls how content will be printed from this web page.
|
|
|
setProduceForms(forms)
Turn HTML forms into PDF forms?
|
|
|
setProxy(proxy)
Use this proxy to load content from this web page.
|
|
|
setSmartShrinking(enable)
Allow intelligent shrinking to fit more content per page?
|
|
|
setStopSlowScripts(stop)
Stop slow running javascript's?
|
|
|
setUsername(username)
HtTP authentication username to use when logging into the website.
|
|
|
setUserStyleSheet(url)
Url or path to user specified style sheet.
|
|
|
setZoom(zoom)
Zoom factor to use when loading object.
|
Class Detail
PDFNet.HTML2PDF_WebPageSettings(id)
Settings that control how a web page is opened and converted to PDF.
- Parameters:
- id
Method Detail
destroy()
Frees the native memory of the object.
setAllowJavaScript(enable)
Allow javascript from this web page to be run?
- Parameters:
- {boolean} enable
- 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:
- {boolean} enable
- If true Netscape & flash plugins will be run.
setBlockLocalFileAccess(block)
Allow local and piped files access to other local files?
- Parameters:
- {boolean} block
- If true local files will be inaccessible.
setDebugJavaScriptOutput(forward)
Forward javascript warnings and errors to output?
- Parameters:
- {boolean} forward
- 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:
- {string} encoding
- Default encoding, e.g. utf-8 or iso-8859-1.
setExternalLinks(convert)
Convert external links in HTML document to external
PDF links?
- Parameters:
- {boolean} convert
- 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:
- {boolean} include
- 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.
setInternalLinks(convert)
Should internal links in HTML document be converted
into PDF references?
- Parameters:
- {boolean} convert
- 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:
- {number} msec
- Maximum wait time in milliseconds, e.g. 1200.
setLoadImages(load)
Print the images of this web page?
- Parameters:
- {boolean} load
- If true images are printed.
setMinimumFontSize(size)
Set the smallest font size allowed, e.g 9.
- Parameters:
- {number} size
- No fonts will appear smaller than this.
setPassword(password)
HtTP authentication password to use when logging into the website.
- Parameters:
- {string} password
- The login password to use with the server, e.g. "elbarto".
setPrintBackground(background)
Print the background of this web page?
- Parameters:
- {boolean} background
- If true background is printed.
setPrintMediaType(print)
Controls how content will be printed from this web page.
- Parameters:
- {boolean} print
- 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:
- {boolean} forms
- 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:
- {HTML2PDF_Proxy} proxy
- Contains settings for proxy
setSmartShrinking(enable)
Allow intelligent shrinking to fit more content per page?
- Parameters:
- {boolean} enable
- If true intelligent shrinking is enabled and the pixel/dpi ratio is non constant.
setStopSlowScripts(stop)
Stop slow running javascript's?
- Parameters:
- {boolean} stop
- If true, slow running javascript's will be stopped.
setUsername(username)
HtTP authentication username to use when logging into the website.
- Parameters:
- {string} username
- The login name to use with the server, e.g. "bart".
setUserStyleSheet(url)
Url or path to user specified style sheet.
- Parameters:
- {string} url
- 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:
- {number} zoom
- How much to magnify the web content by, e.g. 2.2.