PDFComments

A collection of PDF comment objects

Go to Property Listing | Method Listing

Methods:

[], anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

PDFComment [] (index:Number)

Returns the PDFComment with the specified index.

Parameter	Type	Description
index	Number	The index.

PDFComment anyItem ()

Returns any PDFComment in the collection.

Number count ()

Displays the number of elements in the PDFComment.

PDFComment everyItem ()

Returns every PDFComment in the collection.

PDFComment firstItem ()

Returns the first PDFComment in the collection.

PDFComment item (index:Varies LongInteger String)

Returns the PDFComment with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

PDFComment itemByID (id:Number)

Returns the PDFComment with the specified ID.

Parameter	Type	Description
id	Number	The ID.

PDFComment itemByName (name:String)

Returns the PDFComment with the specified name.

Parameter	Type	Description
name	String	The name.

PDFComment itemByRange (from:Varies LongInteger PDFComment String, to:Varies LongInteger PDFComment String)

Returns the PDFComments within the specified range.

Parameter	Type	Description
from	LongInteger PDFComment String	The PDFComment, index, or name at the beginning of the range. Can accept: PDFComment, Long Integer or String.
to	LongInteger PDFComment String	The PDFComment, index, or name at the end of the range. Can accept: PDFComment, Long Integer or String.

Parameter

Type

Description

from

LongInteger

PDFComment

String

The PDFComment, index, or name at the beginning of the range. Can accept: PDFComment, Long Integer or String.

LongInteger

PDFComment

String

The PDFComment, index, or name at the end of the range. Can accept: PDFComment, Long Integer or String.

PDFComment lastItem ()

Returns the last PDFComment in the collection.

PDFComment middleItem ()

Returns the middle PDFComment in the collection.

PDFComment nextItem (obj:PDFComment)

Returns the PDFComment whose index follows the specified PDFComment in the collection.

Parameter	Type	Description
obj	PDFComment	The PDFComment whose index comes before the desired PDFComment.

PDFComment previousItem (obj:PDFComment)

Returns the PDFComment with the index previous to the specified index.

Parameter	Type	Description
obj	PDFComment	The index of the PDFComment that follows the desired PDFComment.

String toSource ()

Generates a string which, if executed, will return the PDFComment.

Object of

Document.pdfComments