- GC.Data
- GC.Pivot
- GC.Spread.CalcEngine
- GC.Spread.CalcEngine.Functions
- GC.Spread.CalcEngine.LanguagePackages
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Pivot
- GC.Spread.Sheets
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Slicers
- GC.Spread.Sheets.Designer
- GC.Spread.Excel.IO
GC.Spread.Sheets.Comments.CommentManager
Class: CommentManager
Sheets.Comments.CommentManager
Table of contents
Constructors
Methods
Constructors
constructor
• new CommentManager(sheet)
Represents a comment manager that can manage all comments in a sheet.
Parameters
| Name | Type | Description |
|---|---|---|
sheet |
Worksheet |
The worksheet. |
Methods
add
▸ add(row, col, text): Comment
Adds a comment to the cell for the indicated row and column.
Parameters
| Name | Type | Description |
|---|---|---|
row |
number |
The row index of the cell. |
col |
number |
The column index of the cell. |
text |
string |
The text of the comment. |
Returns
The comment that has been added to the cell.
all
▸ all(): Comment[]
Gets all comments in the sheet.
Returns
Comment[]
clear
▸ clear(range): void
Clears all of the comments in the indicated range on the sheet. When the range is not specified, it clears all the comments in the sheet.
Parameters
| Name | Type | Description |
|---|---|---|
range |
Range |
The range that you want clear all comments from. |
Returns
void
get
▸ get(row, col): Comment
Gets the comment in the cell with the indicated row and column.
Parameters
| Name | Type | Description |
|---|---|---|
row |
number |
The row index of the cell. |
col |
number |
The column index of the cell. |
Returns
The comment in the indicated cell.
remove
▸ remove(row, col): void
Removes the comment from the cell for the indicated row and column.
Parameters
| Name | Type | Description |
|---|---|---|
row |
number |
The row index of the cell. |
col |
number |
The column index of the cell. |
Returns
void