The pdf generator will be loaded with this default settings: Default json settings »
Post parameter Settings with a custom json settings to override the default json settings.
PdfPageSize in the custom json settings.
Post the following parameters (in for example a dictionary) to https://evopdfgenerator.automation.abb.com/pdf
All the following parameters could be named with lower or upper case, with or without "-" or a mix of all (ie CamelCase or kebab-case).
Ex: param-example, paramexample and ParamExample will all be valid for the same parameter.
| Name | Type | Default | Description |
|---|---|---|---|
| ApiKey | String |
Required
A better way is to add the ApiKey as an authentication header value in Authorization instead like client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
|
|
| Settings | String | Custom json settings that overrides the default json settings Default json settings » | |
| AutoSizePdfPage | Boolean |
false
|
See description in Evo Pdf » |
| BottomMargin MarginBottom |
Integer |
0
|
Content margin to the bottom of each page. |
| ConversionDelay | Integer |
2
|
An additional time in seconds to wait for asynchronous items to be completely loaded or for a web page redirect to finish before starting the rendering in HTML to PDF converter. TriggeringMode must be set to ConversionDelay in order for this parameter to be used.
See description in Evo Pdf »
|
| DocumentUrl DocumentHtml Url Value |
String | Any of these parameter names will be used as url to the page that will be converted to a pdf. | |
| EndPdfUrls Attachments |
String | List of url:s to pdf files that will be rendered after the converted pdf. | |
| ExternalPdfTimeout | Integer |
30
|
In seconds. Used when fetching pdf files from StartPdfUrls and EndPdfUrls
|
| FitWidth | Boolean |
true
|
Resize the content to fit the available width if necessary. |
| FontFamilyName | String |
"Arial"
|
Will be used if parameter ShowPageNumbersInHeader/ShowPageNumbersInFooter is set or parameter FooterText/HeaderText is set.
|
| FontSize | Float |
8.0
|
In points (pt). Will be used if parameter ShowPageNumbersInHeader/ShowPageNumbersInFooter is set or parameter FooterText/HeaderText is set.
|
| FooterHeight | Integer |
20
|
The height of the footer. |
| FooterHtml | String |
Html code that will be rendered as footer. FooterHeight will be used if this parameter is set.
|
|
| FooterText | String |
Center aligned text that will be rendered as footer. Could be combined with ShowPageNumbersInFooter, ShowPageNumbersLeft and ShowPageNumbersRight if set. FooterHeight will be used if this parameter is set.
|
|
| FooterTextTemplate | String |
Default:<div style="text-align:center;{{FontFamily}}{{FontSize}}"><span style="{{MarginLeft}}float: left;width: 50px;text-align: left;">{{PageNumberLeft}}</span><span>{{FooterText}}</span><span style="{{MarginRight}}float: right;width: 50px;text-align: right;">{{PageNumberRight}}</span></div>Note! Please keep any parameters wrapped in {{}} if used.
|
|
| FooterUrl | String |
Generate a footer from this url. FooterHeight will be used if this parameter is set.
|
|
| HeaderHeight | Integer |
20
|
The height of the header. |
| HeaderHtml | String |
Html code that will be rendered as header. HeaderHeight will be used if this parameter is set.
|
|
| HeaderText | String |
Center aligned text that will be rendered as header. Could be combined with ShowPageNumbersInHeader, ShowPageNumbersLeft and ShowPageNumbersRight if set. HeaderHeight will be used if this parameter is set.
|
|
| HeaderTextTemplate | String |
Default:<div style="text-align:center;{{FontFamily}}{{FontSize}}"><span style="{{MarginLeft}}float: left;width: 50px;text-align: left;">{{PageNumberLeft}}</span><span>{{HeaderText}}</span><span style="{{MarginRight}}float: right;width: 50px;text-align: right;">{{PageNumberRight}}</span></div>Note! Please keep any parameters wrapped in {{}} if used.
|
|
| HeaderUrl | String |
Generate a header from this url. HeaderHeight will be used if this parameter is set.
|
|
| HtmlViewerWidth | Integer |
1024
|
HTML viewer width in pixels. See description in Evo Pdf » |
| HtmlViewerZoom | Integer |
100
|
HTML viewer zoom in percentage. Similar to zoom level in a browser See description in Evo Pdf » |
| ImagesScalingEnabled | Boolean |
true
|
Is image scaling enabled or not for the images in the PDF document. This option enables the converter to scale the images used in HTML down to their display size in HTML before rendering them in PDF. This can lead to smaller memory consumption during conversion and to a smaller PDF document size but the images quality in PDF can be lower. |
| JavaScriptEnabled | Boolean |
true
|
A flag indicating if JavaScript execution is enabled in HTML to PDF converter |
| JpegCompressionEnabled | Boolean |
true
|
Is the JPEG compression enabled or not for the images in the PDF document. |
| JpegCompressionLevel | Integer |
10
|
Set the JPEG Compression Level (0-100). A higher compression level produces smaller PDF documents but lower quality images in PDF. Leave it not set for a default compression level. |
| LeftMargin MarginLeft |
Integer |
0
|
Content margin to the left of each page. |
| MediaType | String |
"print"
|
"print" or "screen". See description in Evo Pdf » |
| Orientation | String |
"Portrait"
|
"Portrait" or "Landscape". |
| PageNumberFormat | String |
"{0}/{1}"
|
{0} = Current page number, {1} = Total page numbers. Be sure to keep at least "{0}" which is required. "{1}" is optional. |
| PageNumberHorizontalMargin | Integer |
40
|
Horizontal margin used when page numbers is rendered. Equally divided to the left and right side. |
| PageSize | String |
"A4"
|
See description in Evo Pdf » |
| PdfCompressionLevel | String |
"Normal"
|
"NoCompression", "Normal" or "Best". See description in Evo Pdf » |
| RightMargin MarginRight |
Integer |
0
|
Content margin to the right of each page. |
| ShowFooterOnFirstPage | Boolean |
false
|
Show footer on first page. |
| ShowPageNumbers | Boolean |
false
|
[OBSOLETE] Show page numbers. Same as ShowPageNumbersInFooter.
|
| ShowPageNumbersInFooter | Boolean |
false
|
Show page numbers in footer. Could be combined with FooterText
|
| ShowPageNumbersInHeader | Boolean |
false
|
Show page numbers in header. Could be combined with HeaderText
|
| ShowPageNumbersLeft | Boolean |
true
|
Show page numbers. Will be rendered to the left in the footer/header. Could be combined with FooterText/HeaderText
|
| ShowPageNumbersRight | Boolean |
false
|
Show page numbers. Will be rendered to the right in the footer. Could be combined with FooterText/HeaderText
|
| StartPdfUrls | String | List of url:s to pdf files that will be rendered before the converted pdf. | |
| StretchToFit | Boolean |
false
|
Stretch the content to fit the available width if necessary. FitWidth must be set to true in order for this parameter to be used.
|
| TopMargin MarginTop |
Integer |
0
|
Content margin to the top of each page. |
| TriggeringMode | String |
"ConversionDelay"
|
"Auto", "ConversionDelay" or "Manual". Set parameter ConversionDelay if this parameter is set to ConversionDelay
See description in Evo Pdf »
|