Whatever message this page gives is out now! Go check it out!
SpreadsheetGetCellComment
Last update:
May 18, 2026
Note: 
You can find the CFFiddle demo of this function and other spreadsheet functions as part of a project that is shared with you.
Click the button below to launch CFFiddle.
To copy the project in your workspace in CFFiddle, follow the steps below:
- Log in with your Gmail or Facebook credentials.
- Navigate to the project in the left pane.
- Once you make some changes in any cfm in the project, a pop up displays asking you to save the project.
- Give the project a suitable name and click Save.
Description
Gets the comment for an Excel spreadsheet object cell as a structure with formatting information, or all comments for the object.
Returns
If the parameters include the row and column: a structure containing the comment information for the specified cell. If the function has only a spreadsheetObj parameter, an array containing a structure for each comment. Each structure has the following information:
Field | Contents |
Author | A string containing the name of the comment author. |
Column | The cell column number. |
Comment | A string containing the comment text. |
Row | The cell row number. |
Category
Microsoft Office Integration
Function syntax
SpreadsheetGetCellComment(spreadsheetObj[, row, column]) |
See also
History
ColdFusion 9: Added the function.
Parameters
Parameter | Description |
spreadsheetObj | The Excel spreadsheet object from which to get the comment. |
row | The row number of the cell from which to get the comment. |
column | The column number of the cell from which to get the comment. |
Example
The following example sets and gets a comment for the cell at row 3 column 5.
<cfscript>
///We need an absolute path, so get the current directory path.
theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "comment.xls";
//Create an Excel spreadsheet object.
theSheet = SpreadsheetNew();
// Define a cell comment.
comment1.anchor="1,1,15,20";
comment1.author="Adobe Systems";
comment1.bold="true";
comment1.color="lavender";
comment1.comment="This is the cell in row three, column 5 (E).";
comment1.fillcolor="yellow";
comment1.font="Courier";
comment1.horizontalalignment="left";
comment1.linestyle="dashsys";
comment1.size="10";
comment1.verticalalignment="top";
//Set the comment.
SpreadsheetSetCellComment(theSheet,comment1,3,5);
//Get the comment from the Excel spreadsheet object.
theComment=SpreadsheetGetCellComment(theSheet,3,5);
</cfscript>
<cfoutput>
Row,Column: #theComment.row#,#theComment.column#<br />
Author: #theComment.author#<br />
Comment: #theComment.comment#
</cfoutput>
<!--- Write the spreadsheet to a file, replacing any existing file. --->
<cfspreadsheet action="write" filename="#theFile#" name="theSheet"
sheet=1 sheetname="courses" overwrite=true>
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
