Annotations Property

Summary

Gets a list of the annotations found on this page.

Syntax

C++

Java

public IList<PDFAnnotation> Annotations {get;}

Public ReadOnly Property Annotations As IList(Of PDFAnnotation)

public List<PDFAnnotation> getAnnotations()

public: 
property IList<PDFAnnotation^>^ Annotations { 
   IList<PDFAnnotation^>^ get(); 
}

Property Value

An IList of PDFAnnotation items that contain the annotations found in the page. The default value is null.

Remarks

By default, the Annotations, Objects, FormFields, Signatures and Hyperlinks lists are not populated when a new PDFDocument is created and the values of these properties are null. You must call the PDFDocument.ParsePages method to parse the items are you interested in (depending on the PDFParsePagesOptions passed as the options parameter to the method). This is done for performance reasons and to give the user the ability to parse only the objects and pages of interest.

The Annotations list will be populated if PDFParsePagesOptions.Annotations is passed as part of the options parameter to PDFDocument.ParsePages. After this method returns, all the pages parsed will have their Annotations properties populated either with a list of the annotations found in the page or an empty list (with IList.Count equal to 0).

When parsing is finished, the Annotations property will contain a list of the PDFAnnotation items found in the page.

Example

For an example on general parsing of PDF pages, refer to PDFDocumentPage, for an example on drawing the objects of a page on the surface of an image, refer to PDFObject.

Requirements

Target Platforms

Reference

PDFDocumentPage Class

PDFDocumentPage Members

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies