PdfDocumentProcessor.AddTextMarkupAnnotation(PdfDocumentPosition, PdfDocumentPosition, PdfTextMarkupAnnotationType) Method

Creates a text markup annotation for text located between the specified positions on the page.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v20.2.dll

NuGet Package: DevExpress.Document.Processor

NuGet Packages: DevExpress.Document.Processor, DevExpress.WindowsDesktop.Document.Processor

Declaration

C#

public PdfTextMarkupAnnotationData AddTextMarkupAnnotation(
    PdfDocumentPosition startPosition,
    PdfDocumentPosition endPosition,
    PdfTextMarkupAnnotationType style
)

VB.NET

Public Function AddTextMarkupAnnotation(
    startPosition As PdfDocumentPosition,
    endPosition As PdfDocumentPosition,
    style As PdfTextMarkupAnnotationType
) As PdfTextMarkupAnnotationData

Parameters

Name	Type	Description
startPosition	PdfDocumentPosition	The start point of a page area that should be annotated.
endPosition	PdfDocumentPosition	The end point of a page area that should be annotated.
style	PdfTextMarkupAnnotationType	The text markup annotation type.

Returns

Type	Description
PdfTextMarkupAnnotationData	The text markup annotation.

Remarks

If a specified page area does not contain text, the annotation is not created and the method returns null.

Example

The code sample below highlights text with blue and adds a sticky note at the page corner.

C#

using DevExpress.Pdf;
//...
using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    //Load a document:
    processor.LoadDocument("..\\..\\Document.pdf");

    //Add a text markup annotation at the first page:
    PdfTextMarkupAnnotationData textMarkup =
    processor.AddTextMarkupAnnotation(1, new PdfRectangle(90, 100, 240, 230),
    PdfTextMarkupAnnotationType.Highlight);

    if (textMarkup != null)
    {
        //Specify the annotation properties:
        textMarkup.Author = "Bill Smith";
        textMarkup.Contents = "Important!";
        textMarkup.Color = new PdfRGBColor(0.8, 0.2, 0.1);
    }

    //Add a sticky note at the first page:
    PdfTextAnnotationData textAnnotation =
    processor.AddTextAnnotation(1, new PdfPoint(100, 300));

    //Specify the annotation parameters:
    textAnnotation.Author = "Nancy Davolio";
    textAnnotation.Checked = true;
    textAnnotation.Color = new PdfRGBColor(0.8, 0.2, 0.1);
    textAnnotation.Contents = "Please proofread this document";
    textAnnotation.IconName = PdfTextAnnotationIconName.Check;

    //Save the result:
    processor.SaveDocument("..\\..\\Result.pdf");
}

VB.NET

Imports DevExpress.Pdf
'...
Using processor As New PdfDocumentProcessor()

    'Load a document:
    processor.LoadDocument("..\..\Document.pdf")

    'Add a text markup annotation on the first page:
    Dim textMarkup As PdfTextMarkupAnnotationData =
    processor.AddTextMarkupAnnotation(1, New PdfRectangle(90, 100, 240, 230), 
    PdfTextMarkupAnnotationType.Highlight)

    If textMarkup IsNot Nothing Then
        'Specify the annotation properties:
        textMarkup.Author = "Bill Smith"
        textMarkup.Contents = "Important!"
        textMarkup.Color = New PdfRGBColor(0.8, 0.2, 0.1)
    End If


    'Add a sticky note at the first page:
    Dim textAnnotation As PdfTextAnnotationData =
    processor.AddTextAnnotation(1, New PdfPoint(100, 300))

    'Specify the annotation parameters:
    textAnnotation.Author = "Nancy Davolio"
    textAnnotation.Checked = True
    textAnnotation.Color = New PdfRGBColor(0.8, 0.2, 0.1)
    textAnnotation.Contents = "Please proofread this document"
    textAnnotation.IconName = PdfTextAnnotationIconName.Check

    'Save the result:
    processor.SaveDocument("..\..\Result.pdf")
End Using

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddTextMarkupAnnotation(PdfDocumentPosition, PdfDocumentPosition, PdfTextMarkupAnnotationType) 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.

VB.NET

pdf-document-api-manage-annotations-in-document/VB/CreateMarkupAnnotation/Program.vb#L26

Dim endPosition As PdfDocumentPosition = New PdfDocumentPosition(1, New PdfPoint(272, 207))
Dim textMarkupAnnotation As PdfTextMarkupAnnotationData = processor.AddTextMarkupAnnotation(startPosition, endPosition, PdfTextMarkupAnnotationType.Highlight)
If textMarkupAnnotation IsNot Nothing Then