How to: Create a Text Markup Annotation and Specify its Properties

• Jun 20, 2018
• 2 minutes to read

This example shows how to create a markup annotation that highlights a selected text. To create this annotation for a selected text, call one of the PdfViewerControl.HighlightSelectedText overload methods.

To specify the annotation properties when the markup annotation is being created, handle the PdfViewerControl.TextMarkupAnnotationCreating event.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-a-text-markup-annotation-and-specify-its-properties-t574531.

MainWindow.xaml.cs

using System.Windows;
using DevExpress.Pdf;
using DevExpress.Xpf.PdfViewer;

namespace MarkupAnnotations {

    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();

            // Load a document.
            viewer.OpenDocument("..\\..\\Demo.pdf");

            // Handle the TextMarkupAnnotationCreating event to specify the annotation properties.
            viewer.TextMarkupAnnotationCreating += Viewer_TextMarkupAnnotationCreating;

        }

        private void Viewer_TextMarkupAnnotationCreating(DependencyObject d, PdfTextMarkupAnnotationCreatingEventArgs e) {
            e.Author = "John Smith";
            e.Comment = "Note.";
            e.Color = System.Windows.Media.Color.FromRgb(229, 214, 0);
        }

        private void viewer_DocumentLoaded(object sender, RoutedEventArgs e) {

            // Select the document area where the markup annotation will be created.
            viewer.Select(new PdfDocumentArea(1, new PdfRectangle(90, 100, 240, 230)));

            // Highlight a selected text.
            viewer.HighlightSelectedText();
        }
    }
}

MainWindow.xaml

<Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:MarkupAnnotations"
        xmlns:dxpdf="http://schemas.devexpress.com/winfx/2008/xaml/pdf" x:Class="MarkupAnnotations.MainWindow"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
    <Grid>

        <dxpdf:PdfViewerControl x:Name="viewer" DocumentLoaded="viewer_DocumentLoaded"/>

    </Grid>
</Window>

MainWindow.xaml.vb

Imports System.Windows
Imports DevExpress.Pdf
Imports DevExpress.Xpf.PdfViewer

Namespace MarkupAnnotations

    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()

            ' Load a document.
            viewer.OpenDocument("..\..\Demo.pdf")

            ' Handle the TextMarkupAnnotationCreating event to specify the annotation properties.
            AddHandler viewer.TextMarkupAnnotationCreating, AddressOf Viewer_TextMarkupAnnotationCreating

        End Sub

        Private Sub Viewer_TextMarkupAnnotationCreating(ByVal d As DependencyObject, ByVal e As PdfTextMarkupAnnotationCreatingEventArgs)
            e.Author = "John Smith"
            e.Comment = "Note."
            e.Color = System.Windows.Media.Color.FromRgb(229, 214, 0)
        End Sub

        Private Sub viewer_DocumentLoaded(ByVal sender As Object, ByVal e As RoutedEventArgs)

            ' Select the document area where the markup annotation will be created.
            viewer.Select(New PdfDocumentArea(1, New PdfRectangle(90, 100, 240, 230)))

            ' Highlight a selected text.
            viewer.HighlightSelectedText()
        End Sub
    End Class
End Namespace