PdfDocumentProcessor.AddTextMarkupAnnotation(Int32, IEnumerable<PdfOrientedRectangle>, PdfTextMarkupAnnotationType) Method
Adds a text markup annotation to the specified area on the page.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Docs.v18.2.dll
Declaration
public PdfTextMarkupAnnotationData AddTextMarkupAnnotation(
int pageNumber,
IEnumerable<PdfOrientedRectangle> textRectangles,
PdfTextMarkupAnnotationType style
)
Parameters
Name | Type | Description |
---|---|---|
pageNumber | Int32 | An integer value that specifies the number of the page where the annotation should be added. |
textRectangles | IEnumerable<PdfOrientedRectangle> | A collection of PdfOrientedRectangle objects that represent rectangles specifying a page area where the annotation will be added. |
style | PdfTextMarkupAnnotationType | A PdfTextMarkupAnnotationType enumeration value that specifies the markup annotation type to be added to a page. |
Returns
Type | Description |
---|---|
PdfTextMarkupAnnotationData | A PdfTextMarkupAnnotationData object that represents the created text markup annotation on a page. |
Remarks
After creating a text markup annotation, you can specify the markup annotation using properties of the PdfTextMarkupAnnotationData class.
This method creates a text markup annotation for the specified page area. This method returns null if the collection of PdfOrientedRectangle objects is empty.