FormattedTextArea

The FormattedTextArea class allows formatting within a paragraph of text using common and familiar HTML-style tagging. The FormattedTextArea is not designed to support full HTML tags but it will accept the following HTML tags and attributes. Some of the attributes are in addition to the attribute found in HTML and are used for advanced paragraph and line properties. Please note that white space can be treated literally or ignored (standard behavior for HTML).

The FormattedTextAreaStyle class internally manages the state of the FormattedTextArea. The style property represents the initial state of the text.

Example

The following example illustrates adding a FormattedTextArea to a PDF document.

Document document = new();
document.Pages.Add(new Page(PageSize.Letter));

string txt = File.ReadAllText("simple-fta.txt");
float pgWdth = doc.Pages[0].Dimensions.Width - document.Pages[0].Dimensions.LeftMargin * 2;

FormattedTextAreaStyle style = new(FontFamily.Helvetica, 12, false);
FormattedTextArea fta = new(txt, 0, 0, pgWdth, 0, style);
fta.Height = fta.GetRequiredHeight();
document.Pages[0].Elements.Add(fta);
document.Draw(outputPath);

Dim doc As New Document()
doc.Pages.Add(New Page(PageSize.Letter))
Dim txt As String = File.ReadAllText("simple-fta.txt")
Dim pgWdth As Single = doc.Pages(0).Dimensions.Width - doc.Pages(0).Dimensions.LeftMargin * 2
Dim style As New FormattedTextAreaStyle(FontFamily.Helvetica, 12, False)
Dim fta As New FormattedTextArea(txt, 0, 0, pgWdth, 0, style)
fta.Height = fta.GetRequiredHeight()
doc.Pages(0).Elements.Add(fta)
doc.Draw(outputPath)

Bold Tag

<B.. tag - Enclosed text is bold.

Font Tag

<Font ... tag - For font attributes.

Italics Tag

<I ... tag - Enclosed text is italics.

Enclosed text is italic.

Line Tag

<Line ... tag - Enclosed text is lined.

Paragraph Tag

Attribute Values Description Align left | right | center | justify Alignment of the paragraph's text. AllowOrphanLines true | false Specifies if one orphaned line on a page has to be carried to the next page by itself or it will be carried along with the previous line to make it two lines on the next page. Indent A decimal value. The first line indentation of the paragraph in points. LeftIndent A decimal value. The left indentation of the paragraph in points. PreserveWhiteSpace true | false Specifies if white space should be preserved. RightIndent A decimal value. The right indentation of the paragraph in points. SpacingAfter A decimal value. The spacing after the paragraph in points. SpacingBefore A decimal value. The spacing before the paragraph in points.

Subscript Tag

<SUB ... tag - For subscript attributes.

Superscript Tag

<SUP ... tag - For superscript attributes.

Underline Tag

<U ... tag - Enclosed text is underlined.

Break Tag

<BR ...tag - Inserts a single line break.