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 data from a column of an Excel spreadsheet object. It does not delete the column.

Returns

Nothing

Category

Syntax

SpreadsheetDeleteColumn (spreadsheetObj, column)

See also

History

ColdFusion 9: Added the function.

Parameters

Parameter

Description

spreadsheetObj

The Excel spreadsheet object from which to delete the column.

column

The column to delete.

Example

<cfscript>
	ArtOrders=QueryExecute("SELECT orderid,customerfirstname,customerlastname,address,total,city FROM orders
	ORDER BY orderid",[],{datasource="cfartgallery"});
	// Set the file path in the same location as this cfm
	myFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "myexcelfile.xls";
	// create spreadsheet object. Set xml to true as this is an xlsx file
	mySheet=SpreadsheetNew("ColdFusion",false);
	// Create another worksheet coldfusion1
	SpreadsheetCreateSheet(mySheet,"ColdFusion1");
	// Set headers for the xlsx file
	SpreadSheetAddRow(mySheet,"Order,First Name,Last Name,Address,Amount,City");
	SpreadSheetAddRows(mySheet,ArtOrders);
	
	// set coldfusion as active sheet
	SpreadsheetSetActiveSheet(mySheet,"ColdFusion1");
	// new query for the new sheet
	Artists=QueryExecute("Select * from APP.ARTISTS",[],{datasource="cfartgallery"});
	
	// Add rows to the sheet
	SpreadSheetAddRow(mySheet,"ARTISTID,First Name,Last Name,Address,CITY,STATE,POSTALCODE,EMAIL,PHONE,FAX,THEPASSWORD");
	SpreadSheetAddRows(mySheet,Artists);
	
	
	// Delete column 6 in the sheet ColdFusion1
	SpreadsheetDeleteColumn(mySheet,6);
	
	SpreadsheetWrite(mySheet,"#myFile#",true);
	
</cfscript>

Output

spreadsheetdeletecolumn output
spreadsheetdeletecolumn output

Example

The following example deletes the data from column 2 from a spreadsheet.

<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);
//Delete the second column of the sheet.
SpreadsheetDeleteColumn(theSheet,2);
</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