Comment
Comment class
Encapsulates the object that represents a cell comment.
Properties
| Name | Type | Description |
|---|---|---|
| Author | String | Gets and sets Name of the original comment author |
| CommentShape | CommentShape | Get a Shape object that represents the shape attached to the specified comment. |
| Row | Number | Gets the row index of the comment. |
| Column | Number | Gets the column index of the comment. |
| IsThreadedComment | boolean | Indicates whether this comment is a threaded comment. |
| ThreadedComments | ThreadedCommentCollection | Gets the list of threaded comments; |
| Note | String | Represents the content of comment. If this is a threaded comment, the note could not be changed, otherwise MS Excel coul |
| HtmlNote | String | Gets and sets the html string which contains data and some formats in this comment. If this is a threaded comment, the n |
| Font | Font | Gets the font of comment. |
| IsVisible | boolean | Represents if the comment is visible or not. |
| TextOrientationType | Number | Gets and sets the text orientation type of the comment. The value of the property is TextOrientationType integer constan |
| TextHorizontalAlignment | Number | Gets and sets the text horizontal alignment type of the comment. The value of the property is TextAlignmentType integer |
| TextVerticalAlignment | Number | Gets and sets the text vertical alignment type of the comment. The value of the property is TextAlignmentType integer co |
| AutoSize | boolean | Indicates if size of comment is adjusted automatically according to its content. |
| HeightCM | Number | Represents the height of the comment, in unit of centimeters. |
| WidthCM | Number | Represents the width of the comment, in unit of centimeters. |
| Width | Number | Represents the width of the comment, in unit of pixels. |
| Height | Number | Represents the Height of the comment, in unit of pixels. |
| WidthInch | Number | Represents the width of the comment, in unit of inches. |
| HeightInch | Number | Represents the height of the comment, in unit of inches. |
Methods
| Name | Description |
|---|---|
| formatCharacters | Format some characters with the font setting. |
| characters | Returns a Characters object that represents a range of characters within the comment text. |
| getRichFormattings | Returns all Characters objects that represents a range of characters within the comment text. |
Comment.Author property
Gets and sets Name of the original comment author
Type: String
Comment.CommentShape property
Get a Shape object that represents the shape attached to the specified comment.
Type: CommentShape
Comment.Row property
Gets the row index of the comment.
Type: Number
Comment.Column property
Gets the column index of the comment.
Type: Number
Comment.IsThreadedComment property
Indicates whether this comment is a threaded comment.
Type: boolean
Comment.ThreadedComments property
Gets the list of threaded comments;
Type: ThreadedCommentCollection
Comment.Note property
Represents the content of comment. If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
Type: String
Comment.HtmlNote property
Gets and sets the html string which contains data and some formats in this comment. If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
Type: String
Comment.Font property
Gets the font of comment.
Type: Font
Comment.IsVisible property
Represents if the comment is visible or not.
Type: boolean
Comment.TextOrientationType property
Gets and sets the text orientation type of the comment. The value of the property is TextOrientationType integer constant.
Type: Number
Comment.TextHorizontalAlignment property
Gets and sets the text horizontal alignment type of the comment. The value of the property is TextAlignmentType integer constant.
Type: Number
Comment.TextVerticalAlignment property
Gets and sets the text vertical alignment type of the comment. The value of the property is TextAlignmentType integer constant.
Type: Number
Comment.AutoSize property
Indicates if size of comment is adjusted automatically according to its content.
Type: boolean
Comment.HeightCM property
Represents the height of the comment, in unit of centimeters.
Type: Number
Comment.WidthCM property
Represents the width of the comment, in unit of centimeters.
Type: Number
Comment.Width property
Represents the width of the comment, in unit of pixels.
Type: Number
Comment.Height property
Represents the Height of the comment, in unit of pixels.
Type: Number
Comment.WidthInch property
Represents the width of the comment, in unit of inches.
Type: Number
Comment.HeightInch property
Represents the height of the comment, in unit of inches.
Type: Number
formatCharacters(startIndex, length, font, flag)
Format some characters with the font setting.
| Parameter | Type | Description |
|---|---|---|
| startIndex | Number | The start index. |
| length | Number | The length. |
| font | Font | The font setting. |
| flag | StyleFlag | The flag of the font setting. |
characters(startIndex, length)
Returns a Characters object that represents a range of characters within the comment text.
| Parameter | Type | Description |
|---|---|---|
| startIndex | Number | The index of the start of the character. |
| length | Number | The number of characters. |
Returns: Characters object.
getRichFormattings()
Returns all Characters objects that represents a range of characters within the comment text.
Returns: All Characters objects