| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Sheet.CellWriteComment
Writes a comment to a cell.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.CellWriteComment"; bookRef; sheetIndex; Row; Column; Comment; Author; Width; Height ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| 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 |
| Row | The row for the cell. First row has index 0. | $row |
| Column | The column for the cell. First column has index 0. | $column |
| Comment | The comment to write. | "Hello World" |
| Author | The author for the comment. | "Christian" |
| Width | Width of text box in pixels. | 200 |
| Height | Height of text box in pixels. | 150 |
Result
Returns OK or error message.
Description
Writes a comment to a cell.See also
- XL.Book.SheetCount
- XL.Sheet.CellWriteComments
- XL.Sheet.CellWriteDates
- XL.Sheet.CellWriteFormula
- XL.Sheet.CellWriteFormulas
- XL.Sheet.CellWriteFormulaText
- XL.Sheet.CellWriteMatrix
- XL.Sheet.CellWriteNumber
- 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.
This function checks for a license.
Created 18th August 2014, last changed 18th August 2014
