Table of Contents

TXlsFile.SetCommentRow Method

Changes the properties (text and position of the popup) for an existing comment at commentIndex. To delete a comment, set a "new TRichString()" as the "value" param. To add a new comment, use TExcelFile.SetComment(Integer, Integer, TRichString).

Remarks

This method is used together with TExcelFile.CommentCountRow. See the reference on it for an example.

Syntax

Unit: FlexCel.XlsAdapter

procedure TXlsFile.SetCommentRow(const row: Integer; const commentIndex: Integer; const value: TRichString; commentProperties: IImageProperties; const removeEmpty: Boolean = True); overload; override;

Parameters

<-> Parameter Type Description
const row Integer Row Index (1 based)
const commentIndex Integer Comment index (1 based)
const value TRichString Text of the comment. Set it to "new TRichString()" to remove the comment.
commentProperties IImageProperties Properties of the popup.
const removeEmpty Boolean Optional: Default value is True

If true, comments of length 0 will be removed.

See also