User Guide Cancel

SpreadsheetFormatRow

 

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

Formats the contents of a single row of an Excel spreadsheet object.

Returns

Nothing

Category

Syntax

SpreadsheetFormatRow (spreadsheetObj, format, row)
SpreadsheetFormatRow (spreadsheetObj, format, row)
SpreadsheetFormatRow (spreadsheetObj, format, row)

Parameters

Parameter

Description

spreadsheetObj

The Excel spreadsheet object in which you want to format a row.

format

Struct containing the format information.

row

The row number where formatting is to be applied.

See also

History

ColdFusion 9: Added the function.

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.xls";
// create spreadsheet object. Set xml to true as this is an xlsx file
mySheet=SpreadsheetNew("ColdFusion",false);
// Create another worksheet coldfusion1
SpreadsheetCreateSheet(mySheet,"ColdFusion1");
// Set headers for the xlsx file
SpreadSheetAddRow(mySheet,"Order,First Name,Last Name,Address,Amount,City");
SpreadSheetAddRows(mySheet,ArtOrders);
// set coldfusion as active sheet
SpreadsheetSetActiveSheet(mySheet,"ColdFusion1");
// new query for the new sheet
Artists=QueryExecute("Select * from APP.ARTISTS",[],{datasource="cfartgallery"});
SpreadSheetAddRow(mySheet,"ARTISTID,First Name,Last Name,Address,CITY,STATE,POSTALCODE,EMAIL,PHONE,FAX,THEPASSWORD");
SpreadSheetAddRows(mySheet,Artists);
// Define the structure for formatting a row
myFormat=StructNew();
myFormat.color="blue";
myFormat.bold="true";
myFormat.underline="true";
myFormat.alignment="center";
myFormat.font="Arial";
// Set formatting to row 3
SpreadsheetFormatRow(mySheet,myFormat,3);
SpreadsheetWrite(mySheet,"#myFile#",true);
</cfscript>
<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.xls"; // create spreadsheet object. Set xml to true as this is an xlsx file mySheet=SpreadsheetNew("ColdFusion",false); // Create another worksheet coldfusion1 SpreadsheetCreateSheet(mySheet,"ColdFusion1"); // Set headers for the xlsx file SpreadSheetAddRow(mySheet,"Order,First Name,Last Name,Address,Amount,City"); SpreadSheetAddRows(mySheet,ArtOrders); // set coldfusion as active sheet SpreadsheetSetActiveSheet(mySheet,"ColdFusion1"); // new query for the new sheet Artists=QueryExecute("Select * from APP.ARTISTS",[],{datasource="cfartgallery"}); SpreadSheetAddRow(mySheet,"ARTISTID,First Name,Last Name,Address,CITY,STATE,POSTALCODE,EMAIL,PHONE,FAX,THEPASSWORD"); SpreadSheetAddRows(mySheet,Artists); // Define the structure for formatting a row myFormat=StructNew(); myFormat.color="blue"; myFormat.bold="true"; myFormat.underline="true"; myFormat.alignment="center"; myFormat.font="Arial"; // Set formatting to row 3 SpreadsheetFormatRow(mySheet,myFormat,3); SpreadsheetWrite(mySheet,"#myFile#",true); </cfscript>
<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.xls";
 // create spreadsheet object. Set xml to true as this is an xlsx file
 mySheet=SpreadsheetNew("ColdFusion",false);
 // Create another worksheet coldfusion1
 SpreadsheetCreateSheet(mySheet,"ColdFusion1");
 // Set headers for the xlsx file
 SpreadSheetAddRow(mySheet,"Order,First Name,Last Name,Address,Amount,City");
 SpreadSheetAddRows(mySheet,ArtOrders);
 
 // set coldfusion as active sheet
 SpreadsheetSetActiveSheet(mySheet,"ColdFusion1");
 // new query for the new sheet
 Artists=QueryExecute("Select * from APP.ARTISTS",[],{datasource="cfartgallery"});
 SpreadSheetAddRow(mySheet,"ARTISTID,First Name,Last Name,Address,CITY,STATE,POSTALCODE,EMAIL,PHONE,FAX,THEPASSWORD");
 SpreadSheetAddRows(mySheet,Artists);
 
  
 // Define the structure for formatting a row
 myFormat=StructNew();
 myFormat.color="blue";
 myFormat.bold="true";
 myFormat.underline="true";
 myFormat.alignment="center";
 myFormat.font="Arial";
 
 // Set formatting to row 3
 SpreadsheetFormatRow(mySheet,myFormat,3);
 SpreadsheetWrite(mySheet,"#myFile#",true);
 
</cfscript>

Output

Get help faster and easier

New user?