Comment Object

Existing Comment objects can be obtained through commands like Document.allComments and Text.commentsAtIndex.

Comment Type Commands

Comment.add v2.1

Adds a new empty comment to the active selection in the current document. Returns the just added Comment object. Note: you can modify the contents of the added comment using its text property.

Comment.addToText text, range v2.1

Adds a new empty comment to the given Range object in the given text. Returns the just added Comment object. Note: you can modify the contents of the added comment using its text property.

Comment Object Properties

.authorName v2.0

Returns a string holding the name of the author that made the comment. Read-only.

.authorColor v2.0

Returns the Color object used to highlight the comment markings and comment text area, based on the user’s appearance preferences. Read-only.

.dateCreated v2.0

Returns a Date object that specifies when the comment was created/added. Read-only.

.dateModified v2.0

Returns a Date object that specifies when the comment was last modified/edited. Read-only.

.text v2.0

Returns the Text object that holds the contents of the comment.

Note: the returned text object follows reference semantics, eg: changes to it will change the contents of the comment itself.

.markedText v2.0

Returns the main document body Text object to which the comment is applied. If the comment is not currently in a document this returns the @undefined value. Read-only.

Note: the returned text object follows reference semantics, eg: changes to it will change the contents of the document itself.

.markedTextRange v2.0

Returns a Range object that specifies where in the document text object the comment has been applied. If the comment is not currently in a document, this returns the @undefined value. Read-only.

Comment Object Commands

.remove v2.1

Removes the comment from whatever text it is applied to.