PdfDocumentProcessor.AddTextMarkupAnnotation(Int32, IEnumerable<PdfOrientedRectangle>, PdfTextMarkupAnnotationType) Method

Creates a text markup annotation at the specified area on the page.

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

C#
VB.NET

csharp

public PdfTextMarkupAnnotationData AddTextMarkupAnnotation(
    int pageNumber,
    IEnumerable<PdfOrientedRectangle> textRectangles,
    PdfTextMarkupAnnotationType style
)

Public Function AddTextMarkupAnnotation(
    pageNumber As Integer,
    textRectangles As IEnumerable(Of PdfOrientedRectangle),
    style As PdfTextMarkupAnnotationType
) As PdfTextMarkupAnnotationData

Parameters

Name	Type	Description
pageNumber	Int32

The number of the page where the annotation should be added.

| | textRectangles | IEnumerable<PdfOrientedRectangle> |

A collection of rectangles that specify a page area where the annotation should be located.

| | style | PdfTextMarkupAnnotationType |

The text markup annotation type.

Returns

Type	Description
PdfTextMarkupAnnotationData

The text markup annotation.

Remarks

This method returns null if the collection of PdfOrientedRectangle objects is empty.