User Guide Cancel

SpreadsheetCreateSheet

 

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

Creates an additional spreadsheet.

Returns

Does not return a value.

Category

Microsoft Office Integration

Function syntax

SpreadsheetCreateSheet(spreadsheetObj, [sheetname])

See also

SpreadsheetAddColumnSpreadsheetDeleteColumnsSpreadsheetDeleteRowSpreadsheetDeleteRows

SpreadsheetFormatColumnSpreadsheetFormatColumnsSpreadsheetShiftColumnsSpreadsheetSetActiveSheet

History

ColdFusion 9: Added the function.

Parameters

Parameter

Description

spreadsheetObj

The Excel spreadsheet object from which you create the additional sheet.

sheetname

Name of the new sheet. This is optional.

Example

The following example creates two sheets: CourseData and EvaluationSheet.

<!--- 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>

<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);
//Add a new sheet.
SpreadsheetCreateSheet (theSheet, "EvaluationSheet");
</cfscript>

<!--- Write the spreadsheet to a file, replacing any existing file. --->
<cfspreadsheet action="write" filename="#theFile#" name="theSheet"
sheet=1 sheetname="courses" overwrite=true>

Get help faster and easier

New user?