Comment (Aspose.Cells for Java)

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

Methods
Modifier and Type	Method and Description
`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.lang.String`	`getAuthor()` Gets Name of the original comment author
`boolean`	`getAutoSize()` Indicates if size of comment is adjusted automatically according to its content.
`java.util.ArrayList`	`getCharacters()` Deprecated. Use Comment.GetRichFormattings() instead.
`int`	`getColumn()` Gets the column index of the comment.
`CommentShape`	`getCommentShape()` Get a Shape object that represents the shape attached to the specified comment.
`Font`	`getFont()` Gets the font of comment.
`int`	`getHeight()` Represents the Height of the comment, in unit of pixels.
`double`	`getHeightCM()` Represents the height of the comment, in unit of centimeters.
`double`	`getHeightInch()` Represents the height of the comment, in unit of inches.
`java.lang.String`	`getHtmlNote()` Gets the html string which contains data and some formats in this comment.
`java.lang.String`	`getNote()` Represents the content of comment.
`FontSetting[]`	`getRichFormattings()` Returns all Characters objects that represents a range of characters within the comment text.
`int`	`getRow()` Gets the row index of the comment.
`int`	`getTextHorizontalAlignment()` Gets the text horizontal alignment type of the comment.
`int`	`getTextOrientationType()` Gets the text orientation type of the comment.
`int`	`getTextVerticalAlignment()` Gets the text vertical alignment type of the comment.
`ThreadedCommentCollection`	`getThreadedComments()` Gets the list of threaded comments;
`int`	`getWidth()` Represents the width of the comment, in unit of pixels.
`double`	`getWidthCM()` Represents the width of the comment, in unit of centimeters.
`double`	`getWidthInch()` Represents the width of the comment, in unit of inches.
`boolean`	`isThreadedComment()` Indicates whether this comment is a threaded comment.
`boolean`	`isVisible()` Represents if the comment is visible or not.
`void`	`setAuthor(java.lang.String value)` Sets Name of the original comment author
`void`	`setAutoSize(boolean value)` Indicates if size of comment is adjusted automatically according to its content.
`void`	`setHeight(int value)` Represents the Height of the comment, in unit of pixels.
`void`	`setHeightCM(double value)` Represents the height of the comment, in unit of centimeters.
`void`	`setHeightInch(double value)` Represents the height of the comment, in unit of inches.
`void`	`setHtmlNote(java.lang.String value)` Sets the html string which contains data and some formats in this comment.
`void`	`setNote(java.lang.String value)` Represents the content of comment.
`void`	`setTextHorizontalAlignment(int value)` Sets the text horizontal alignment type of the comment.
`void`	`setTextOrientationType(int value)` Sets the text orientation type of the comment.
`void`	`setTextVerticalAlignment(int value)` Sets the text vertical alignment type of the comment.
`void`	`setVisible(boolean value)` Represents if the comment is visible or not.
`void`	`setWidth(int value)` Represents the width of the comment, in unit of pixels.
`void`	`setWidthCM(double value)` Represents the width of the comment, in unit of centimeters.
`void`	`setWidthInch(double value)` Represents the width of the comment, in unit of inches.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAuthor
```
public java.lang.String getAuthor()
```
    Gets Name of the original comment author
    Example
```
 
         comment1.setAuthor("Carl.Yang");
 
```
  - setAuthor
```
public void setAuthor(java.lang.String value)
```
    Sets Name of the original comment author
  - getCommentShape
```
public CommentShape getCommentShape()
```
    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.
         }
 
```
  - getThreadedComments
```
public ThreadedCommentCollection getThreadedComments()
```
    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
```
public java.lang.String getNote()
```
    Represents the content of comment.
    Remarks
    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.");
 
```
  - setNote
```
public void setNote(java.lang.String value)
```
    Represents the content of comment.
    Remarks
    If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
  - getHtmlNote
```
public java.lang.String getHtmlNote()
```
    Gets the html string which contains data and some formats in this comment.
    Remarks
    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>");
 
```
  - setHtmlNote
```
public void setHtmlNote(java.lang.String value)
```
    Sets the html string which contains data and some formats in this comment.
    Remarks
    If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
  - getFont
```
public Font getFont()
```
    Gets the font of comment.
    Example
```
 
         Font font = comment1.getFont();
         font.setSize(12);
 
```
  - formatCharacters
```
public void formatCharacters(int startIndex,
                    int length,
                    Font font,
                    StyleFlag flag)
```
    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.
    Example
```
 
         FontSetting fontSetting = comment1.characters(0, 4);
 
```
    Parameters:
    startIndex - The index of the start of the character.
    length - The number of characters.
    
    Returns:
    Characters object.
  - getCharacters
```
public java.util.ArrayList getCharacters()
```
    Deprecated. Use Comment.GetRichFormattings() instead.
    Returns all Characters objects that represents a range of characters within the comment text.
    Remarks
    NOTE: This method is now obsolete. Instead, please use Comment.GetRichFormattings() method. This method will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.
    Example
```
 
         FontSetting fontSetting = comment1.characters(0, 4);
 
```
    Returns:
    All Characters objects
  - getRichFormattings
```
public FontSetting[] getRichFormattings()
```
    Returns all Characters objects that represents a range of characters within the comment text.
    Example
```
 
         FontSetting[] list = comment1.getRichFormattings();
 
```
    Returns:
    All Characters objects
  - isVisible
```
public boolean isVisible()
```
    Represents if the comment is visible or not.
    Example
```
 
         if(comment1.isVisible())
         {
             //The comment is visible
         }
 
```
  - setVisible
```
public void setVisible(boolean value)
```
    Represents if the comment is visible or not.
  - getTextOrientationType
```
public int getTextOrientationType()
```
    Gets the text orientation type of the comment.
    See TextOrientationType.
    
    Example
```
 
         if(comment1.getTextOrientationType() == TextOrientationType.NO_ROTATION)
         {
             comment1.setTextOrientationType(TextOrientationType.TOP_TO_BOTTOM);
         }
 
```
  - setTextOrientationType
```
public void setTextOrientationType(int value)
```
    Sets the text orientation type of the comment.
    See TextOrientationType.
  - getTextHorizontalAlignment
```
public int getTextHorizontalAlignment()
```
    Gets the text horizontal alignment type of the comment.
    See TextAlignmentType.
    
    Example
```
 
         if (comment1.getTextHorizontalAlignment() ==  TextAlignmentType.FILL)
         {
             comment1.setTextHorizontalAlignment(TextAlignmentType.CENTER);
         }
 
```
  - setTextHorizontalAlignment
```
public void setTextHorizontalAlignment(int value)
```
    Sets the text horizontal alignment type of the comment.
    See TextAlignmentType.
  - getTextVerticalAlignment
```
public int getTextVerticalAlignment()
```
    Gets the text vertical alignment type of the comment.
    See TextAlignmentType.
    
    Example
```
 
         if (comment1.getTextVerticalAlignment() ==  TextAlignmentType.FILL)
         {
             comment1.setTextVerticalAlignment(TextAlignmentType.CENTER);
         }
 
```
  - setTextVerticalAlignment
```
public void setTextVerticalAlignment(int value)
```
    Sets the text vertical alignment type of the comment.
    See TextAlignmentType.
  - getAutoSize
```
public boolean getAutoSize()
```
    Indicates if size of comment is adjusted automatically according to its content. Note: In some special cases (such as Mac environment), this setting may not take effect. If this setting does not take effect, please replace it with FitToTextSize().
    Example
```
 
         if(!comment1.getAutoSize())
         {
             //The size of the comment varies with the content
             comment1.setAutoSize(true);
         }
 
```
  - setAutoSize
```
public void setAutoSize(boolean value)
```
    Indicates if size of comment is adjusted automatically according to its content. Note: In some special cases (such as Mac environment), this setting may not take effect. If this setting does not take effect, please replace it with FitToTextSize().
  - getHeightCM
```
public double getHeightCM()
```
    Represents the height of the comment, in unit of centimeters.
    Example
```
 
         comment1.setHeightCM(1.0);
 
```
  - setHeightCM
```
public void setHeightCM(double value)
```
    Represents the height of the comment, in unit of centimeters.
  - getWidthCM
```
public double getWidthCM()
```
    Represents the width of the comment, in unit of centimeters.
    Example
```
 
         comment1.setWidthCM(1.0);
 
```
  - setWidthCM
```
public void setWidthCM(double value)
```
    Represents the width of the comment, in unit of centimeters.
  - getWidth
```
public int getWidth()
```
    Represents the width of the comment, in unit of pixels.
    Example
```
 
         comment1.setWidth(10);
 
```
  - setWidth
```
public void setWidth(int value)
```
    Represents the width of the comment, in unit of pixels.
  - getHeight
```
public int getHeight()
```
    Represents the Height of the comment, in unit of pixels.
    Example
```
 
         comment1.setHeight(10);
 
```
  - setHeight
```
public void setHeight(int value)
```
    Represents the Height of the comment, in unit of pixels.
  - getWidthInch
```
public double getWidthInch()
```
    Represents the width of the comment, in unit of inches.
    Example
```
 
         comment1.setWidthInch(1.0);
 
```
  - setWidthInch
```
public void setWidthInch(double value)
```
    Represents the width of the comment, in unit of inches.
  - getHeightInch
```
public double getHeightInch()
```
    Represents the height of the comment, in unit of inches.
    Example
```
 
         comment1.setHeightInch(1.0);
 
```
  - setHeightInch
```
public void setHeightInch(double value)
```
    Represents the height of the comment, in unit of inches.

Class Comment

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAuthor

setAuthor

getCommentShape

getRow

getColumn

isThreadedComment

getThreadedComments

getNote

setNote

getHtmlNote

setHtmlNote

getFont

formatCharacters

characters

getCharacters

getRichFormattings

isVisible

setVisible

getTextOrientationType

setTextOrientationType

getTextHorizontalAlignment

setTextHorizontalAlignment

getTextVerticalAlignment

setTextVerticalAlignment

getAutoSize

setAutoSize

getHeightCM

setHeightCM

getWidthCM

setWidthCM

getWidth

setWidth

getHeight

setHeight

getWidthInch

setWidthInch

getHeightInch

setHeightInch