Parameters for html2pdf

Url to call

http://convert.html2pdf.seven49.net/?parameter1=x&parameter2=y etc.
or for SSL connections (optional)
https://convert.html2pdf.seven49.net/?parameter1=x&parameter2=y etc.
Do not forget to encode your URL if you use any url_to_render with querystring! If you forget to encode the URL not all Parameters will have an effect.

Required Parameter

UrlToRender
String, a valid absolute URL to an (x)html ressource

OR

Html
HTML Source if you generate your HTML dynamically and do not want to make the template available by URL. You may want to use a POST request instead of a GET request in this case. POST requests are only allowed (and do only make sense) in conjunction with the Html parameter.

Optional Parameters

HttpUsername
String, Example: user
If your page is user/password protected by HTTP Authentication/Basic Authentication. Value must be alpha numeric.

HttpPassword
String, Example: test
If your page is user/password protected by HTTP Authentication/Basic Authentication. Please note that not all non alpha numeric characters are allowed here. Please contact support if you need help.

UserPassword

String, Example: test
If you want to password protect your PDF.

UsePrintMediaType
Integer, Example: 1, default is 0
If you want to use the print style sheets instead of the screen CSS.

Font
String, Examples: Helvetica, Times-Roman, Courier

FooterFontSize
Integer, Example: 9

Hint: The following "inset"-Parameters define margins.

FooterText
String, Example: Page @CurrentPage@ of @TotalPages@ Url: @Url@
Hint: Use the value blank if you want no text in the footer.
(do not forget to url encode the value)

FooterTemplateUrl (for html footers)
URL, Example: http%3A%2F%2Fwww.example.com (encoded URL)
The FooterTemplateUrl should simply be a page the contains the desired elements you want to show in the footer. If you want to change the size, position of anything etc. simply change your footer template. The URL must contain a HTML Template that can for instance contain an image and some text embedded in HTML/CSS. The target of the URL has to be a html page not a image. This allows you to position your elements as you like und the provided header area.

FooterInsetHorizontal
Integer, Examples: 0 (Footer will be aligned left, 100 (footer will be centered. applies to values above 80)

HeaderTemplateUrl (for html headers)
URL, Example: http%3A%2F%2Fwww.example.com (encoded URL)  
The HeaderTemplateUrl should simply be a page the contains the desired elements you want to show in the header. If you want to change the size, position of anything etc. simply change your header template. The URL must contain a HTML Template that can for instance contain an image and some text embedded in HTML/CSS. The target of the URL has to be a html page not a image. This allows you to position your elements as you like und the provided footer area.

InsetHorizontal
Integer, Example: 20

InsetVertical
Integer, Example: 40

ContentDisposition
String, valid values: "attachment", "inline"

Size
String, Values: A4, B5 or leave empty for US letter size

Orientation
String, valid values: "portrait", "landscape"

ImageQuality
Integer: Values from 1 to 100 resp. 101. Default is 101 (lossless compression)
Can be used to decrease PDF files size. The smaller the value the smaller the PDF file size. A reasonable value is 75.

AddLinks
Integer: 0 (Default) = do not add links, 1 = do add links. Example: url_to_render=http://www.yahoo.com&add_links=1

FileName
String: Changes the default value for the PDF file name. Example: somefilename

Title
String: Changes the default value for the PDF Title that can be found in the PDF Properties. Example: "Your Title" (do not forget to url encode the value)

Author
String: Changes the default value for the PDF Author that can be found in the PDF Properties. Example: "John Smith" (do not forget to url encode the value)

Subject
String: Changes the default value for the PDF Subject that can be found in the PDF Properties. Example: "Your Subject" (do not forget to url encode the value)

CanFillForms
Integer: 1 (Default), 0 = form fields can not be filled

DisableJavaScript
Integer: 0 (Default), 1 disables JavaScript and saves 0.2 seconds (see next parameter)

JavaScriptDelay
Integer: 200 (Default), Example: 4000 for a delay of 4 seconds. 20000 (20 seconds) is the allowed maximum.

DisableSmartShrinking
Integer: 0 (Standard), 1 disable the intelligent shrinking strategy used by WebKit

DisablePdfCompression
Integer: 0 (Standard), 1 do not use lossless compression on pdf objects

Zoom
Float: 1 (Standard), 1.1 (ca 110%) etc.

Something missing? Please let us know and we will try to add it.

Buy your Version of html2pdf

Starter Package

  • 1000 PDF Conversions
  • Highly Customazible
  • Free E-Mail Support

Pay with Paypal

Standard Package

  • 5000 PDF Conversions
  • Highly Customazible
  • Free E-Mail Support

Pay with Paypal

Professional Package

  • 10'000 PDF Conversions
  • Highly Customazible
  • Free E-Mail Support

Pay with Paypal

Enterprise Package

  • 25'000 PDFConversions
  • Highly Customazible
  • Free E-Mail Support

Pay with Paypal

Footer unten

Copyright © 2006 seven49.net
Source: http://html2pdf.seven49.net/en/Support/Parameters_for_html2pdf.htm
CMS Login schliessen

CMS Login

Please sign in to edit content
loading and processing data Verarbeite Anforderung ...