SpreadsheetDeleteRow

Description

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

Returns

Does not return a value.

Category

Microsoft Office Integration

Function syntax

SpreadsheetDeleteRow(spreadsheetObj, row)

See also

SpreadsheetDeleteColumn, SpreadsheetDeleteColumns, SpreadsheetDeleteRows, SpreadsheetFormatRows, SpreadsheetShiftRows

History

ColdFusion 9: Added the function.

Parameters

Parameter

Description

spreadsheetObj

The Excel spreadsheet object from which to delete the row.

row

The row to delete.

Example

The following example deletes row 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 row 10. 
    SpreadsheetDeleteRow(theSheet,"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>