|
Programmer's Reference >
ExcelApplication API >
Comment
The Comment Object
A Comment object represents a note attached to a cell, or group of merged cells, separate from other cell content. A Comment must be associated with a cell, and may only be created using set Comment.Visible to true.
Comment Properties
| Property |
Type |
Access |
Description |
| Author |
String
|
read
write |
Sets or returns the author of the comment
|
| Cell |
Cell
|
read |
This returns the Cell object that this comment is associated with.
|
| FitToText |
boolean
|
read
write |
Sets or returns whether the comment's shape will be automatically sized to fit the text
|
| HorizontalAlignment |
Style.HAlign
|
read
write |
Sets or returns the horizontal alignment of text within the shape
|
| Shape |
Shape
|
read |
Return a Shape object representing the display area of the comment
|
| Text |
String
|
read
write |
Sets or returns the body text of the comment
|
| VerticalAlignment |
Style.VAlign
|
read
write |
Sets or returns the vertical alignment of text within the shape
|
| Visible |
boolean
|
read
write |
Sets or returns whether the comment will be visible when the document is opened in Excel
|
Comment Methods
| Returns | Signature and Description |
|
void
|
ClearRichTextFormatting ( )
Clears all rich text formatting within the comment
|
|
CharacterRun
|
GetCharacters ( int
startIndex
)
Returns a CharacterRun object representing a range of characters within the comment text
|
|
CharacterRun
|
GetCharacters ( int
startIndex
, int
length
)
Returns a CharacterRun object representing a range of characters within the comment text
|
Copyright 2005 © SoftArtisans, Inc. All Rights Reserved.
|
