officefileapi-devexpress-dot-pdf-dot-pdfpagefacade-dot-addcaretannotation-x28-devexpress-dot-pdf-dot-pdfrectangle-x29.md
Creates a caret annotation in the specified page rectangle.
Namespace : DevExpress.Pdf
Assembly : DevExpress.Pdf.v25.2.Core.dll
NuGet Package : DevExpress.Pdf.Core
public PdfCaretAnnotationFacade AddCaretAnnotation(
PdfRectangle rect
)
Public Function AddCaretAnnotation(
rect As PdfRectangle
) As PdfCaretAnnotationFacade
| Name | Type | Description |
|---|---|---|
| rect | PdfRectangle |
A page area to add the caret annotation.
|
| Type | Description |
|---|---|
| PdfCaretAnnotationFacade |
An object that contains caret annotation properties.
|
The code sample below adds a caret annotation to the Xbox phrase:
using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
// Load a document
processor.LoadDocument("..\\..\\Document.pdf");
// Access the first page properties
PdfPageFacade pageFacade = processor.DocumentFacade.Pages[0];
// Find the target phrase in the document
string caretText = "Xbox";
PdfTextSearchResults caretSearchResults = processor.FindText(caretText);
if (caretSearchResults.Status == PdfTextSearchStatus.Found)
{
// Create a caret annotation
PdfCaretAnnotationFacade caretAnnotation =
pageFacade.AddCaretAnnotation(caretSearchResults.Rectangles[0].BoundingRectangle);
caretAnnotation.Author = "Brian Zetc";
caretAnnotation.Contents = "Trademark is missing";
}
// Save the result
processor.SaveDocument("..\\..\\Result.pdf");
}
Using processor As New PdfDocumentProcessor()
' Load a document
processor.LoadDocument("..\..\Document.pdf")
' Access the first page properties
Dim pageFacade As PdfPageFacade = processor.DocumentFacade.Pages(0)
' Find the target phrase in the document
Dim caretText As String = "Xbox"
Dim caretSearchResults As PdfTextSearchResults = processor.FindText(caretText)
If caretSearchResults.Status = PdfTextSearchStatus.Found Then
' Create a caret annotation
Dim caretAnnotation As PdfCaretAnnotationFacade = pageFacade.AddCaretAnnotation(caretSearchResults.Rectangles(0).BoundingRectangle)
caretAnnotation.Author = "Brian Zetc"
caretAnnotation.Contents = "Trademark is missing"
End If
' Save the result
processor.SaveDocument("..\..\Result.pdf")
End Using
See Also