CF_XLS_Workbook

Description

Creates an Excel workbook and either returns the workbook using cfcontent or writes it out to a file.

Syntax

<CF_XLS_Workbook 
   DeleteFile = "yes" or "no"
   Display = "yes" or "no"
   FileName = "filename"
   SaveAsName = "Client Filename">
	 
	 ....XLSAdapter tags....
	 
</CF_XLS_Workbook>

Attributes

Attribute	Req/Opt	Default	Description
DeleteFile	Opt	Yes	Applies only if you specify a file with the FileName attribute. yes: deletes the file on the server after sending its contents to the client. no: leaves the file on the server.
Display	Opt	Yes	Determines whether to return the workbook with cfcontent. yes: returns the workbook to the browser using cfcontent. no: the workbook is processed and written to a file but the tag returns nothing to the browser.
Filename	Opt		Name of a file to contain the workbook. The file name must be a full path to a location where ColdFusion has permission to create/edit/delete files. If the Filename attribute is omitted a temporary file is used(as returned by ColdFusion function GetTempFile()).
SaveAsName	Opt		Filename of the workbook to display to the browser. This is independent of the FileName attribute. If not specified the filename of the FileName attribute is used. If neither the SaveAsName nor the FileName attribute is used then the filename is the name of a temporary file created by ColdFusion function GetTempFile().

Usage

You can use the following ColdFusion form control tags within the CF_XLS_Workbook tag:

CF_XLS_Sheet Used to create a new workbook sheet.
CF_XLS_Font Used to defined global cell fonts.
CF_XLS_Style Used to define global cell styles.

Example

See the examples page.