Whatever message this page gives is out now! Go check it out!

SpreadsheetSetHeader

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:
  1. Log in with your Gmail or Facebook credentials.
  2. Navigate to the project in the left pane.
  3. Once you make some changes in any cfm in the project, a pop up displays asking you to save the project.
  4. Give the project a suitable name and click Save.

Description

Adds a header to the specified worksheet.

Returns

Nothing

Category

Spreadsheet functions, Microsoft Office integration functions

Syntax

SpreadsheetSetHeader (spreadhsheetobj, left header, center header, right header)

See also

SpreadsheetGetCellComment, SpreadsheetFormatCell, SpreadsheetGetCellFormula, SpreadsheetGetCellValue, 
SpreadsheetMergeCells, SpreadsheetSetCellFormula, SpreadsheetSetCellValue

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

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page