byBrick PDF Generator

Settings

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.

NOTE! It's not possible to set PdfPageSize in the custom json settings.

Parameters

Post the following parameters (in for example a dictionary) to http://evo-pdf.bybricksalestools.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 »
AutoResizePdfPageWidth Boolean false Resize the content to fit the available width if necessary.
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 false [OBSOLETE] Resize the content to fit the available width if necessary. Same as AutoResizePdfPageWidth.
FontFamilyName String "Arial" Will be used if parameter ShowPageNumbersInHeader/ShowPageNumbersInFooter is set or parameter FooterText/HeaderText is set.
FontSize Float 8.0 In pixels (px). Will be used if parameter ShowPageNumbersInHeader/ShowPageNumbersInFooter is set or parameter FooterText/HeaderText is set.
FooterHeight Integer 0 The height of the footer. If set to 0, the footer will be automatically sized based on its content.
FooterHtml String Html code that will be rendered as footer.
FooterText String Center aligned text that will be rendered as footer. Could be combined with ShowPageNumbersInFooter, ShowPageNumbersLeft and ShowPageNumbersRight if set.
FooterTextTemplate String Default:


Note! Please keep any parameters wrapped in {{}} if used.
FooterUrl String Generate a footer from this url.
HeaderHeight Integer 0 The height of the header. If set to 0, the header will be automatically sized based on its content.
HeaderHtml String Html code that will be rendered as header.
HeaderText String Center aligned text that will be rendered as header. Could be combined with ShowPageNumbersInHeader, ShowPageNumbersLeft and ShowPageNumbersRight if set.
HeaderTextTemplate String Default:


Note! Please keep any parameters wrapped in {{}} if used.
HeaderUrl String Generate a header from this url.
HtmlViewerWidth Integer 1024 HTML viewer width in pixels. See description in Evo Pdf »
HtmlViewerZoom Integer 77 HTML viewer zoom in percentage. Similar to zoom level in a browser See description in Evo Pdf »
JavaScriptEnabled Boolean true A flag indicating if JavaScript execution is enabled in HTML to PDF converter
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 »
PdfCompressionEnable Boolean false NOTE! PDF compression is enabled in the configuration so this parameter can be used.

Enable compression of the generated pdf file.

NOTE! If compression is enabled make sure the timeout settings from the calling web is high enough to allow the compression to finish. If the timeout is too low, the compression will not be finished before the calling web cancels the request before anything has been returned.
PdfCompressionLevel String "Ebook" Compression will be made with GhostScript.

NOTE! PdfCompressionEnable must be enabled in order for this parameter to be used.

Ebook - Medium compression [Recommended]
Screen - Strongest compression
Printer - High quality output, intended to be useful for printing.
Prepress - Almost no compression
RightMargin
MarginRight		 Integer 0 Content margin to the right of each page.
ShowFooterOnFirstPage Boolean false Show footer on first page.
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.
TopMargin
MarginTop		 Integer 0 Content margin to the top of each page.
TriggeringMode String "Auto" "Auto", "ConversionDelay" or "Manual". Set parameter ConversionDelay if this parameter is set to ConversionDelay See description in Evo Pdf »