Description
Deletes the data from multiple columns of an Excel spreadsheet object. This function does not remove the columns.
Returns
Does not return a value.
Category
Microsoft Office Integration
Function syntax
SpreadsheetDeleteColumns(spreadsheetObj, range) |
See also
SpreadsheetAddColumn, SpreadsheetDeleteColumn, SpreadsheetDeleteRow, SpreadsheetDeleteRows,
SpreadsheetFormatColumn, SpreadsheetFormatColumns, SpreadsheetShiftColumns
History
ColdFusion 9: Added the function.
Parameters
Parameter |
Description |
---|---|
spreadsheetObj |
The Excel spreadsheet object from which to delete the columns. |
range |
A string containing the columns to delete, using any combination of the following formats:
|
Example
The following example deletes the data from columns 2-4 and column 6 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 columns 2 though 4 and 6. SpreadsheetDeleteColumns(theSheet,"2-4,6"); </cfscript> <!--- Write the spreadsheet to a file, replacing any existing file. ---> <cfspreadsheet action="write" filename="#theFile#" name="theSheet" sheet=1 sheetname="courses" overwrite=true> |