ColdFusion 9.0 Resources

SpreadsheetDeleteRows

Description

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

Returns

Does not return a value.

Function syntax

SpreadsheetDeleteRow(spreadsheetObj, range)

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.

Usage

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>