Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.Sheet.CellReadComments

Reads all the comments from cells in an area.

Component Version macOS Windows Linux Server iOS SDK
XL 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Sheet.CellReadComments"; bookRef; sheetIndex; First row; Last row; First column; Last column { ; Row Delimiter; Column Delimiter } )   More

Parameters

Parameter Description Example Flags
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
sheetIndex The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. 0
First row The first row to process. First row has index 0. 3
Last row The last row to process. First row has index 0. 6
First column The first column to process. First column has index 0. 2
Last column The last column to process. First column has index 0. 4
Row Delimiter The row delimiter for the result.
Default is new line character.
"¶" Optional
Column Delimiter The column delimiter for the result.
Default is tab character.
char(9) Optional

Result

Returns list of values or error.

Description

Reads all the comments from cells in an area.
If one cell can’t be read or has no comment, the value in the result will be empty.

See also

Release notes

Blog Entries

This function checks for a license.

Created 15th January 2018, last changed 29th January 2023


XL.Sheet.CellReadComment - XL.Sheet.CellReadDate