Renders a web page specified as HTML.

 

   

Syntax
 

[C#]
int AddImageHtml(string html)
int AddImageHtml(string html, bool paged, int width, bool disableCache)

[Visual Basic]
Function AddImageHtml(html As String) As Integer
Function AddImageHtml(html As String, paged As Boolean, width As Integer, disableCache As Boolean) As Integer

Throws Exceptions may throw Exception()

 

   

Params
 
Name Description
html

The HTML to be rendered.

paged

Allows you to override the default XHtmlOptions.Paged property.

width Allows you to override the default XHtmlOptions.BrowserWidth property.
disableCache

Allows you to override and disable the page cache.

See the XHtmlOptions.PageCacheEnabled property for details.

return The ID of the newly added object.

 

   

Notes
 

This method is essentially the same as the AddImageUrl method but it allows you to use raw HTML rather than having to specify a URL.

ABCpdf saves this HTML into a temporary file and renders the file using a 'file://' protocol specifier. So this is a convenience function - it doesn't offer any performance enhancements.

Sometimes the IIS users don't have full access to the temp directory. This is determined by the system setup you have on your machine. If this is the case you will get errors returned.

So if you are working from ASP you may find that you need to enable access to the temp directory for the ASPNET user, the IUSR_MACHINENAME user or the IWAM_MACHINENAME user.

Styles and Images. HTML does not exist within a file and so it does not have a location.

External stylesheets and images are often referenced via relative URLs. Because the HTML has no location it is impossible to resolve these relative reference.

So you need to provide your stylesheet and image links as absolute references. Or you may be able to use the HTML BASE element to specify an appropriate base location. Or you can save your HTML to file in an appropriate location and then use AddImageUrl.

Note that the HTML BASE tag must appear in the HEAD and it must appear before other references.

 

   

Example
 

None.