PdfDocumentProcessor.AddTextMarkupAnnotation(Int32, PdfOrientedRectangle, PdfTextMarkupAnnotationType) Method

Creates a text markup annotation at the specified page area.

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(
    int pageNumber,
    PdfOrientedRectangle textRectangle,
    PdfTextMarkupAnnotationType style
)

VB.NET

Public Function AddTextMarkupAnnotation(
    pageNumber As Integer,
    textRectangle As PdfOrientedRectangle,
    style As PdfTextMarkupAnnotationType
) As PdfTextMarkupAnnotationData

Parameters

Name	Type	Description
pageNumber	Int32	The number of the page where the annotation should be added.
textRectangle	PdfOrientedRectangle	A rectangle that specifies a page area where the annotation should be located.
style	PdfTextMarkupAnnotationType	The text markup annotation type.

Returns

Type	Description
PdfTextMarkupAnnotationData	A text markup annotation.

Remarks

If a specified page area does not contain text, the AddTextMarkupAnnotation method returns null.

Related GitHub Examples

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

C#

pdf-document-api-highlight-search-results/CS/HighlightSearchResults/Program.cs#L62

PdfTextMarkupAnnotationData annotation =
processor.AddTextMarkupAnnotation(result.PageNumber, result.Rectangles[i], PdfTextMarkupAnnotationType.Highlight);
if (annotation != null)

VB.NET

pdf-document-api-highlight-search-results/VB/HighlightSearchResults/Program.vb#L50

For i As Integer = 0 To result.Rectangles.Count - 1
    Dim annotation As PdfTextMarkupAnnotationData = processor.AddTextMarkupAnnotation(result.PageNumber, result.Rectangles(i), PdfTextMarkupAnnotationType.Highlight)
    If annotation IsNot Nothing Then