Object

PDFComment

PDF comment object

Hierarchy

PDFComment

Properties

Type	Access	Description
String	readonly	The content of the comment
Date	readonly	The date of the comment
String	readonly	The file path of the comment
Boolean	readonly	Whether the comment has been applied
Boolean	readonly	Whether the comment is an orphan
Array[] \| 2 Reals[] \| Boolean[] \| 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.
String	readonly	The name of the reviewer who made the comment
CommentStatusEnum	readonly	The status of the comment
CommentTypeEnum +8 more	readonly	The type of the comment
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Number	readonly	The unique ID of the PDFComment.
Number	readonly	The index of the PDFComment within its containing object.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
String	read/write	The name of the PDFComment; this is an alias to the PDFComment's label property.
Document	readonly	The parent of the PDFComment (a Document).
Object	read/write	A property that allows setting of several properties at the same time.
Replies<Reply>	readonly	A collection of reply objects

→ EventListener

Adds an event listener.

eventType String The event type.

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

captures? Boolean This parameter is obsolete.

→ void

Change the status of a comment

commentStatus CommentStatusEnum The new status of the comment

withProperties? Object Initial values for properties of the new PDFComment

→ String

Gets the label value associated with the specified key.

key String The key.

→ PDFComment[]

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

→ void

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

key String The key.

value String The value.

→ void

Deletes the PDFComment.

→ Boolean

Removes the event listener.

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.

→ String

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

→ String

Retrieves the object specifier.

Properties elsewhere that hold a PDFComment.

Method parameters that accept a PDFComment.

Methods that return a PDFComment.