How to: Specify the Text Markup Annotation Properties When the Annotation is being Created

• Mar 27, 2019
• 2 minutes to read

Note

The complete sample project is available at https://github.com/DevExpress-Examples/how-to-specify-text-markup-annotation

This example demonstrates how to specify the text markup annotation properties when the annotation is being created in a document.

To add a markup to text:

• Select the text;

• Right-click the text and choose Highlight, Strikethrough or Underline item in the invoked context menu.

  

When the text markup annotation is being created in a document, the PdfViewer.TextMarkupAnnotationCreating event is raised. In this event, you can specify the annotation properties (for example, the default color used to underline a text using the PdfTextMarkupAnnotationCreatingEventArgs.Color property as shown in the code below).

You can see properties applied to a newly created annotation in the Annotation Properties dialog.

To open this dialog, right-click the annotation and choose the Properties… item in the context menu.

The Annotation Properties dialog is shown below.

The following code shows how to handle the PdfViewer.TextMarkupAnnotationCreating event.

C#

using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraPdfViewer;

namespace SpecifyAnnotationProperties {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();

            // Load a document.
            pdfViewer1.LoadDocument("..\\..\\Demo.pdf");

            // Handle the TextMarkupAnnotationCreating event to specify the text markup annotation properties when the annotation is being created. 
            pdfViewer1.TextMarkupAnnotationCreating += pdfViewer1_TextMarkupAnnotationCreating;
        }

        private void pdfViewer1_TextMarkupAnnotationCreating(object sender, PdfTextMarkupAnnotationCreatingEventArgs e) {
            e.Author = "John Smith";
            e.Comment = "Note.";
            e.Color = Color.Gold;
        }
    }
}

VB.NET

Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraPdfViewer

Namespace SpecifyMarkupAnnotationProperties
    Public Partial Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            pdfViewer1.LoadDocument("..\..\Demo.pdf")
            pdfViewer1.TextMarkupAnnotationCreating += AddressOf pdfViewer1_TextMarkupAnnotationCreating
        End Sub

        Private Sub pdfViewer1_TextMarkupAnnotationCreating(ByVal sender As Object, ByVal e As PdfTextMarkupAnnotationCreatingEventArgs)
            e.Author = "John Smith"
            e.Comment = "Note."
            e.Color = Color.Gold
        End Sub
    End Class
End Namespace