getAnnots

The getAnnots method returns an array of annotation objects according of the searching parameters.

Syntax

getAnnots(System.Int32 nPage, , System.Int32 nSortBy, System.Boolean bReverse, System.Int32 nFilterBy);

Parameters

nPage

[Optional] Page index where the annotation will be searched.  Page Index = Page number -1.  Default value 0.

nSortBy

[Optional] Type of sorting: ANSB_None= Do not sort (Default), ANSB_Page: Sort by page, ANSB_Author: Sort by Author, ANSB_ModDate, Sort by Date of modification, and ANSB_Type: Sort by annotation type.

bReverse

[Optional] To change the sense of the sorting.

nFilterBy

[Optional] Type of Filtering: ANFB_ShouldNone= Do not filter (Default), ANFB_ShouldPrint: Only annotation can be printed, ANFB_ShouldView: Only annotation can be viewed, ANFB_ShouldEdit: Only annotation can be Edited, ANFB_ShouldAppearInPanel: Only annotation of the annotation panel, ANFB_ShouldSummarize: Only annotation included in the summary, and ANFB_ShouldExport: Only annotation can be exported.

Return Value

Returns an Array of Annotation objects, otherwise null.

Remarks

Member of doc.

Example

var annots = this.getAnnots();

for (var i = 0; i < annots.length; i++)

    app.alert("Author:" + annots[i].author + " " + "Type:" + annots[i].type + " " + "Contents:" + annots[i].contents);