PdfTextMarkupAnnotationCreatingEventArgs.Comment Property

Specifies text to be displayed when the markup annotation’s popup window is opened over a page.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v19.1.dll

Declaration

C#

public string Comment { get; set; }

VB.NET

Public Property Comment As String

Property Value

Type	Description
String	A String value that specifies text to be displayed when the markup annotation’s popup window is opened over a page.

Example

This example shows how to create a text markup annotation that highlights a selected text.

C#

using System.Drawing;
using System.Windows.Forms;

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

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

            // Select the document area where the markup annotation will be created.
            pdfViewer1.Select(new RectangleF(-230, 420, 1240, 150));

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

VB.NET

Imports System.Drawing
Imports System.Windows.Forms

Namespace CreateMarkupAnnotation
    Public Partial Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            pdfViewer1.LoadDocument("..\..\Demo.pdf")
            pdfViewer1.[Select](New RectangleF(-230, 420, 1240, 150))
            pdfViewer1.HighlightSelectedText()
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Comment property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-specify-text-markup-annotation/CS/SpecifyTextMarkup/Form1.cs#L19

e.Author = "John Smith";
e.Comment = "Note.";
e.Color = Color.Gold;

VB.NET

how-to-specify-text-markup-annotation/VB/SpecifyTextMarkup/Form1.vb#L21

e.Author = "John Smith"
e.Comment = "Note."
e.Color = Color.Gold