Class PdfHTMLTextElement

Represents a HTML text area with the ability to span several pages.

Inheritance
System.Object
PdfHTMLTextElement
Namespace: Syncfusion.Pdf.Graphics
Assembly: Syncfusion.Pdf.NET.dll
Syntax
public class PdfHTMLTextElement : Object
Remarks

This API is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight. To know more about refer this link .

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement(htmlText, font, PdfBrushes.Black);
htmlTextElement.TextAlign = TextAlign.Left;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement(htmlText, font, PdfBrushes.Black)
htmlTextElement.TextAlign = TextAlign.Left
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Constructors

PdfHTMLTextElement()

Initializes a new instance of the PdfHTMLTextElement class.

Declaration
public PdfHTMLTextElement()
Remarks

This Constructor is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

PdfHTMLTextElement(String, PdfFont, PdfBrush)

Initializes a new instance of the PdfHTMLTextElement class with the specified HTML text, font and brush

Declaration
public PdfHTMLTextElement(string htmlText, PdfFont font, PdfBrush brush)
Parameters
Type Name Description
System.String htmlText

The HTML text to be rendered in PDF.
PdfFont font

The font.
PdfBrush brush

The brush.
Remarks

This Constructor is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement(htmlText, font, PdfBrushes.Black);
htmlTextElement.TextAlign = TextAlign.Left;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement(htmlText, font, PdfBrushes.Black)
htmlTextElement.TextAlign = TextAlign.Left
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Properties

Brush

Gets or sets the brush for the text element.

Declaration
public PdfBrush Brush { get; set; }
Property Value
Type
PdfBrush
Remarks

This property is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Set PDF brush.
htmlTextElement.Brush = new PdfSolidBrush(Color.Red);
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Set PDF brush.
htmlTextElement.Brush = New PdfSolidBrush(Color.Red)
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Font

Gets or sets the base font for the text element.

Declaration
public PdfFont Font { get; set; }
Property Value
Type
PdfFont
Remarks

This property is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

HTMLText

Gets or sets the HTML Text.

Declaration
public string HTMLText { get; set; }
Property Value
Type
System.String
Remarks

This property is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

TextAlign

Gets or sets the text alignment.

Declaration
public TextAlign TextAlign { get; set; }
Property Value
Type
TextAlign
Remarks

This property is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
//Set text align.
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
'Set text align
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Methods

add_BeginPageLayout(BeginPageLayoutEventHandler)

Declaration
public void add_BeginPageLayout(BeginPageLayoutEventHandler value)
Parameters
Type Name Description
BeginPageLayoutEventHandler value

add_EndPageLayout(EndPageLayoutEventHandler)

Declaration
public void add_EndPageLayout(EndPageLayoutEventHandler value)
Parameters
Type Name Description
EndPageLayoutEventHandler value

Draw(PdfGraphics, PointF, Single, Single)

Draws the text on the graphics.

Declaration
public void Draw(PdfGraphics graphics, PointF location, float width, float height)
Parameters
Type Name Description
PdfGraphics graphics
PointF location

Start location on the page.
System.Single width

Width of the text bounds.
System.Single height

Height of the text bounds.
Remarks

This method is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
//Set text align.
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(graphics, new PointF(0, 0), page.GetClientSize().Width, page.GetClientSize().Height);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
'Set text align
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(graphics, New PointF(0, 0), page.GetClientSize().Width, page.GetClientSize().Height)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Draw(PdfGraphics, RectangleF)

Draws the text on the graphics.

Declaration
public void Draw(PdfGraphics graphics, RectangleF layoutRectangle)
Parameters
Type Name Description
PdfGraphics graphics
RectangleF layoutRectangle

RectangleF structure that specifies the bounds of the text.
Remarks

This method is not supported in WinRT, Windows Phone, Xamarin, Universal Windows Platform and Silverlight.

Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files ";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
//Set text align.
htmlTextElement.TextAlign = TextAlign.Left;
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
htmlTextElement.Draw(graphics, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height));
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET " + "library with the capability to produce Adobe PDF files "
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
'Set text align
htmlTextElement.TextAlign = TextAlign.Left
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
htmlTextElement.Draw(graphics, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height))
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Draw(PdfPage, PointF, Single, PdfLayoutFormat)

Draws the text on the page.

Declaration
public PdfLayoutResult Draw(PdfPage page, PointF location, float width, PdfLayoutFormat format)
Parameters
Type Name Description
PdfPage page

Current page where the text should be drawn.
PointF location

Start location on the page.
System.Single width

Width of the text bounds.
PdfLayoutFormat format

Layout format.
Returns
Type Description
PdfLayoutResult

Layouting result.
Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET library with the capability to produce Adobe PDF files";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
PdfLayoutResult result = htmlTextElement.Draw(page, new PointF(0, 0), page.GetClientSize().Width, format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET library with the capability to produce Adobe PDF files"
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
Dim result As PdfLayoutResult = htmlTextElement.Draw(page, New PointF(0, 0), page.GetClientSize().Width, format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Draw(PdfPage, PointF, Single, Single, PdfLayoutFormat)

Draws the text on the page.

Declaration
public PdfLayoutResult Draw(PdfPage page, PointF location, float width, float height, PdfLayoutFormat format)
Parameters
Type Name Description
PdfPage page

Current page where the text should be drawn.
PointF location

Start location on the page.
System.Single width

Width of the text bounds.
System.Single height

Height of the text bounds.
PdfLayoutFormat format

Layouting format.
Returns
Type Description
PdfLayoutResult

Layouting result.
Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET library with the capability to produce Adobe PDF files"
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
PdfLayoutResult result = htmlTextElement.Draw(page, new PointF(0, 0), page.GetClientSize().Width, page.GetClientSize().Height, format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET library with the capability to produce Adobe PDF files"
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
Dim result As PdfLayoutResult = htmlTextElement.Draw(page, New PointF(0, 0), page.GetClientSize().Width, page.GetClientSize().Height, format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

Draw(PdfPage, RectangleF, PdfLayoutFormat)

Draws the text on the page.

Declaration
public PdfLayoutResult Draw(PdfPage page, RectangleF layoutRectangle, PdfLayoutFormat format)
Parameters
Type Name Description
PdfPage page

Current page where the text should be drawn.
RectangleF layoutRectangle

RectangleF structure that specifies the bounds of the text.
PdfLayoutFormat format

layout format.
Returns
Type Description
PdfLayoutResult

Layout result.
Examples
//Create a new PDF document.
PdfDocument doc = new PdfDocument();
//Add a page to the document.
PdfPage page = doc.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 14);
//Simple HTML content
string htmlText = "Essential PDF is a .NET library with the capability to produce Adobe PDF files";
//Create new PDF HTML text element.
PdfHTMLTextElement htmlTextElement = new PdfHTMLTextElement();
//Set html text.
htmlTextElement.HTMLText = htmlText;
//Set font.
htmlTextElement.Font = font;
//Format Layout.
PdfMetafileLayoutFormat format = new PdfMetafileLayoutFormat();
format.Layout = PdfLayoutType.Paginate;
format.Break = PdfLayoutBreakType.FitPage;
//Draw htmlString to PDF page.
PdfLayoutResult result = htmlTextElement.Draw(page, new RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format);
//Save the document.
doc.Save("Output.pdf");
//Close the document.
doc.Close(true);
'Create a new PDF document.
Dim doc As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = doc.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 14)
'Simple HTML content
Dim htmlText As String = "Essential PDF is a .NET library with the capability to produce Adobe PDF files"
'Create new PDF HTML text element.
Dim htmlTextElement As New PdfHTMLTextElement()
'Set html text.
htmlTextElement.HTMLText = htmlText
'Set font.
htmlTextElement.Font = font
'Format Layout.
Dim format As New PdfMetafileLayoutFormat()
format.Layout = PdfLayoutType.Paginate
format.Break = PdfLayoutBreakType.FitPage
'Draw htmlString to PDF page.
Dim result As PdfLayoutResult = htmlTextElement.Draw(page, New RectangleF(0, 0, page.GetClientSize().Width, page.GetClientSize().Height), format)
'Save the document.
doc.Save("Output.pdf")
'Close the document.
doc.Close(True)

remove_BeginPageLayout(BeginPageLayoutEventHandler)

Declaration
public void remove_BeginPageLayout(BeginPageLayoutEventHandler value)
Parameters
Type Name Description
BeginPageLayoutEventHandler value

remove_EndPageLayout(EndPageLayoutEventHandler)

Declaration
public void remove_EndPageLayout(EndPageLayoutEventHandler value)
Parameters
Type Name Description
EndPageLayoutEventHandler value

Events

BeginPageLayout

Event. Raises before the element should be printed on the page.

Declaration
public event BeginPageLayoutEventHandler BeginPageLayout
Event Type
Type
BeginPageLayoutEventHandler

EndPageLayout

Event. Raises after the element was printed on the page.

Declaration
public event EndPageLayoutEventHandler EndPageLayout
Event Type
Type
EndPageLayoutEventHandler