Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
XL.Sheet.CellWriteComments
Writes comments to an area of cells.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
XL | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.CellWriteComments"; bookRef; sheetIndex; First row; Last row; First column; Last column; Values { ; 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 | |
Values | The values to use. Can be separated with row and column delimiter to give each row and column a different value. But you can also use same value for all rows or for all columns. |
"Test" | |
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 number of errors or error.
Description
Writes comments to an area of cells.You can write one value or multiple values to a given range of cells.
Returns number of errors occurred, so on success you get back zero.
Only for xls format, not xlsx.
See also
- XL.Book.SheetCount
- XL.LoadBook
- XL.Sheet.CellWriteBooleans
- XL.Sheet.CellWriteComment
- XL.Sheet.CellWriteFormula
- XL.Sheet.CellWriteFormulas
- XL.Sheet.CellWriteNumber
- XL.Sheet.CellWriteNumbers
- XL.Sheet.CellWriteText
- XL.Sheet.CellWriteTexts
Release notes
- Version 8.0
- Added XL.Sheet.CellReadBooleans, XL.Sheet.CellReadComments, XL.Sheet.CellReadDates, XL.Sheet.CellReadFormulas, XL.Sheet.CellReadNumbers, XL.Sheet.CellReadTexts, XL.Sheet.CellWriteBlanks, XL.Sheet.CellWriteBooleans, XL.Sheet.CellWriteComments, XL.Sheet.CellWriteDates, XL.Sheet.CellWriteFormulas, XL.Sheet.CellWriteNumbers, XL.Sheet.CellWriteTexts, XL.Sheet.GetCellErrors, XL.Sheet.GetCellFormats, XL.Sheet.RemoveComments and XL.Sheet.SetCellFormats.
Blog Entries
This function checks for a license.
Created 15th January 2018, last changed 30th October 2024