PDFComment

Methods:

addEventListener, changeStatus, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CommentStatusEnum, CommentTypeEnum, Date, EventListeners, Events, Number, Object, Replies, String,

Property Listing

Property	Type	Access	Description
commentContent	String	readonly	The content of the comment
commentDate	Date	readonly	The date of the comment
commentFilePath	String	readonly	The file path of the comment
commentIsApplied	Boolean	readonly	Whether the comment has been applied
commentIsOrphan	Boolean	readonly	Whether the comment is an orphan
commentPathGeometry	Array of Ordered array containing pathPointArray:Ordered array containing anchor:2 Reals Array of leftDirection:2 Reals Array of PathOpen:Boolean Array of rightDirection:2 Reals	readonly	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.
commentReviewer	String	readonly	The name of the reviewer who made the comment
commentStatus	CommentStatusEnum CommentStatusEnum.OPEN_STATUS CommentStatusEnum.RESOLVED_STATUS	readonly	The status of the comment
commentType	CommentTypeEnum CommentTypeEnum.ARROW_TYPE CommentTypeEnum.CLOUD_TYPE CommentTypeEnum.CONNECTED_LINES_TYPE CommentTypeEnum.FREEFORM_DRAWING_TYPE CommentTypeEnum.HIGHLIGHT_TEXT_TYPE CommentTypeEnum.INSERT_TEXT_TYPE CommentTypeEnum.INVALID_COMMENT_TYPE CommentTypeEnum.LINE_SEGMENT_TYPE CommentTypeEnum.OVAL_TYPE CommentTypeEnum.POLYGON_TYPE CommentTypeEnum.RECTANGLE_TYPE CommentTypeEnum.REPLACE_TEXT_TYPE CommentTypeEnum.SQUIGGLY_TEXT_TYPE CommentTypeEnum.STAMP_TYPE CommentTypeEnum.STICKY_NOTE_TYPE CommentTypeEnum.STRIKETHROUGH_TEXT_TYPE CommentTypeEnum.TEXT_BOX_TYPE CommentTypeEnum.TEXT_CALLOUT_TYPE CommentTypeEnum.TEXT_TYPEWRITER_TYPE CommentTypeEnum.UNDERLINE_TEXT_TYPE	readonly	The type of the comment
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	Number	readonly	The unique ID of the PDFComment.
index	Number	readonly	The index of the PDFComment within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the PDFComment; this is an alias to the PDFComment's label property.
parent	Document	readonly	The parent of the PDFComment (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
replies	Replies Reply	readonly	A collection of reply objects

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined changeStatus (commentStatus:CommentStatusEnum, withProperties:Object)

Change the status of a comment

Parameter	Type	Description
commentStatus	CommentStatusEnum CommentStatusEnum.OPEN_STATUS CommentStatusEnum.RESOLVED_STATUS	The new status of the comment
withProperties	Object	Initial values for properties of the new PDFComment (Optional)

Parameter

Type

Description

commentStatus

CommentStatusEnum

CommentStatusEnum.OPEN_STATUS

CommentStatusEnum.RESOLVED_STATUS

The new status of the comment

withProperties

Object

Initial values for properties of the new PDFComment (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

PDFComment getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined remove ()

Deletes the PDFComment.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean