TExcelFile.SetCommentRow Method

Overloads

TExcelFile.SetCommentRow(Integer, Integer, TRichString, IImageProperties, Boolean)

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 SetComment(Integer, Integer, TRichString).

Remarks

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

Syntax

Unit: FlexCel.Core

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

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

TExcelFile.SetCommentRow(Integer, Integer, string, IImageProperties, Boolean)

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

Remarks

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

Syntax

Unit: FlexCel.Core

procedure TExcelFile.SetCommentRow(const row: Integer; const commentIndex: Integer; const value: string; commentProperties: IImageProperties; const removeEmpty: Boolean = True); overload;

Parameters

<-> Parameter Type Description
const row Integer Row Index (1 based)
const commentIndex Integer Comment index (1 based)
const value string Text of the comment. Set it to String.Empty 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