HTML Layout
The HtmlLayout page element renders HTML content within a specified area of the PDF page. The tag supports HTML 4.0.1 and CSS 2.1 specification tags and properties with a few limitations (see below).
HtmlLayout
An HtmlLayout has numerous constructors that allow inputting the HTML from a steam, text, URL, or a file path.
Example
The following example demonstrates using the HtmlLayout class with simple header and footer text displayed on the created PDF.
//Create Html layout page info
PageInfo layoutPage = new PageInfo(PageSize.A4, PageOrientation.Portrait);
//Create Uri
Uri uri = new Uri(inputHTMLPath);
//Create Html Layout
HtmlLayout html = new HtmlLayout(uri, layoutPage);
//Create a header
html.Header.Center.Text = "%%PR%%%%SP%% of %%ST%%";
html.Header.Center.HasPageNumbers = true;
html.Header.Center.Width = 200;
//Create a footer
html.Footer.Center.Text = "%%PR%%%%SP(A)%% of %%ST(B)%%";
html.Footer.Center.HasPageNumbers = true;
html.Footer.Center.Width = 200;
//Create a PDF Document
Document document = html.Layout();
//Save the PDF
document.Draw(outputPath);
'Create Html layout page info
Dim layoutPage As PageInfo = New PageInfo(PageSize.A4, PageOrientation.Portrait)
'Create Uri
Dim uri As Uri = New Uri(inputHTMLPath)
'Create a Html Layout
Dim html As HtmlLayout = New HtmlLayout(uri, layoutPage)
'Create a header
html.Header.Center.Text = "%%PR%%%%SP%% of %%ST%%"
html.Header.Center.HasPageNumbers = True
html.Header.Center.Width = 200
'Create a footer
html.Footer.Center.Text = "%%PR%%%%SP(A)%% of %%ST(B)%%"
html.Footer.Center.HasPageNumbers = True
html.Footer.Center.Width = 200
'Create a PDF Document
Dim document As Document = html.Layout
'Save the PDF
document.Draw(outputPath)
Refer to the HtmlLayout API documentation for a complete example.
HTML & CSS Support
DynamicPDF Core Suite supports the following HTML tags and CSS properties.
HTML Tags | CSS |
---|---|
a address blockquote center div img br hr h1 h2 h3 h4 h5 h6 p pre dd dl dt li ol ul table b i q u em tt big del dfn ins kbd sub sup var abbr cite code font samp span small s strike strong input textarea label button fieldset legend select acronym |
background color text-decoration letter-spacing text-align text-indent text-transform word spacing font border margin padding height min-height max-height width min-width max-width line-height position clip top right bottom left z-index list-style border-collapse border-spacing caption-side empty-cells table-layout clear display float visibility page-break-after page-break-before |
Character Encoding
The HTML passed to an HtmlLayout uses the following character encodings.
- The encoding specified in the HTML file header is used when the HTML source is an HTML file. If that is not present, the HTML meta charset is used.
- The character encoding specified in the HTML Meta charset converts an HTML string.
- UTF-8 is the default encoding used by the HTML Area when there is no meta charset or file encoding specified.
Limitations
Supported tags and properties are based on HTML 4.0.1 and CSS 2.1 specifications. Refer to the Product Limitations documentation for a complete listing of limitations.