ColdFusion 9.0 Resources

SpreadsheetFormatColumns

Description

Formats the contents of multiple columns of an Excel spreadsheet object.

Returns

Does not return a value.

Function syntax

SpreadsheetFormatColumns(spreadsheetObj, format, columns)

History

ColdFusion 9: Added the function.

Parameters

Parameter	Description
`spreadsheetObj`	The Excel spreadsheet object in which to set the format.
`format`	A structure containing the format information. For details see `SpreadsheetFormatCell`.
`columns`	The columns to format, in one of the following formats: `startColumn`-`endColumn` — Insert columns in a single range. `column,column,column`... — Insert one or more individual columns.

Usage

Example

The following example creates a sheet, sets a format for columns 1-5, and writes the result to a file:

<!--- Get the spreadsheet data as a query. ---> 
<cfquery 
       name="courses" datasource="cfdocexamples" 
       cachedwithin="#CreateTimeSpan(0, 6, 0, 0)#"> 
       SELECT CORNUMBER,DEPT_ID,CORLEVEL,COURSE_ID,CORNAME,CORDESC,LASTUPDATE 
       FROM COURSELIST 
</cfquery> 
 
<cfscript> 
    ///We need an absolute path, so get the current directory path. 
       theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "courses.xls"; 
    //Create a new Excel spreadsheet object and add the query data. 
    theSheet = SpreadsheetNew("CourseData"); 
    SpreadsheetAddRows(theSheet,courses); 
    // Define a format for the column. 
    format1-SructNew() 
    format1.font="Courier"; 
    format1.fontsize="10"; 
    format1.color="dark_blue;"; 
    format1.italic="true"; 
    format1.bold="true"; 
    format1.alignment="left"; 
    format1.textwrap="true"; 
    format1.fgcolor="pale_blue"; 
    format1.bottomborder="dotted"; 
    format1.bottombordercolor="blue_grey"; 
    format1.leftborder="thick"; 
    format1.leftbordercolor="blue_grey"; 
    format1.rightborder="thick"; 
    format1.rightbordercolor="blue_grey"; 
    SpreadsheetFormatColumns(theSheet,format1,"1-5"); 
</cfscript> 
 
<!--- Write the spreadsheet to a file, replacing any existing file. ---> 
<cfspreadsheet action="write" filename="#theFile#" name="theSheet"  
    sheet=1 sheetname="courses" overwrite=true>