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

Deletes all data from multiple rows of an Excel spreadsheet object. It does not delete the row.

Returns

Does not return a value.

Category

Microsoft Office Integration

Function syntax

SpreadsheetDeleteRows(spreadsheetObj, range)

See also

SpreadsheetDeleteColumnSpreadsheetDeleteColumnsSpreadsheetDeleteRowSpreadsheetFormatRow

SpreadsheetFormatRowsSpreadsheetShiftRows

History

ColdFusion 9: Added the function.

Parameters

Parameter

Description

spreadsheetObj

The Excel spreadsheet object in which to delete the rows.

range

The rows to delete, using any combination of the following form:

  • startRow-endRow - Insert rows in a single range.
  • row,row,row... - Insert one or more individual rows.
    You can also provide both the formats together. For example, 1, 2, 3-5, 7-12.

Example

The following example deletes rows 1 and 5-10 from a spreadsheet.

<!--- Get the spreadsheet data as a query. --->
<cfquery
name="courses" datasource="cfdocexamples"
cachedwithin="#CreateTimeSpan(0, 6, 0, 0)#">
SELECT CORNUMBER,DEPT_ID,CORLEVEL,COURSE_ID,CORNAME,CORDESC,LASTUPDATE
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);
//Delete rows 1 and 5 though 10.
SpreadsheetDeleteRows(theSheet,"1,5-10");
</cfscript>

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

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