RevisionCellComment

RevisionCellComment class

Represents a revision record of a cell comment change.

class RevisionCellComment extends Revision;

Constructors

Constructor	Description
constructor(Revision)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
row	number	Readonly. Gets the row index of the which contains a comment.
column	number	Readonly. Gets the column index of the which contains a comment.
cellName	string	Gets the name of the cell.
actionType	RevisionActionType	Readonly. Gets the action type of the revision.
isOldComment	boolean	Readonly. Indicates whether it’s an old comment.
oldLength	number	Readonly. Gets Length of the comment text added in this revision.
newLength	number	Readonly. Gets Length of the comment before this revision was made.
worksheet	Worksheet	Readonly. Gets the worksheet.
id	number	Readonly. Gets the number of this revision.

Methods

Method	Description
getRow()	@deprecated. Please use the ‘row’ property instead. Gets the row index of the which contains a comment.
getColumn()	@deprecated. Please use the ‘column’ property instead. Gets the column index of the which contains a comment.
getCellName()	@deprecated. Please use the ‘cellName’ property instead. Gets the name of the cell.
setCellName(string)	@deprecated. Please use the ‘cellName’ property instead. Gets the name of the cell.
getActionType()	@deprecated. Please use the ‘actionType’ property instead. Gets the action type of the revision.
isOldComment()	@deprecated. Please use the ‘isOldComment’ property instead. Indicates whether it’s an old comment.
getOldLength()	@deprecated. Please use the ‘oldLength’ property instead. Gets Length of the comment text added in this revision.
getNewLength()	@deprecated. Please use the ’newLength’ property instead. Gets Length of the comment before this revision was made.
isNull()	Checks whether the implementation object is null.
getWorksheet()	@deprecated. Please use the ‘worksheet’ property instead. Gets the worksheet.
getId()	@deprecated. Please use the ‘id’ property instead. Gets the number of this revision.
getType()	Gets the type of revision.

constructor(Revision)

Constructs from a parent object convertible to this.

constructor(obj: Revision);

Parameters:

Parameter	Type	Description
obj	Revision	The parent object.

row

Readonly. Gets the row index of the which contains a comment.

row : number;

column

Readonly. Gets the column index of the which contains a comment.

column : number;

cellName

Gets the name of the cell.

cellName : string;

actionType

Readonly. Gets the action type of the revision.

actionType : RevisionActionType;

isOldComment

Readonly. Indicates whether it’s an old comment.

isOldComment : boolean;

oldLength

Readonly. Gets Length of the comment text added in this revision.

oldLength : number;

newLength

Readonly. Gets Length of the comment before this revision was made.

newLength : number;

worksheet

Readonly. Gets the worksheet.

worksheet : Worksheet;

id

Readonly. Gets the number of this revision.

id : number;

Remarks

Zero means this revision does not contains id.

getRow()

@deprecated. Please use the ‘row’ property instead. Gets the row index of the which contains a comment.

getRow() : number;

getColumn()

@deprecated. Please use the ‘column’ property instead. Gets the column index of the which contains a comment.

getColumn() : number;

getCellName()

@deprecated. Please use the ‘cellName’ property instead. Gets the name of the cell.

getCellName() : string;

setCellName(string)

@deprecated. Please use the ‘cellName’ property instead. Gets the name of the cell.

setCellName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getActionType()

@deprecated. Please use the ‘actionType’ property instead. Gets the action type of the revision.

getActionType() : RevisionActionType;

Returns

RevisionActionType

isOldComment()

@deprecated. Please use the ‘isOldComment’ property instead. Indicates whether it’s an old comment.

isOldComment() : boolean;

getOldLength()

@deprecated. Please use the ‘oldLength’ property instead. Gets Length of the comment text added in this revision.

getOldLength() : number;

getNewLength()

@deprecated. Please use the ’newLength’ property instead. Gets Length of the comment before this revision was made.

getNewLength() : number;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getWorksheet()

@deprecated. Please use the ‘worksheet’ property instead. Gets the worksheet.

getWorksheet() : Worksheet;

Returns

Worksheet

getId()

@deprecated. Please use the ‘id’ property instead. Gets the number of this revision.

getId() : number;

Remarks

Zero means this revision does not contains id.

getType()

Gets the type of revision.

getType() : RevisionType;

Returns

RevisionType