FreeTextAnnotation Class

Contains members that manage free text annotations.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public class FreeTextAnnotation :
    MarkupAnnotation

VB.NET

Public Class FreeTextAnnotation
    Inherits MarkupAnnotation

Example

How to: Create a Free Text Annotation

The following code snippet creates two annotations - a text highlight and a free text annotation:

C#

FileStream fs = File.OpenRead("Demo.pdf");
var options = new LoadOptions();
PdfDocument document = new PdfDocument(fs, options);

List<TextSearchInfo> results = document.FindText("external PDF Viewer").ToList();

foreach (var match in results.SelectMany(x => x.Matches)) {
    var rects = match.MatchFragments
        .Select(x => x.Rectangle)
        .ToList();

    TextMarkupAnnotation textMarkupAnnotationCommon = new(rects) {
        Color = PdfColor.Yellow,
        Title = "Brian Zetc",
        Content = "This is a highlight annotation.",
        Type = TextMarkupAnnotationType.Highlight
    };

    document.Pages[match.PageIndex].Annotations.Add(textMarkupAnnotationCommon);

    document.Pages[match.PageIndex].Annotations.Add(new FreeTextAnnotation(new RectangleF(10, 50, 100, 50)) {
        Color = PdfColor.Red,
        Title = "Brian Zetc",
        Content = "This is a free text annotation."
    });
}
document.Save(new FileStream("Demo2.pdf", FileMode.Create, FileAccess.Write));

VB.NET

Dim fs As FileStream = File.OpenRead("Demo.pdf")
Dim options As New LoadOptions()
Dim document As New PdfDocument(fs, options)
Dim results As List(Of TextSearchInfo) =
    document.FindText("external PDF Viewer").ToList()

For Each match In results.SelectMany(Function(x) x.Matches)
    Dim rects = match.MatchFragments _
        .Select(Function(x) x.Rectangle) _
        .ToList()

    Dim textMarkupAnnotationCommon As New TextMarkupAnnotation(rects) With {
        .Color = PdfColor.Yellow,
        .Title = "Brian Zetc",
        .Content = "This is a highlight annotation.",
        .Type = TextMarkupAnnotationType.Highlight
    }

    document.Pages(match.PageIndex).Annotations.Add(textMarkupAnnotationCommon)

    document.Pages(match.PageIndex).Annotations.Add(New FreeTextAnnotation(New RectangleF(10, 50, 100, 50)) With {
        .Color = PdfColor.Red,
        .Title = "Brian Zetc",
        .Content = "This is a free text annotation."
    })
Next
Using outputStream As New FileStream("Demo2.pdf", FileMode.Create, FileAccess.Write)
    document.Save(outputStream)
End Using

Implements

ICloneable

Inheritance

Object

BaseAnnotation

MarkupAnnotation

FreeTextAnnotation