LEADTOOLS PDF (Leadtools.Pdf assembly)
LEAD Technologies, Inc

Annotations Property






Gets a list of the annotations found in this page.
Syntax
public IList<PDFAnnotation> Annotations {get;}
'Declaration
 
Public ReadOnly Property Annotations As IList(Of PDFAnnotation)
'Usage
 
Dim instance As PDFDocumentPage
Dim value As IList(Of PDFAnnotation)
 
value = instance.Annotations
 get_Annotations(); 
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 (Nothing in Visual Basic).
Remarks

By default, the Fonts, Annotations, Objects and Hyperlinks lists are not populated when a new PDFDocument is created and the values of these properties are null (Nothing in Visual Basic). 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<PDFObject>.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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

PDFDocumentPage Class
PDFDocumentPage Members

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.