IExcelFile Interface Reference

Minimum base interface that must be provided by an ExcelFile implementation. More...

Inheritance diagram for IExcelFile:

Public Member Functions
	writeNumber ($row, $col, $value)
	Write a number to the cell at the specified row and column. More...
	writeText ($row, $col, $value, $wrap=false)
	Write text to the cell at the specified row and column. More...
	writePercentage ($row, $col, $value)
	Write a number to the cell at the specified row and column and format as a percentage. More...
	writeCurrency ($row, $col, $value)
	Write a number to the cell at the specified row and column with currency formatting. More...
	writeHeading ($row, $col, $value)
	Write text with column heading styles. More...
	writeSubheading ($row, $col, $value)
	Write text with column sub-heading styles. More...
	writeFooter ($row, $col, $value)
	Write text with column footer styles. More...
	writeFooterNumber ($row, $col, $value)
	Write number with column footer styles. More...
	setWorksheetTitle ($title)
	Set the title of the currently active worksheet. More...
	addWorksheet ($title)
	Adds a new worksheet to the Excel file. More...
	abort ($error)
	Abort processing, output the specified error string. More...
	close ()
	Prevent further output to the spreadsheet. More...
	send ()
	Transmit the spreadsheet to the client. More...

Detailed Description

Minimum base interface that must be provided by an ExcelFile implementation.

Author

andy

Definition at line 67 of file excel.inc.

Member Function Documentation

abort()

IExcelFile::abort

(

$error

)

Abort processing, output the specified error string.

Parameters

string

$error

Implemented in ExcelFile.

addWorksheet()

IExcelFile::addWorksheet

(

$title

)

Adds a new worksheet to the Excel file.

Parameters

string

$title

the title of the new worksheet

Implemented in ExcelFile.

close()

IExcelFile::close

(

)

Prevent further output to the spreadsheet.

Implemented in ExcelFile.

send()

IExcelFile::send

(

)

Transmit the spreadsheet to the client.

Implemented in ExcelFile.

setWorksheetTitle()

IExcelFile::setWorksheetTitle

(

$title

)

Set the title of the currently active worksheet.

Parameters

string

$title

the title text.

Implemented in ExcelFile.

writeCurrency()

IExcelFile::writeCurrency	(		$row,
			$col,
			$value
	)

Write a number to the cell at the specified row and column with currency formatting.

Parameters

integer	$row
integer	$col
number	$value

Implemented in ExcelFile.

writeFooter()

IExcelFile::writeFooter	(		$row,
			$col,
			$value
	)

Write text with column footer styles.

Parameters

integer	$row
integer	$col
string	$value

Implemented in ExcelFile.

writeFooterNumber()

IExcelFile::writeFooterNumber	(		$row,
			$col,
			$value
	)

Write number with column footer styles.

Parameters

integer	$row
integer	$col
string	$value

Implemented in ExcelFile.

writeHeading()

IExcelFile::writeHeading	(		$row,
			$col,
			$value
	)

Write text with column heading styles.

Parameters

integer	$row
integer	$col
string	$value

Implemented in ExcelFile.

writeNumber()

IExcelFile::writeNumber	(		$row,
			$col,
			$value
	)

Write a number to the cell at the specified row and column.

Parameters

integer	$row
integer	$col
number	$value

Implemented in ExcelFile.

writePercentage()

IExcelFile::writePercentage	(		$row,
			$col,
			$value
	)

Write a number to the cell at the specified row and column and format as a percentage.

Parameters

integer	$row
integer	$col
number	$value

Implemented in ExcelFile.

writeSubheading()

IExcelFile::writeSubheading	(		$row,
			$col,
			$value
	)

Write text with column sub-heading styles.

Parameters

integer	$row
integer	$col
string	$value

Implemented in ExcelFile.

writeText()

IExcelFile::writeText	(		$row,
			$col,
			$value,
			$wrap = false
	)

Write text to the cell at the specified row and column.

Parameters

integer	$row	the cell row number
integer	$col	the cell column number
string	$value	the string to insert
boolean	$wrap	whether to allow text wrapping

Implemented in ExcelFile.

---

The documentation for this interface was generated from the following file:

• C:/code/cms.sonjara.com/framework/excel.inc