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

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy