asposecells.api

Classes

Constants

Class Comment

Encapsulates the object that represents a cell comment.

Example:

workbook = Workbook()
comments = workbook.getWorksheets().get(0).getComments()

# Add comment to cell A1
commentIndex = comments.add(0, 0)
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.")

Property Getters/Setters Summary
`method`	`getAuthor()`
`method`	`setAuthor(value)`
	Gets and sets Name of the original comment author
`method`	`getAutoSize()`
`method`	`setAutoSize(value)`
	Indicates if size of comment is adjusted automatically according to its content.
`method`	`getColumn()`
	Gets the column index of the comment.
`method`	`getCommentShape()`
	Get a Shape object that represents the shape attached to the specified comment.
`method`	`getFont()`
	Gets the font of comment.
`method`	`getHeight()`
`method`	`setHeight(value)`
	Represents the Height of the comment, in unit of pixels.
`method`	`getHeightCM()`
`method`	`setHeightCM(value)`
	Represents the height of the comment, in unit of centimeters.
`method`	`getHeightInch()`
`method`	`setHeightInch(value)`
	Represents the height of the comment, in unit of inches.
`method`	`getHtmlNote()`
`method`	`setHtmlNote(value)`
	Gets and sets the html string which contains data and some formats in this comment.
`method`	`isThreadedComment()`
	Indicates whether this comment is a threaded comment.
`method`	`isVisible()`
`method`	`setVisible(value)`
	Represents if the comment is visible or not.
`method`	`getNote()`
`method`	`setNote(value)`
	Represents the content of comment.
`method`	`getRow()`
	Gets the row index of the comment.
`method`	`getTextHorizontalAlignment()`
`method`	`setTextHorizontalAlignment(value)`
	Gets and sets the text horizontal alignment type of the comment. The value of the property is TextAlignmentType integer constant.
`method`	`getTextOrientationType()`
`method`	`setTextOrientationType(value)`
	Gets and sets the text orientation type of the comment. The value of the property is TextOrientationType integer constant.
`method`	`getTextVerticalAlignment()`
`method`	`setTextVerticalAlignment(value)`
	Gets and sets the text vertical alignment type of the comment. The value of the property is TextAlignmentType integer constant.
`method`	`getThreadedComments()`
	Gets the list of threaded comments;
`method`	`getWidth()`
`method`	`setWidth(value)`
	Represents the width of the comment, in unit of pixels.
`method`	`getWidthCM()`
`method`	`setWidthCM(value)`
	Represents the width of the comment, in unit of centimeters.
`method`	`getWidthInch()`
`method`	`setWidthInch(value)`
	Represents the width of the comment, in unit of inches.

Method Summary
`method`	`characters(startIndex, length)`
`method`	Returns a Characters object that represents a range of characters within the comment text.
`method`	`formatCharacters(startIndex, length, font, flag)`
`method`	Format some characters with the font setting.
`method`	`getCharacters()`
`method`	Returns all Characters objects that represents a range of characters within the comment text.

- Property Getters/Setters Detail
  - getAuthor/setAuthor : String
```
String getAuthor() / setAuthor(value)
```
    Gets and sets Name of the original comment author
  - getCommentShape : CommentShape
```
CommentShape getCommentShape()
```
    Get a Shape object that represents the shape attached to the specified comment.
  - getRow : int
```
int getRow()
```
    Gets the row index of the comment.
  - getColumn : int
```
int getColumn()
```
    Gets the column index of the comment.
  - isThreadedComment : boolean
```
boolean isThreadedComment()
```
    Indicates whether this comment is a threaded comment.
  - getThreadedComments : ThreadedCommentCollection
```
ThreadedCommentCollection getThreadedComments()
```
    Gets the list of threaded comments;
  - getNote/setNote : String
```
String getNote() / setNote(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.
  - getHtmlNote/setHtmlNote : String
```
String getHtmlNote() / setHtmlNote(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.
  - getFont : Font
```
Font getFont()
```
    Gets the font of comment.
  - isVisible/setVisible : boolean
```
boolean isVisible() / setVisible(value)
```
    Represents if the comment is visible or not.
  - getTextOrientationType/setTextOrientationType : int
```
int getTextOrientationType() / setTextOrientationType(value)
```
    Gets and sets the text orientation type of the comment. The value of the property is TextOrientationType integer constant.
  - getTextHorizontalAlignment/setTextHorizontalAlignment : int
```
int getTextHorizontalAlignment() / setTextHorizontalAlignment(value)
```
    Gets and sets the text horizontal alignment type of the comment. The value of the property is TextAlignmentType integer constant.
  - getTextVerticalAlignment/setTextVerticalAlignment : int
```
int getTextVerticalAlignment() / setTextVerticalAlignment(value)
```
    Gets and sets the text vertical alignment type of the comment. The value of the property is TextAlignmentType integer constant.
  - getAutoSize/setAutoSize : boolean
```
boolean getAutoSize() / setAutoSize(value)
```
    Indicates if size of comment is adjusted automatically according to its content.
  - getHeightCM/setHeightCM : float
```
float getHeightCM() / setHeightCM(value)
```
    Represents the height of the comment, in unit of centimeters.
  - getWidthCM/setWidthCM : float
```
float getWidthCM() / setWidthCM(value)
```
    Represents the width of the comment, in unit of centimeters.
  - getWidth/setWidth : int
```
int getWidth() / setWidth(value)
```
    Represents the width of the comment, in unit of pixels.
  - getHeight/setHeight : int
```
int getHeight() / setHeight(value)
```
    Represents the Height of the comment, in unit of pixels.
  - getWidthInch/setWidthInch : float
```
float getWidthInch() / setWidthInch(value)
```
    Represents the width of the comment, in unit of inches.
  - getHeightInch/setHeightInch : float
```
float getHeightInch() / setHeightInch(value)
```
    Represents the height of the comment, in unit of inches.
- Method Detail
  - formatCharacters
```
 formatCharacters(startIndex, length, font, flag)
```
    Format some characters with the font setting.
    Parameters:
    startIndex: int - The start index.
    length: int - The length.
    font: Font - The font setting.
    flag: StyleFlag - The flag of the font setting.
  - characters
```
FontSetting characters(startIndex, length)
```
    Returns a Characters object that represents a range of characters within the comment text.
    Parameters:
    startIndex: int - The index of the start of the character.
    length: int - The number of characters.
    Returns:
    Characters object.
  - getCharacters
```
ArrayList getCharacters()
```
    Returns all Characters objects that represents a range of characters within the comment text.
    Returns:
    All Characters objects

asposecells.api

Classes

Constants

Class Comment

Property Getters/Setters Detail

getAuthor/setAuthor : String

getCommentShape : CommentShape

getRow : int

getColumn : int

isThreadedComment : boolean

getThreadedComments : ThreadedCommentCollection

getNote/setNote : String

getHtmlNote/setHtmlNote : String

getFont : Font

isVisible/setVisible : boolean

getTextOrientationType/setTextOrientationType : int

getTextHorizontalAlignment/setTextHorizontalAlignment : int

getTextVerticalAlignment/setTextVerticalAlignment : int

getAutoSize/setAutoSize : boolean

getHeightCM/setHeightCM : float

getWidthCM/setWidthCM : float

getWidth/setWidth : int

getHeight/setHeight : int

getWidthInch/setWidthInch : float

getHeightInch/setHeightInch : float

Method Detail

formatCharacters

characters

getCharacters