com.aspose.cells
Class Comment

java.lang.Object
    com.aspose.cells.Comment

public class Comment 
extends java.lang.Object

Workbook workbook = new Workbook();
CommentCollection comments = workbook.getWorksheets().get(0).getComments();

//Add comment to cell A1
int commentIndex = comments.add(0, 0);
Comment comment = comments.get(commentIndex);
comment.setNote("First note.");
comment.getFont().setName("Times New Roman");

//Add comment to cell B2
comments.add("B2");
comment = comments.get("B2");
comment.setNote("Second note.");

public java.lang.String getAuthor() / public void setAuthor(java.lang.String value)

Gets and sets Name of the original comment author

public void setAuthor(java.lang.String value)

public CommentShape getCommentShape()

Get a Shape object that represents the shape attached to the specified comment.

public int getRow()

Gets the row index of the comment.

public int getColumn()

Gets the column index of the comment.

public boolean isThreadedComment()

Indicates whether this comment is a threaded comment.

public ThreadedCommentCollection getThreadedComments()

Gets the list of threaded comments;

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.

public void setNote(java.lang.String value)

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.

public void setHtmlNote(java.lang.String value)

public Font getFont()

Gets the font of comment.

public boolean isVisible() / public void setVisible(boolean value)

Represents if the comment is visible or not.

public void setVisible(boolean value)

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.

public void setTextOrientationType(int value)

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.

public void setTextHorizontalAlignment(int value)

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.

public void setTextVerticalAlignment(int value)

public boolean getAutoSize() / public void setAutoSize(boolean value)

Indicates if size of comment is adjusted automatically according to its content.

public void setAutoSize(boolean value)

public double getHeightCM() / public void setHeightCM(double value)

Represents the height of the comment, in unit of centimeters.

public void setHeightCM(double value)

public double getWidthCM() / public void setWidthCM(double value)

Represents the width of the comment, in unit of centimeters.

public void setWidthCM(double value)

public int getWidth() / public void setWidth(int value)

Represents the width of the comment, in unit of pixels.

public void setWidth(int value)

public int getHeight() / public void setHeight(int value)

Represents the Height of the comment, in unit of pixels.

public void setHeight(int value)

public double getWidthInch() / public void setWidthInch(double value)

Represents the width of the comment, in unit of inches.

public void setWidthInch(double value)

public double getHeightInch() / public void setHeightInch(double value)

Represents the height of the comment, in unit of inches.

public void setHeightInch(double value)

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.

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.

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