JavaScript is disabled on your browser.
java.lang.Object
com.aspose.cells.Comment
public class Comment extends java.lang.Object
Encapsulates the object that represents a cell comment.
Example:
Workbook workbook = new Workbook();
CommentCollection comments = workbook.getWorksheets().get(0).getComments();
//Add comment to cell A1
int commentIndex1 = comments.add(0, 0);
Comment comment1 = comments.get(commentIndex1);
comment1.setNote("First note.");
comment1.getFont().setName("Times New Roman");
//Add comment to cell B2
comments.add("B2");
Comment comment2 = comments.get("B2");
comment2.setNote("Second note.");
//do your business
//Save the excel file.
workbook.save("exmaple.xlsx");
Method Summary
FontSetting
characters (int startIndex, int length)
Returns a Characters object that represents a range of characters within the comment text.
void
formatCharacters (int startIndex, int length, Font font, StyleFlag flag)
Format some characters with the font setting.
java.util.ArrayList
getCharacters ()
Returns all Characters objects
that represents a range of characters within the comment text.
Property Getters/Setters Detail
getAuthor/setAuthor
public java.lang.String getAuthor () / public void setAuthor (java.lang.String value)
Gets and sets Name of the original comment author
Example:
comment1.setAuthor("Carl.Yang");
Get a Shape object that represents the shape attached to the specified comment.
Example:
CommentShape shape = comment1.getCommentShape();
int w = shape.getWidth();
int h = shape.getHeight();
getRow
public int getRow ()
Gets the row index of the comment.
Example:
int row = comment1.getRow();
getColumn
public int getColumn ()
Gets the column index of the comment.
Example:
int column = comment1.getColumn();
isThreadedComment
public boolean isThreadedComment ()
Indicates whether this comment is a threaded comment.
Example:
if(comment1.isThreadedComment())
{
//This comment is a threaded comment.
}
Gets the list of threaded comments;
Example:
ThreadedCommentCollection threadedComments = comment1.getThreadedComments();
for (int i = 0; i < threadedComments.getCount(); ++i)
{
ThreadedComment tc = threadedComments.get(i);
String note = tc.getNotes();
}
getNote/setNote
public java.lang.String getNote () / public void setNote (java.lang.String value)
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.
Example:
comment1.setNote("First note.");
getHtmlNote/setHtmlNote
public java.lang.String getHtmlNote () / public void setHtmlNote (java.lang.String value)
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.
Example:
comment1.setHtmlNote("<Font Style='FONT-FAMILY: Calibri;FONT-SIZE: 11pt;COLOR: #0000ff;TEXT-ALIGN: left;'>This is a <b>test</b>.</Font>");
getFont
public Font getFont ()
Gets the font of comment.
Example:
Font font = comment1.getFont();
font.setSize(12);
isVisible/setVisible
public boolean isVisible () / public void setVisible (boolean value)
Represents if the comment is visible or not.
Example:
if(comment1.isVisible())
{
//The comment is visible
}
getTextOrientationType/setTextOrientationType
public int getTextOrientationType () / public void setTextOrientationType (int value)
Gets and sets the text orientation type of the comment.
The value of the property is TextOrientationType integer constant. Example:
if(comment1.getTextOrientationType() == TextOrientationType.NO_ROTATION)
{
comment1.setTextOrientationType(TextOrientationType.TOP_TO_BOTTOM);
}
getTextHorizontalAlignment/setTextHorizontalAlignment
public int getTextHorizontalAlignment () / public void setTextHorizontalAlignment (int value)
Gets and sets the text horizontal alignment type of the comment.
The value of the property is TextAlignmentType integer constant. Example:
if (comment1.getTextHorizontalAlignment() == TextAlignmentType.FILL)
{
comment1.setTextHorizontalAlignment(TextAlignmentType.CENTER);
}
getTextVerticalAlignment/setTextVerticalAlignment
public int getTextVerticalAlignment () / public void setTextVerticalAlignment (int value)
Gets and sets the text vertical alignment type of the comment.
The value of the property is TextAlignmentType integer constant. Example:
if (comment1.getTextVerticalAlignment() == TextAlignmentType.FILL)
{
comment1.setTextVerticalAlignment(TextAlignmentType.CENTER);
}
getAutoSize/setAutoSize
public boolean getAutoSize () / public void setAutoSize (boolean value)
Indicates if size of comment is adjusted automatically according to its content.
Example:
if(!comment1.getAutoSize())
{
//The size of the comment varies with the content
comment1.setAutoSize(true);
}
getHeightCM/setHeightCM
public double getHeightCM () / public void setHeightCM (double value)
Represents the height of the comment, in unit of centimeters.
Example:
comment1.setHeightCM(1.0);
getWidthCM/setWidthCM
public double getWidthCM () / public void setWidthCM (double value)
Represents the width of the comment, in unit of centimeters.
Example:
comment1.setWidthCM(1.0);
getWidth/setWidth
public int getWidth () / public void setWidth (int value)
Represents the width of the comment, in unit of pixels.
Example:
comment1.setWidth(10);
getHeight/setHeight
public int getHeight () / public void setHeight (int value)
Represents the Height of the comment, in unit of pixels.
Example:
comment1.setHeight(10);
getWidthInch/setWidthInch
public double getWidthInch () / public void setWidthInch (double value)
Represents the width of the comment, in unit of inches.
Example:
comment1.setWidthInch(1.0);
getHeightInch/setHeightInch
public double getHeightInch () / public void setHeightInch (double value)
Represents the height of the comment, in unit of inches.
Example:
comment1.setHeightInch(1.0);
formatCharacters
public void formatCharacters (int startIndex, int length, Font font, StyleFlag flag)
throws java.lang.Exception
Format some characters with the font setting.
Parameters: startIndex
- The start index.length
- The length.font
- The font setting.flag
- The flag of the font setting.
characters
public FontSetting characters (int startIndex, int length)
Returns a Characters object that represents a range of characters within the comment text.
Parameters: startIndex
- The index of the start of the character.length
- The number of characters.Returns: Characters object. Example:
FontSetting fontSetting = comment1.characters(0, 4);
getCharacters
public java.util.ArrayList getCharacters ()
throws java.lang.Exception
Returns all Characters objects
that represents a range of characters within the comment text.
Returns: All Characters objects Example:
ArrayList list = comment1.getCharacters();
See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.