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

Sets a specified sheet as active.

Returns

Nothing

Category

Syntax

SpreadsheetSetActiveSheet (spreadsheetobj, sheetname)

See also

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

spreadsheetsetactivesheet output
spreadsheetsetactivesheet output
1 Active sheet
2 Inactive sheet

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