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
Adds a header to the specified worksheet.
Returns
Nothing
Category
Syntax
SpreadsheetSetHeader (spreadhsheetobj, left header, center header, right header)
See also
History
ColdFusion 9: Added the function.
Parameters
Parameter |
Description |
|---|---|
spreadsheetobj |
The Excel spreadsheet object to which to add the header. |
left header |
Adds the header in the left side of the worksheet. |
center header |
Adds the header in the center of the worksheet. |
right header |
Adds the header in the right side of the worksheet. |
Usage
The added header appears on the printed worksheet document. You can pass empty strings in places where you do not require headers. For example,
SpreadsheetSetHeader(excelSpreadsheetObject," ","Center header"," ");
Example
<cfscript>
ArtOrders=QueryExecute("SELECT orderid,customerfirstname,customerlastname,address,total,city FROM orders
ORDER BY orderid", [] ,{datasource="cfartgallery"});
// Set the file path in the same location as this cfm
myFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "myexcelfile.xlsx";
// create spreadsheet object. Set xml to true as this is an xlsx file
mySheet=SpreadsheetNew("ColdFusion",true);
// Set headers for the xlsx file
SpreadSheetAddRow(mySheet,"Order,First Name,Last Name,Address,Amount,City");
SpreadSheetAddRows(mySheet,ArtOrders);
//Set the headers of the file
SpreadsheetSetHeader(mySheet,"left header","center header","right header");
SpreadsheetWrite(mySheet,"#myFile#",true);
</cfscript>
Output
Sign in to your account