SpreadsheetSetActiveSheet

Last updated on | Also Applies to ColdFusion

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:

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

Sets a specified sheet as active.

Returns

Nothing

Syntax

SpreadsheetSetActiveSheet (spreadsheetobj, sheetname)

History

ColdFusion 9: Added the function.

Parameters

Parameter	Description
spreadsheetobj	The Excel spreadsheet object to which to add the split pane.
sheetname	The name of the worksheet that must be set as active.

Usage

You can set only one sheet as active at a time. Therefore, any sheet operation is limited to a particular sheet. For operations in any other sheet, you must set that sheet as active.

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 false 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 coldfusion1 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);
 
  
 SpreadsheetWrite(mySheet,"#myFile#",true);
 
</cfscript>

Output

1	Active sheet
2	Inactive sheet