Winnovative PDF Chromium for .NET Documentation
Pdf
A PDF Template can be used to repeat an HTML content in many PDF pages.
The HTML can contain placeholders such as {page-number} and {total-pages} to be replaced when the PDF is generated.
Definition
Namespace: Winnovative.Pdf.Chromium
Assembly: Winnovative.Pdf.Chromium (in Winnovative.Pdf.Chromium.dll) Version: 19.0.0
Assembly: Winnovative.Pdf.Chromium (in Winnovative.Pdf.Chromium.dll) Version: 19.0.0
C#
public class PdfHtmlHeaderFooter : PdfHtmlTemplate- Inheritance
- Object PdfHtmlTemplate PdfHtmlHeaderFooter
Properties
| AllowInsecureContent |
Allows loading insecure HTTP content in secure HTTPS pages.
The default value is false
(Inherited from PdfHtmlTemplate) |
| AutoResizePdfMargins | Allows the top and bottom margins of the PDF document to be automatically resized based on the header and footer HTML content. The default value is true |
| AutoSizeContentHeight |
Allows the PDF template content height to be auto resized based on the rendered HTML content height.
The minimum and maximum heights are controlled by the MinContentHeight and MaxContentHeight properties.
When this property is false, the content height is given by the Height property.
When this property is true, if the Height property is set with a positive value and the FitHeight property is also true, the content
may be scaled down to fit the specified height.
The default value is true
(Inherited from PdfHtmlTemplate) |
| ConversionDelay |
An additional time in seconds to wait for asynchronous items to be completely loaded or for a web page redirect to finish before
rendering the template HTML content. Default value is 0
(Inherited from PdfHtmlTemplate) |
| CountEndPages |
Specifies whether the external PDF pages inserted after the HTML to PDF conversion result
are included in the total page count used for page numbering.
Is ignored if ShowOnlyInHtmlToPdfPages is explicitly set to false.
The default value is true
(Inherited from PdfHtmlTemplate) |
| CountStartPages |
Specifies whether the external PDF pages inserted before the HTML to PDF conversion result
are included in the total page count used for page numbering.
Is ignored if ShowOnlyInHtmlToPdfPages is explicitly set to false.
The default value is true
(Inherited from PdfHtmlTemplate) |
| CountTocPages |
In HTML to PDF conversion, determines whether the Table of Contents (TOC) pages inserted before the conversion result
are included in the total page count used for page numbering.
This setting has no effect for inline TOCs. It is ignored if ShowOnlyInHtmlToPdfPages is explicitly set to false.
The default value is true
(Inherited from PdfHtmlTemplate) |
| DelayContentRendering | When set to true, the header or footer will reserve layout space on applicable pages as it would be rendered, but will not render any visible content. This is useful when the actual content is intended to be inserted in a later processing stage. The default value is false. |
| DestinationSize |
The template destination size in PDF page determined during rendering
(Inherited from PdfHtmlTemplate) |
| DisableSiteIsolation |
Disables site isolation when loading content from different sources.
The default value is false
(Inherited from PdfHtmlTemplate) |
| DisableWebSecurity |
Disables web security features such as CORS and same-origin policy.
The default value is false
(Inherited from PdfHtmlTemplate) |
| FitHeight |
If true, when AutoSizeContentHeight is also true and Height was set with a positive value, the HTML content may be
scaled down to fit the template height in PDF.
The default value is true
(Inherited from PdfHtmlTemplate) |
| GpuCompositingEnabled |
A flag indicating if the GPU compositing is enabled in the HTML to PDF converter.
WebGL rendering requires this option to be enabled.
The default value is false
(Inherited from PdfHtmlTemplate) |
| GpuRenderingEnabled |
A flag indicating if the GPU rendering is enabled in the HTML to PDF converter.
The default value is false
(Inherited from PdfHtmlTemplate) |
| Height |
Gets or sets the height of the PDF template. It is used together with AutoSizeContentHeight property
to determine the destination height of the template in PDF page.
When it is set with a positive value, it gives the template height if AutoSizeContentHeight is false or
if AutoSizeContentHeight is true and FitHeight is also true.
When it is set to a 0 or a negative value and the AutoSizeContentHeight is true, the PDF template height
is auto determined based on the HTML content height.
The default value is 0
(Inherited from PdfHtmlTemplate) |
| HorizontalAlign |
Specifies the horizontal alignment of the template on the PDF page.
Takes precedence over the X coordinate when set to a value other than None.
This property is ignored for header and footer templates.
The default value is None
(Inherited from PdfHtmlTemplate) |
| Html |
Gets or sets the HTML content of the template. It can contain template variable like {page_number} or {total_pages}
(Inherited from PdfHtmlTemplate) |
| HtmlBaseUrl |
Gets or sets the base URL used to resolve external resources in the HTML
(Inherited from PdfHtmlTemplate) |
| HtmlLoaderFilePath |
Sets the full path of HTML loader file used for HTML templates rendering
(Inherited from PdfHtmlTemplate) |
| HtmlSourceUrl |
Gets or sets the URL from which the HTML content should be retrieved.
The HTML content can contain template variable like {page_number} or {total_pages}.
The Html property takes precedence if both are set
(Inherited from PdfHtmlTemplate) |
| IgnoreCertificateErrors |
Ignores certificate validation errors such as expired, self-signed or invalid certificates.
The default value is false
(Inherited from PdfHtmlTemplate) |
| JavaScriptEnabled |
A flag indicating if JavaScript execution is enabled in HTML to PDF converter.
The default is true.
(Inherited from PdfHtmlTemplate) |
| Margins |
The margins to be applied to HTML template.
The default margins are 0
(Inherited from PdfHtmlTemplate) |
| MaxContentHeight |
Gets or sets the maximum height of the PDF template. This property is used when AutoSizeContentHeight is true
to limit the height of the HTML content. The default value is 24000
(Inherited from PdfHtmlTemplate) |
| MinContentHeight |
Gets or sets the minimum height of the PDF template. This property is used when AutoSizeContentHeight is true
to limit the height of the HTML content. The defaul value is 0
(Inherited from PdfHtmlTemplate) |
| Opacity |
The opacity as a value between 0 and 1 to be applied to entire template. For example, setting this property
to 0.75 will lower the opacity to 75% . The default value is 1 and the rendered PDF content will have
its original opacity.
If you want to control only the opacity of the HTML template background, you can do this by setting
the body element style to background-color: rgba(255, 255, 255, 0.75), which will set the opacity to 0.75
(Inherited from PdfHtmlTemplate) |
| PageCounterAutoSize |
A flag indicating if the converter will automatically set the page counter width.
(Inherited from PdfHtmlTemplate) |
| PageCounterFontScale |
A zoom factor applied to the font used to display the {page_number} and {total_pages} placeholders.
It must be a value between 0.1 and 2.0. The default value is 1.0
(Inherited from PdfHtmlTemplate) |
| PageCounterSize |
It represents the maximum number of digits for page numbering placeholders.
This value is used if the PageCounterAutoSize property is false.
The default value is 2
(Inherited from PdfHtmlTemplate) |
| PageNumberOffset |
An optional offset (positive or negative) applied to the current page number when replacing
the {page_number} placeholder in the template content.
The default value is 0
(Inherited from PdfHtmlTemplate) |
| RenderedSize |
The template rendered size in PDF page determined during rendering
(Inherited from PdfHtmlTemplate) |
| ReserveSpaceAlways | If true, space is reserved on all pages regardless of header and footer visibility. This is the default behavior. If false, space for the header or footer is reserved only on pages where they are actually rendered, and styling rules intended for print layout will be applied in this case. It is ignored if ShowOnlyInHtmlToPdfPages is explicitly set to false. The default value is true |
| ShowInEvenPages |
Specifies whether the template should be displayed on even-numbered pages of the PDF document.
In HTML to PDF conversion, if ShowOnlyInHtmlToPdfPages is true, the first page
generated from HTML is considered odd, the second even, and so on.
If ShowOnlyInHtmlToPdfPages is false, the same rule applies based on the final document.
In PDF merging or editing, this refers to even-numbered pages in the final PDF.
The default value is true
(Inherited from PdfHtmlTemplate) |
| ShowInFirstPage |
Specifies whether the template should be displayed on the first page of the PDF document.
In HTML to PDF conversion, the first page refers to the first page generated from HTML content
if ShowOnlyInHtmlToPdfPages is true or to the first page of the final PDF document
if ShowOnlyInHtmlToPdfPages is is false.
In PDF merging or editing, it refers to the actual first page of the final PDF.
The default value is
(Inherited from PdfHtmlTemplate) |
| ShowInOddPages |
Specifies whether the template should be displayed on odd-numbered pages of the PDF document.
In HTML to PDF conversion, if ShowOnlyInHtmlToPdfPages is true, the first page
generated from HTML is considered odd, the second even, the third odd, and so on.
If ShowOnlyInHtmlToPdfPages is false, the same rule applies but based on the entire document.
In PDF merging or editing, this refers to odd-numbered pages in the final PDF.
The default value is true
(Inherited from PdfHtmlTemplate) |
| ShowOnlyInHtmlToPdfPages |
In the context of HTML to PDF conversion, specifies whether the template should be displayed
only on the PDF pages generated by the HTML to PDF converter, or on all PDF pages, including
external PDF pages and Table of Contents (TOC) pages.
The default value is true
(Inherited from PdfHtmlTemplate) |
| SkipVariablesParsing |
A performance hint indicating that the template HTML does not contain any variable placeholders
such as {page_number} or {total_pages}.
When set to true and the template is provided via URL, the converter can skip downloading and inspecting the HTML content
and render the HTML directly from the URL.
This can improve performance by avoiding unnecessary network and parsing operations.
The default value is false
(Inherited from PdfHtmlTemplate) |
| TotalPagesOffset |
An optional offset (positive or negative) applied to the total number of pages when replacing
the {total_pages} placeholder in the template content.
The default value is 0
(Inherited from PdfHtmlTemplate) |
| VerticalAlign |
Specifies the vertical alignment of the template on the PDF page.
Takes precedence over the Y coordinate when set to a value other than None.
This property is ignored for header and footer templates.
The default value is None
(Inherited from PdfHtmlTemplate) |
| Width |
Gets or sets the width of the PDF template.
This property is ignored for header and footer templates because the width is determined from PDF page width
(Inherited from PdfHtmlTemplate) |
| X |
Gets or sets the X position of the template in the PDF pages relative to the top left of the page.
This property is ignored for header and footer templates
(Inherited from PdfHtmlTemplate) |
| Y |
Gets or sets the Y position of the template in the PDF pages relative to the top left of the page.
This property is ignored for header and footer templates
(Inherited from PdfHtmlTemplate) |
Methods
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |