Reading Highlight Annotations from PDF Document

Introduction

Aspose.PDF Cloud allows you to read Highlight Annotation information from a PDF Document. Aspose.PDF Cloud provide the following API to achieve this

API Information

API Type Description Swagger Link
/pdf/{name}/annotations/highlight GET Read Document Highlight Annotations GetDocumentHighlightAnnotations
/pdf/{name}/pages/{pageNumber}/annotations/highlight GET Read Document Annotations from a Page in PDF Document GetPageHighlightAnnotations
/pdf/{name}/annotations/highlight/{annotationId} GET Read Annotation by ID GetHighlightAnnotation

cURL Example

We have used PdfWithAnnotations.pdf for the example below. In this example we are demonstration /pdf/{name}/annotations/highlight/{annotationId} resource to read Annotation Information by ID. You can use /pdf/{name}/annotations/highlightor /pdf/{name}/annotations/highlight to get the desired annotation identifier. The above resources return the following Highlight Annotation information for the document


{

   "Annotations":{

      "List":[

         {

            "QuadPoints":[

               {

                  "X":10.0,

                  "Y":10.0

               },

               {

                  "X":20.0,

                  "Y":10.0

               },

               {

                  "X":10.0,

                  "Y":20.0

               },

               {

                  "X":10.0,

                  "Y":10.0

               }

            ],

            "CreationDate":"01/01/0001 12:00:00.000 AM",

            "Subject":"Subj Updated",

            "Title":"Title Updated",

            "RichText":"Rich Text Updated",

            "Color":{

               "A":255,

               "R":0,

               "G":0,

               "B":0

            },

            "Contents":"",

            "Modified":"02/02/2018 12:00:00.000 AM",

            "Id":"GI5TOOZRGAYCYMJQGAWDEMBQFQZDAMA",

            "Flags":[

            ],

            "Name":"Test Text Updated",

            "Rect":{

               "LLX":100.0,

               "LLY":100.0,

               "URX":200.0,

               "URY":200.0

            },

            "PageIndex":2,

            "ZIndex":0,

            "HorizontalAlignment":"Center",

            "VerticalAlignment":"Top",

            "Links":[

               {

                  "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAnnotations.pdf/pages/2/annotations/GI5TOOZRGAYCYMJQGAWDEMBQFQZDAMA",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         }

      ],

      "Links":[

         {

            "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAnnotations.pdf/pages/2/annotations/GI5TOOZRGAYCYMJQGAWDEMBQFQZDAMA",

            "Rel":"self",

            "Type":null,

            "Title":null

         }

      ]

   },
   
   "Code":200,
   "Status":"OK"
}

SDK Source

The Aspose.PDF Cloud SDKs can be downloaded from the following page: Available SDKs

SDK Examples

GetDocumentHighlightAnnotations Example

GetPageHighlightAnnotations Examples

GetHighlightAnnotation Examples