PdfViewer.AddStickyNote(PdfDocumentPosition, String, Color) Method

Creates a text annotations (sticky note) at the specified document position with the specified comment and color.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v23.2.dll

NuGet Package: DevExpress.Win.PdfViewer

Declaration

C#

public void AddStickyNote(
    PdfDocumentPosition position,
    string comment,
    Color color
)

VB.NET

Public Sub AddStickyNote(
    position As PdfDocumentPosition,
    comment As String,
    color As Color
)

Parameters

Name	Type	Description
position	PdfDocumentPosition	The position of the sticky note on the page.
comment	String	The annotation comment.
color	Color	The annotation color.

Remarks

The AddStickyNote method calls triggers the PdfViewer.AnnotationCreating event.

The code below highlights the selected text and adds a sticky note.

C#

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

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

// Select a text to highlight
pdfViewer.FindText("PDF Viewer");

// Highlight selected text
pdfViewer.HighlightSelectedText();

// Add a sticky note
pdfViewer.AddStickyNote(new PdfDocumentPosition(1, new PdfPoint(29, 568)),
    "Comment", Color.Crimson);

VB.NET

Imports System.Drawing
Imports System.Windows.Forms

' Load a document
pdfViewer.LoadDocument("..\..\Demo.pdf")

' Select a text to highlight
pdfViewer.FindText("PDF Viewer")

' Highlight selected text
pdfViewer.HighlightSelectedText()

pdfViewer.AddStickyNote(New PdfDocumentPosition(1, New PdfPoint(29, 568)), "Comment", Color.Crimson)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddStickyNote(PdfDocumentPosition, String, Color) method.

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#

pdf-viewer-get-page-info/CS/pdf-viewer-sticky-note/Form1.cs#L66

    PdfDocumentPosition stickyNotePosition = new PdfDocumentPosition(1, new PdfPoint(points[0].X, points[0].Y));
    pdfViewer.AddStickyNote(stickyNotePosition, "Note", Color.Yellow);
}

VB.NET

pdf-viewer-get-page-info/VB/pdf-viewer-sticky-note/Form1.vb#L65

    Dim stickyNotePosition As PdfDocumentPosition = New PdfDocumentPosition(1, New PdfPoint(points(0).X, points(0).Y))
    pdfViewer.AddStickyNote(stickyNotePosition, "Note", Color.Yellow)
End Sub