PDFComment
PDF comment object
Instance
Read Only
String commentReviewer
The name of the reviewer who made the comment
Read Only
String commentContent
The content of the comment
Read Only
Date commentDate
The date of the comment
Read Only
CommentTypeEnum commentType
The type of the comment
Read Only
String commentFilePath
The file path of the comment
Read Only
Mixed commentPathGeometry
Path geometry of the comment. Can return: Ordered array containing pathPointArray:Array of Ordered array containing anchor:Array of 2 Reals, leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals, pathOpen:Boolean.
Read Only
CommentStatusEnum commentStatus
The status of the comment
Read Only
Boolean commentIsOrphan
Whether the comment is an orphan
Read Only
Boolean commentIsApplied
Whether the comment has been applied
Read Only
Number id
The unique ID of the PDFComment.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Document parent
The parent of the PDFComment (a Document).
Read Only
Number index
The index of the PDFComment within its containing object.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
Read Only
Replies replies
A collection of reply objects
String label
A property that can be set to any string.
String name
The name of the PDFComment; this is an alias to the PDFComment's label property.
Object properties
A property that allows setting of several properties at the same time.
Methods
remove()
Deletes the PDFComment.
changeStatus( CommentStatusEnum commentStatus, Object withProperties )
Change the status of a comment
Parameters
Type Name Description
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the PDFComment.
PDFComment getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description