TextAnnotation Class

A text annotation (a “sticky note” attached to a point in a document).

Namespace: DevExpress.Docs.Pdf

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

Declaration

C#

public class TextAnnotation :
    MarkupAnnotation

VB.NET

Public Class TextAnnotation
    Inherits MarkupAnnotation

Related API Members

The following members return TextAnnotation objects:

• MarkupAnnotation.AddReply(Page, String, String)
• MarkupAnnotation.AddReview(Page, String, ReviewStatus)

Example

How to: Create a Text Annotation

The following code snippet opens the Invoice.pdf file, adds a TextAnnotation to the first page, and saves the file:

C#

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

TextAnnotation textAnnotation = new TextAnnotation(new RectangleF(85, 405, 20, 20)) {
    Color = Color.Yellow,
    Title = "Brian Zetc",
    Content = "This is an excellent overview."
};
document.Pages[0].Annotations.Add(textAnnotation);

document.Save(new FileStream("Invoice2.pdf", FileMode.Create, FileAccess.Write));
System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo("Invoice2.pdf") { UseShellExecute = true });

VB.NET

Dim fs As FileStream = File.OpenRead("Invoice.pdf")
Dim options As New LoadOptions()
Dim document As New PdfDocument(fs, options)

Dim textAnnotation As New TextAnnotation(New RectangleF(85, 405, 20, 20)) With {
    .Color = Color.Yellow,
    .Title = "Brian Zetc",
    .Content = "This is an excellent overview."
}
document.Pages(0).Annotations.Add(textAnnotation)

Using outputStream As New FileStream("Invoice2.pdf", FileMode.Create, FileAccess.Write)
    document.Save(outputStream)
End Using

Process.Start(New ProcessStartInfo("Invoice2.pdf") With {
    .UseShellExecute = True
})

Implements

ICloneable

Inheritance

Object

BaseAnnotation

MarkupAnnotation

TextAnnotation