Whatever message this page gives is out now! Go check it out!

SpreadsheetSetActiveSheetNumber

Last update:
May 18, 2026
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 sheetnumber as active sheet.

Returns

Does not return a value.

Category

Microsoft Office Integration

Function syntax

SpreadsheetSetActiveSheetNumber(spreadsheetobj, sheetnumber)

See also

SpreadsheetSetActiveSheet, SpreadsheetAddColumn, SpreadsheetAddImage, SpreadsheetAddRow, 
SpreadsheetDeleteRow, SpreadsheetDeleteRows, SpreadsheetFormatRow, 
SpreadsheetFormatRows, SpreadsheetShiftRows

History

ColdFusion 9: Added the function.

Parameters

Parameter
Description
spreadsheetobj
The Excel spreadsheet object to which to add the split pane.
sheetnumber
The spreadsheet number 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

The following example shows how to switch from one sheet to another and perform operations.
<!--- Get the spreadsheet data as a query. ---> 
 <cfquery 
 name="courses" datasource="cfdocexamples" 
 cachedwithin="#CreateTimeSpan(0, 6, 0, 0)#"> 
 SELECT CORNUMBER,DEPT_ID,COURSE_ID,CORNAME 
 FROM COURSELIST 
 </cfquery> 
 <cfset theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & courses.xls"> 
 <cfspreadsheet action="read" name=theSheet src="#theFile#" sheet="1"> 
 
 <cfscript> 
 SpreadsheetAddRows(theSheet,courses); 
 //Set the sheetnumber 2 as active. 
 SpreadsheetSetActiveSheetNumber (theSheet, 2); 
 //Add a new row to the sheet 2. 
 SpreadsheetAddRows(theSheet,courses); 
 </cfscript> 
 
 <!--- Write the spreadsheet to a file, replacing any existing file. ---> 
 <cfspreadsheet action="write" filename="#theFile#" name="theSheet" 
 sheet=1 sheetname="courses" overwrite=true>

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page