AddImageHtml Function    

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.

Using the MSHTML, ABCGecko and ABCWebKit engines, 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 do not 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.

Under the ABCChrome engine this method works slightly differently and without an intermediate file. While in many cases this is desirable, it may not scale well for very large HTML strings. If your HTML is larger than perhaps a megabyte you may wish to consider saving the HTML to file and referencing it via a 'file://' protocol specifier.

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.

This means you need to provide your stylesheet and image links as absolute references or provide a BaseURI property to allow them to be resolved. The BaseURI property is only available when you are using the ABCChrome Chrome123, Chrome117 or Chrome86 HTML rendering engine.

As an alternative you can insert an HTML BASE element into your HTML to specify an appropriate base location, or you can save your HTML to file in an appropriate location and then use AddImageUrl. Note that any HTML BASE tag must appear in the HEAD and it must appear before other references.

For security reasons the ABCChrome engines will not accept "file:///" protocol URIs in the HTML you provide. You have to use HTTP based references for this type of resource. Note that it can also be convenient to embed small images using data URIs.

Make sure your HTML comes from trusted sources. See the Security section of the HTML / CSS Rendering section of the documentation for details.

 

    

Example		  

None.