[]
        
(Showing Draft Content)

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

Comment

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

Comment

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