Adds a block of HTML styled text to the current page.

[C#]
int AddHtml(string text)
int AddHtml(string dummy, int chainid)

[Visual Basic]
Function AddHtml(text As String) As Integer
Function AddHtml(dummy As String, chainid As Integer) As Integer


Adds a block of HTML styled text to the current page.

This function works in a similar manner to the AddText function but it allows you to add multi-styled text by inserting simple HTML tags. A listing of supported tags is given in the HTML Styled Text section of the documentation. Please see Pos for details on positioning when using vertical fonts.

You can chain together multiple text/HTML blocks so that text flows from one to the next. To do this you need to first add a block of text/HTML using AddText or AddHtml. Then add multiple new text/HTML blocks using Doc.AddHtml each time passing in the ID obtained from the previous call after adjusting the target location (such as the rectangle or the page).

When no more text is available the AddHtml function will return zero. Alternatively you can query the TextLayer.Truncated property of the returned object before adding a new item to the chain.

This function returns the Object ID of the newly added Text Object. If no text could be added then zero is returned. This will happen if a zero length string was supplied or if the rectangle was too small for even one character to be displayed.

Typically you will get a return value of zero if your text was too large to fit in your Rect or if the Pos was at the end of the Rect.

Text styles for the entire HTML content are determined at the point at which the first item in a text chain is created. This means that varying document styles will not affect the way in which subsequent items in the chain are displayed.

For an example of chaining see the Text Flow Example.

Note that there is no requirement that blocks be organized in a linear chain. If you wish you can create trees of HTML blocks, flowing text from a chain head through multiple display areas on your document.

The following code adds some HTML styled text to a document.

[C#]
Doc theDoc = new Doc();
theDoc.FontSize = 72;
theDoc.AddHtml("<b>Gallia</b> est omnis divisa in partes tres, quarum unam incolunt <b>Belgae</b>, aliam <b>Aquitani</b>, tertiam qui ipsorum lingua <b>Celtae</b>, nostra <b>Galli</b> appellantur.");
theDoc.Save(Server.MapPath("docaddhtml.pdf"));
theDoc.Clear();

[Visual Basic]
Dim theDoc As Doc = New Doc()
theDoc.FontSize = 72
theDoc.AddHtml("<b>Gallia</b> est omnis divisa in partes tres, quarum unam incolunt <b>Belgae</b>, aliam <b>Aquitani</b>, tertiam qui ipsorum lingua <b>Celtae</b>, nostra <b>Galli</b> appellantur.")
theDoc.Save(Server.MapPath("docaddhtml.pdf"))
theDoc.Clear()



docaddhtml.pdf