PdfDocumentProcessor.GetMarkupAnnotationData(Int32) Method

Retrieves all text markup annotations from a page in a PDF document.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public IList<PdfMarkupAnnotationData> GetMarkupAnnotationData(
    int pageNumber
)

VB.NET

Public Function GetMarkupAnnotationData(
    pageNumber As Integer
) As IList(Of PdfMarkupAnnotationData)

Parameters

Name	Type	Description
pageNumber	Int32	The number of a page where the markup annotations are located.

Returns

Type	Description
IList<PdfMarkupAnnotationData>	The annotations retrieved from a page.

Remarks

The GetMarkupAnnotationData method returns all annotations on the page. Use the PdfMarkupAnnotationDataExtensions class methods to retrieve the specified type of annotations.

Example

The code sample below changes the markup style for annotations made by a specific author and changes the icon for all text annotations:

Program.cs

using DevExpress.Pdf;
using System;
using System.Collections.Generic;
//...
private static void EditAnnotations(PdfDocumentProcessor processor)
{
    //Retrieve annotations made by the specified author:
    var textMarkups =
        processor.GetMarkupAnnotationData(1).
        Where(annotation => annotation.Author.Contains("Cardle Anita L"));
    foreach (PdfMarkupAnnotationData markup in textMarkups)
    {
        //Get all text markup annotations from the retrieved list:
        PdfTextMarkupAnnotationData pdfTextMarkup =
         markup.AsTextMarkupAnnotation();
        if (pdfTextMarkup != null)
            //Change the annotation's markup type:
            pdfTextMarkup.MarkupType = PdfTextMarkupAnnotationType.Squiggly;
    }

    var annotations = processor.GetMarkupAnnotationData(1);
    foreach (PdfMarkupAnnotationData annotation in annotations)
    {
        //Get all text annotations:
        PdfTextAnnotationData textAnnotation = annotation.AsTextAnnotation();
        if (textAnnotation != null)

            //Change the annotation icon:
            textAnnotation.IconName = PdfTextAnnotationIconName.Note;
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.Collections.Generic
'...

Private Shared Sub EditAnnotations(ByVal processor As PdfDocumentProcessor)
    'Retrieve annotations made by the specified author:
    Dim textMarkups = processor.GetMarkupAnnotationData(1).Where(Function(annotation) annotation.Author.Contains("Cardle Anita L"))
    For Each markup As PdfMarkupAnnotationData In textMarkups
        'Get all text markup annotations from the retrieved list:
        Dim pdfTextMarkup As PdfTextMarkupAnnotationData = markup.AsTextMarkupAnnotation()
        If pdfTextMarkup IsNot Nothing Then
            'Change the annotation's markup type:
            pdfTextMarkup.MarkupType = PdfTextMarkupAnnotationType.Squiggly
        End If
    Next markup

    Dim annotations = processor.GetMarkupAnnotationData(1)
    For Each annotation As PdfMarkupAnnotationData In annotations
        'Get all text annotations:
        Dim textAnnotation As PdfTextAnnotationData = annotation.AsTextAnnotation()
        If textAnnotation IsNot Nothing Then

            'Change the annotation icon:
            textAnnotation.IconName = PdfTextAnnotationIconName.Note
        End If
    Next annotation
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetMarkupAnnotationData(Int32) 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-document-api-manage-annotations-in-document/CS/CreateMarkupAnnotation/Program.cs#L71

var annotations = processor.GetMarkupAnnotationData(1);
foreach (PdfMarkupAnnotationData annotation in annotations)

VB.NET

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

Dim annotations = processor.GetMarkupAnnotationData(1)
For Each annotation As PdfMarkupAnnotationData In annotations