Docs For Class PHPExcel

$_autoFilter = ''

[line 262]

Autofilter Range

Tags:

access:

private

Type:

string

[ Top ]

$_breaks = array()

[line 241]

Collection of breaks

Tags:

access:

private

Type:

array

[ Top ]

$_cachedHighestColumn = null

[line 332]

Cached highest column

Tags:

access:

private

Type:

string

[ Top ]

$_cachedHighestRow = null

[line 339]

Cached highest row

Tags:

access:

private

Type:

int

[ Top ]

$_cellCollection = array()

[line 136]

Collection of cells

Tags:

access:

private

Type:

PHPExcel_Cell[]

[ Top ]

$_cellCollectionIsSorted = false

[line 234]

Is the current cell collection sorted already?

Tags:

access:

private

Type:

boolean

[ Top ]

$_columnDimensions = array()

[line 157]

Collection of column dimensions

Tags:

access:

private

Type:

PHPExcel_Worksheet_ColumnDimension[]

[ Top ]

$_comments = array()

[line 304]

Collection of comments

Tags:

access:

private

Type:

PHPExcel_Comment[]

[ Top ]

$_conditionalStylesCollection = array()

[line 227]

Conditional styles.

Conditional styles. Indexed by cell coordinate, e.g. 'A1'

Tags:

access:

private

Type:

array

[ Top ]

$_dataValidationCollection = array()

[line 360]

Data validation objects.

Data validation objects. Indexed by cell coordinate, e.g. 'A1'

Tags:

access:

private

Type:

array

[ Top ]

$_defaultColumnDimension = null

[line 164]

Default column dimension

Tags:

access:

private

Type:

PHPExcel_Worksheet_ColumnDimension

[ Top ]

$_defaultRowDimension = null

[line 150]

Default row dimension

Tags:

access:

private

Type:

PHPExcel_Worksheet_RowDimension

[ Top ]

$_drawingCollection = null

[line 171]

Collection of drawings

Tags:

access:

private

Type:

PHPExcel_Worksheet_BaseDrawing[]

[ Top ]

$_freezePane = ''

[line 269]

Freeze pane

Tags:

access:

private

Type:

string

[ Top ]

$_hashIndex =

[line 2175]

Hash index

Tags:

access:

private

Type:

string

[ Top ]

$_headerFooter =

[line 199]

Page header/footer

Tags:

access:

private

Type:

PHPExcel_Worksheet_HeaderFooter

[ Top ]

$_hyperlinkCollection = array()

[line 353]

Hyperlinks.

Hyperlinks. Indexed by cell coordinate, e.g. 'A1'

Tags:

access:

private

Type:

array

[ Top ]

$_mergeCells = array()

[line 248]

Collection of merged cell ranges

Tags:

access:

private

Type:

array

[ Top ]

$_pageMargins =

[line 192]

Page margins

Tags:

access:

private

Type:

PHPExcel_Worksheet_PageMargins

[ Top ]

$_pageSetup =

[line 185]

Page setup

Tags:

access:

private

Type:

PHPExcel_Worksheet_PageSetup

[ Top ]

$_parent =

[line 129]

Parent spreadsheet

Tags:

access:

private

Type:

PHPExcel

[ Top ]

$_printGridlines = false

[line 283]

Print gridlines?

Tags:

access:

private

Type:

boolean

[ Top ]

$_protectedCells = array()

[line 255]

Collection of protected cell ranges

Tags:

access:

private

Type:

array

[ Top ]

$_protection =

[line 213]

Protection

Tags:

access:

private

Type:

PHPExcel_Worksheet_Protection

[ Top ]

$_rightToLeft = false

[line 346]

Right-to-left?

Tags:

access:

private

Type:

boolean

[ Top ]

$_rowDimensions = array()

[line 143]

Collection of row dimensions

Tags:

access:

private

Type:

PHPExcel_Worksheet_RowDimension[]

[ Top ]

$_selectedCell = 'A1'

[line 311]

Selected cell

Tags:

access:

private

Type:

string

[ Top ]

$_sheetView =

[line 206]

Sheet view

Tags:

access:

private

Type:

PHPExcel_Worksheet_SheetView

[ Top ]

$_showGridlines = true

[line 276]

Show gridlines?

Tags:

access:

private

Type:

boolean

[ Top ]

$_showSummaryBelow = true

[line 290]

Show summary below? (Row/Column outline)

Tags:

access:

private

Type:

boolean

[ Top ]

$_showSummaryRight = true

[line 297]

Show summary right? (Row/Column outline)

Tags:

access:

private

Type:

boolean

[ Top ]

$_styles = array()

[line 220]

Collection of styles

Tags:

access:

private

Type:

PHPExcel_Style[]

[ Top ]

$_title =

[line 178]

Worksheet title

Tags:

access:

private

Type:

string

[ Top ]

$_xActiveCell = 'A1'

[line 318]

Temporary property used by style supervisor.

Temporary property used by style supervisor. Will be removed

Tags:

access:

private

Type:

string

[ Top ]

$_xSelectedCells = 'A1:A1'

[line 325]

Temporary property used by style supervisor.

Temporary property used by style supervisor. Will be removed

Tags:

access:

private

Type:

string

[ Top ]

static method extractSheetTitle [line 2211]

static mixed extractSheetTitle(
string
$pRange, [bool
$returnRange = false])

Extract worksheet title from range.

Extract worksheet title from range. Example: extractSheetTitle('test!A1') ==> 'A1' Example: extractSheetTitle('test!A1', true) ==> array('test', 'A1');

Tags:

access:

public

Parameters:

string	$pRange	Range to extract title from
bool	$returnRange	Return range? (see example)

[ Top ]

constructor __construct [line 368]

PHPExcel_Worksheet __construct(
[
$pParent = null], [string
$pTitle = 'Worksheet'])

Create a new worksheet

Tags:

access:

public

Parameters:

PHPExcel	$pParent
string	$pTitle

[ Top ]

method calculateColumnWidths [line 564]

PHPExcel_Worksheet; calculateColumnWidths(
[boolean
$calculateMergeCells = false])

Calculate widths for auto-size columns

Tags:

access:

public

Parameters:

boolean

$calculateMergeCells

Calculate merge cell width

[ Top ]

method calculateWorksheetDimension [line 552]

string calculateWorksheetDimension(
)

Calculate worksheet dimension

Tags:

return:	String containing the dimension of this worksheet
access:	public

[ Top ]

method cellExists [line 1018]

boolean cellExists(
[string
$pCoordinate = 'A1'])

Cell at a specific coordinate exists?

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCoordinate

Coordinate of the cell

[ Top ]

method cellExistsByColumnAndRow [line 1065]

boolean cellExistsByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0])

Cell at a specific coordinate by using numeric cell coordinates exists?

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

[ Top ]

method conditionalStylesExists [line 1194]

boolean conditionalStylesExists(
[string
$pCoordinate = 'A1'])

Do conditional styles exist for this cell?

Tags:

access:

public

Parameters:

string

$pCoordinate

[ Top ]

method copy [line 2358]

PHPExcel_Worksheet copy(
)

Copy worksheet (!= clone!)

Tags:

access:

public

[ Top ]

method dataValidationExists [line 2338]

boolean dataValidationExists(
[
$pCoordinate = 'A1'], string
$pCellCoordinate)

Data validation at a specific coordinate exists?

Tags:

access:

public

Parameters:

string	$pCellCoordinate
	$pCoordinate

[ Top ]

method duplicateStyle [line 1276]

PHPExcel_Worksheet duplicateStyle(
[
$pCellStyle = null], [string
$pRange = ''])

Duplicate cell style to a range of cells

Duplicate cell style to a range of cells Please note that this will overwrite existing cell styles for cells in range!

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Style	$pCellStyle	Cell style to duplicate
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

[ Top ]

method duplicateStyleArray [line 1344]

PHPExcel_Worksheet duplicateStyleArray(
[array
$pStyles = null], [string
$pRange = ''], [boolean
$pAdvanced = true])

Duplicate cell style array to a range of cells Please note that this will overwrite existing cell styles for cells in range, if they are in the styles array. cells to font bold, only include font bold in the styles array.

Duplicate cell style array to a range of cells Please note that this will overwrite existing cell styles for cells in range, if they are in the styles array. For example, if you decide to set a range of cells to font bold, only include font bold in the styles array.

Tags:

deprecated:
throws:	Exception
access:	public

Parameters:

array	$pStyles	Array containing style information
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
boolean	$pAdvanced	Advanced mode for setting borders.

[ Top ]

method freezePane [line 1638]

PHPExcel_Worksheet freezePane(
[string
$pCell = ''])

Freeze Pane

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCell

Cell (i.e. A1)

[ Top ]

method freezePaneByColumnAndRow [line 1659]

PHPExcel_Worksheet freezePaneByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Freeze Pane by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

method fromArray [line 2025]

PHPExcel_Worksheet fromArray(
[array
$source = null], [mixed
$nullValue = null], [
$pCell = 'A1'])

Fill worksheet from values in array

Tags:

throws:	Exception
access:	public

Parameters:

array	$source	Source array
mixed	$nullValue	Value treated as "null"
	$pCell

[ Top ]

method garbageCollect [line 2118]

PHPExcel_Worksheet garbageCollect(
)

Run PHPExcel garabage collector.

Tags:

access:

public

[ Top ]

method getAutoFilter [line 1577]

string getAutoFilter(
)

Get Autofilter Range

Tags:

access:

public

[ Top ]

method getBreaks [line 1391]

array[] getBreaks(
)

Get breaks

Tags:

access:

public

[ Top ]

method getCell [line 937]

PHPExcel_Cell getCell(
[string
$pCoordinate = 'A1'])

Get cell at a specific coordinate

Tags:

return:	Cell that was found
throws:	Exception
access:	public

Parameters:

string

$pCoordinate

Coordinate of the cell

[ Top ]

method getCellByColumnAndRow [line 994]

PHPExcel_Cell getCellByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0])

Get cell at a specific coordinate by using numeric cell coordinates

Tags:

return:	Cell that was found
access:	public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

[ Top ]

method getCellCollection [line 413]

PHPExcel_Cell[] getCellCollection(
[boolean
$pSorted = true])

Get collection of cells

Tags:

access:

public

Parameters:

boolean

$pSorted

Also sort the cell collection?

[ Top ]

method getColumnDimension [line 1095]

PHPExcel_Worksheet_ColumnDimension getColumnDimension(
[string
$pColumn = 'A'])

Get column dimension at a specific column

Tags:

access:

public

Parameters:

string

$pColumn

String index of the column

[ Top ]

method getColumnDimensionByColumn [line 1115]

PHPExcel_Worksheet_ColumnDimension getColumnDimensionByColumn(
[string
$pColumn = 0], string
$pRow)

Get column dimension at a specific column by using numeric cell coordinates

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

[ Top ]

method getColumnDimensions [line 484]

PHPExcel_Worksheet_ColumnDimension[] getColumnDimensions(
)

Get collection of column dimensions

Tags:

access:

public

[ Top ]

method getComment [line 1876]

PHPExcel_Comment getComment(
[string
$pCellCoordinate = 'A1'])

Get comment for cell

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCellCoordinate

Cell coordinate to get comment for

[ Top ]

method getCommentByColumnAndRow [line 1907]

PHPExcel_Comment getCommentByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Get comment for cell by using numeric cell coordinates

Tags:

access:

public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

method getComments [line 1864]

PHPExcel_Comment[] getComments(
)

Get comments

Tags:

access:

public

[ Top ]

method getConditionalStyles [line 1180]

PHPExcel_Style_Conditional[] getConditionalStyles(
[string
$pCoordinate = 'A1'])

Get conditional styles for a cell

Tags:

access:

public

Parameters:

string

$pCoordinate

[ Top ]

method getConditionalStylesCollection [line 1219]

array getConditionalStylesCollection(
)

Get collection of conditional styles

Tags:

access:

public

[ Top ]

method getDataValidation [line 2301]

void getDataValidation(
[string
$pCellCoordinate = 'A1'])

Get data validation

Tags:

access:

public

Parameters:

string

$pCellCoordinate

Cell coordinate to get data validation for

[ Top ]

method getDataValidationCollection [line 2348]

PHPExcel_Cell_DataValidation[] getDataValidationCollection(
)

Get collection of data validations

Tags:

access:

public

[ Top ]

method getDefaultColumnDimension [line 494]

PHPExcel_Worksheet_ColumnDimension getDefaultColumnDimension(
)

Get default column dimension

Tags:

access:

public

[ Top ]

method getDefaultRowDimension [line 474]

PHPExcel_Worksheet_RowDimension getDefaultRowDimension(
)

Get default row dimension

Tags:

access:

public

[ Top ]

method getDefaultStyle [line 1137]

PHPExcel_Style getDefaultStyle(
)

Get default style of workbork.

Tags:

deprecated:
throws:	Exception
access:	public

[ Top ]

method getDrawingCollection [line 504]

PHPExcel_Worksheet_BaseDrawing[] getDrawingCollection(
)

Get collection of drawings

Tags:

access:

public

[ Top ]

method getFreezePane [line 1626]

string getFreezePane(
)

Get Freeze Pane

Tags:

access:

public

[ Top ]

method getHashCode [line 2160]

string getHashCode(
)

Get hash code

Tags:

return:	Hash code
access:	public

[ Top ]

method getHashIndex [line 2185]

string getHashIndex(
)

Get hash index Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Tags:

return:	Hash index
access:	public

[ Top ]

method getHeaderFooter [line 737]

PHPExcel_Worksheet_HeaderFooter getHeaderFooter(
)

Get page header/footer

Tags:

access:

public

[ Top ]

method getHighestColumn [line 803]

string getHighestColumn(
)

Get highest worksheet column

Tags:

return:	Highest column name
access:	public

[ Top ]

method getHighestRow [line 842]

int getHighestRow(
)

Get highest worksheet row

Tags:

return:	Highest row number
access:	public

[ Top ]

method getHyperlink [line 2244]

void getHyperlink(
[string
$pCellCoordinate = 'A1'])

Get hyperlink

Tags:

access:

public

Parameters:

string

$pCellCoordinate

Cell coordinate to get hyperlink for

[ Top ]

method getHyperlinkCollection [line 2291]

PHPExcel_Cell_Hyperlink[] getHyperlinkCollection(
)

Get collection of hyperlinks

Tags:

access:

public

[ Top ]

method getMergeCells [line 1479]

array[] getMergeCells(
)

Get merge cells

Tags:

access:

public

[ Top ]

method getPageMargins [line 715]

PHPExcel_Worksheet_PageMargins getPageMargins(
)

Get page margins

Tags:

access:

public

[ Top ]

method getPageSetup [line 693]

PHPExcel_Worksheet_PageSetup getPageSetup(
)

Get page setup

Tags:

access:

public

[ Top ]

method getParent [line 607]

PHPExcel getParent(
)

Get parent

Tags:

access:

public

[ Top ]

method getPrintGridlines [line 1804]

boolean getPrintGridlines(
)

Print gridlines?

Tags:

access:

public

[ Top ]

method getProtectedCells [line 1567]

array[] getProtectedCells(
)

Get protected cells

Tags:

access:

public

[ Top ]

method getProtection [line 781]

PHPExcel_Worksheet_Protection getProtection(
)

Get Protection

Tags:

access:

public

[ Top ]

method getRightToLeft [line 2002]

boolean getRightToLeft(
)

Get right-to-left

Tags:

access:

public

[ Top ]

method getRowDimension [line 1076]

PHPExcel_Worksheet_RowDimension getRowDimension(
[int
$pRow = 0])

Get row dimension at a specific row

Tags:

access:

public

Parameters:

int

$pRow

Numeric index of the row

[ Top ]

method getRowDimensions [line 464]

PHPExcel_Worksheet_RowDimension[] getRowDimensions(
)

Get collection of row dimensions

Tags:

access:

public

[ Top ]

method getRowIterator [line 2109]

PHPExcel_Worksheet_RowIterator getRowIterator(
)

Get row iterator

Tags:

access:

public

[ Top ]

method getSelectedCell [line 1917]

string getSelectedCell(
)

Get selected cell

Tags:

access:

public

[ Top ]

method getSheetView [line 759]

PHPExcel_Worksheet_HeaderFooter getSheetView(
)

Get sheet view

Tags:

access:

public

[ Top ]

method getShowGridlines [line 1784]

boolean getShowGridlines(
)

Show gridlines?

Tags:

access:

public

[ Top ]

method getShowSummaryBelow [line 1824]

boolean getShowSummaryBelow(
)

Show summary below? (Row/Column outlining)

Tags:

access:

public

[ Top ]

method getShowSummaryRight [line 1844]

boolean getShowSummaryRight(
)

Show summary right? (Row/Column outlining)

Tags:

access:

public

[ Top ]

method getStyle [line 1163]

PHPExcel_Style getStyle(
[string
$pCellCoordinate = 'A1'])

Get style for cell

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCellCoordinate

Cell coordinate to get style for

[ Top ]

method getStyleByColumnAndRow [line 1244]

PHPExcel_Style getStyleByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Get style for cell by using numeric cell coordinates

Tags:

access:

public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

method getStyles [line 1125]

PHPExcel_Style[] getStyles(
)

Get styles

Tags:

access:

public

[ Top ]

method getTitle [line 636]

string getTitle(
)

Get title

Tags:

access:

public

[ Top ]

method getXActiveCell [line 1927]

string getXActiveCell(
)

Temporary method used by style supervisor.

Temporary method used by style supervisor. Will be removed

Tags:

access:

public

[ Top ]

method getXSelectedCells [line 1937]

string getXSelectedCells(
)

Temporary method used by style supervisor.

Temporary method used by style supervisor. Will be removed

Tags:

access:

public

[ Top ]

method hyperlinkExists [line 2281]

boolean hyperlinkExists(
[
$pCoordinate = 'A1'], string
$pCellCoordinate)

Hyperlink at a specific coordinate exists?

Tags:

access:

public

Parameters:

string	$pCellCoordinate
	$pCoordinate

[ Top ]

method insertNewColumnBefore [line 1700]

PHPExcel_Worksheet insertNewColumnBefore(
[int
$pBefore = 'A'], [int
$pNumCols = 1])

Insert a new column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pBefore	Insert before this one
int	$pNumCols	Number of columns to insert

[ Top ]

method insertNewColumnBeforeByIndex [line 1718]

PHPExcel_Worksheet insertNewColumnBeforeByIndex(
[int
$pBefore = 0], [int
$pNumCols = 1])

Insert a new column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pBefore	Insert before this one (numeric column coordinate of the cell)
int	$pNumCols	Number of columns to insert

[ Top ]

method insertNewRowBefore [line 1682]

PHPExcel_Worksheet insertNewRowBefore(
[int
$pBefore = 1], [int
$pNumRows = 1])

Insert a new row, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pBefore	Insert before this one
int	$pNumRows	Number of rows to insert

[ Top ]

method mergeCells [line 1403]

PHPExcel_Worksheet mergeCells(
[string
$pRange = 'A1:A1'])

Set merge on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell range (e.g. A1:E1)

[ Top ]

method mergeCellsByColumnAndRow [line 1427]

PHPExcel_Worksheet mergeCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0])

Set merge on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell

[ Top ]

method protectCells [line 1493]

PHPExcel_Worksheet protectCells(
[string
$pRange = 'A1'], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])

Set protection on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string	$pRange	Cell (e.g. A1) or cell range (e.g. A1:E1)
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

[ Top ]

method protectCellsByColumnAndRow [line 1518]

PHPExcel_Worksheet protectCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])

Set protection on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

[ Top ]

method rebindParent [line 617]

PHPExcel_Worksheet rebindParent(

$parent)

Re-bind parent

Tags:

access:

public

Parameters:

PHPExcel

$parent

[ Top ]

method refreshColumnDimensions [line 514]

PHPExcel_Worksheet refreshColumnDimensions(
)

Refresh column dimensions

Tags:

access:

public

[ Top ]

method refreshRowDimensions [line 533]

PHPExcel_Worksheet refreshRowDimensions(
)

Refresh row dimensions

Tags:

access:

public

[ Top ]

method removeColumn [line 1752]

PHPExcel_Worksheet removeColumn(
[int
$pColumn = 'A'], [int
$pNumCols = 1])

Remove a column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Remove starting with this one
int	$pNumCols	Number of columns to remove

[ Top ]

method removeColumnByIndex [line 1771]

PHPExcel_Worksheet removeColumnByIndex(
[int
$pColumn = 0], [int
$pNumCols = 1])

Remove a column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Remove starting with this one (numeric column coordinate of the cell)
int	$pNumCols	Number of columns to remove

[ Top ]

method removeConditionalStyles [line 1208]

PHPExcel_Worksheet removeConditionalStyles(
[string
$pCoordinate = 'A1'])

Removes conditional styles for a cell

Tags:

access:

public

Parameters:

string

$pCoordinate

[ Top ]

method removeRow [line 1734]

PHPExcel_Worksheet removeRow(
[int
$pRow = 1], [int
$pNumRows = 1])

Delete a row, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pRow	Remove starting with this one
int	$pNumRows	Number of rows to remove

[ Top ]

method setAutoFilter [line 1589]

PHPExcel_Worksheet setAutoFilter(
[string
$pRange = ''])

Set Autofilter Range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell range (i.e. A1:E10)

[ Top ]

method setAutoFilterByColumnAndRow [line 1612]

PHPExcel_Worksheet setAutoFilterByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0])

Set Autofilter Range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the second cell
int	$pRow2	Numeric row coordinate of the second cell

[ Top ]

method setBreak [line 1358]

PHPExcel_Worksheet setBreak(
[string
$pCell = 'A1'], [int
$pBreak = PHPExcel_Worksheet::BREAK_NONE])

Set break on a cell

Tags:

throws:	Exception
access:	public

Parameters:

string	$pCell	Cell coordinate (e.g. A1)
int	$pBreak	Break type (type of PHPExcel_Worksheet::BREAK_*)

[ Top ]

method setBreakByColumnAndRow [line 1381]

PHPExcel_Worksheet setBreakByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0], [int
$pBreak = PHPExcel_Worksheet::BREAK_NONE])

Set break on a cell by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell
int	$pBreak	Break type (type of PHPExcel_Worksheet::BREAK_*)

[ Top ]

method setCellValue [line 880]

PHPExcel_Worksheet setCellValue(
[string
$pCoordinate = 'A1'], [mixed
$pValue = null])

Set a cell value

Tags:

access:

public

Parameters:

string	$pCoordinate	Coordinate of the cell
mixed	$pValue	Value of the cell

[ Top ]

method setCellValueByColumnAndRow [line 896]

PHPExcel_Worksheet setCellValueByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0], [mixed
$pValue = null])

Set a cell value by using numeric cell coordinates

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell
mixed	$pValue	Value of the cell

[ Top ]

method setCellValueExplicit [line 909]

PHPExcel_Worksheet setCellValueExplicit(
[string
$pCoordinate = 'A1'], [mixed
$pValue = null], [string
$pDataType = PHPExcel_Cell_DataType::TYPE_STRING])

Set a cell value

Tags:

access:

public

Parameters:

string	$pCoordinate	Coordinate of the cell
mixed	$pValue	Value of the cell
string	$pDataType	Explicit data type

[ Top ]

method setCellValueExplicitByColumnAndRow [line 925]

PHPExcel_Worksheet setCellValueExplicitByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0], [mixed
$pValue = null], [string
$pDataType = PHPExcel_Cell_DataType::TYPE_STRING])

Set a cell value by using numeric cell coordinates

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell
mixed	$pValue	Value of the cell
string	$pDataType	Explicit data type

[ Top ]

method setConditionalStyles [line 1231]

PHPExcel_Worksheet setConditionalStyles(
[$pCoordinate
$pCoordinate = 'A1'], $pValue
$pValue)

Set conditional styles

Tags:

access:

public

Parameters:

$pCoordinate	$pCoordinate	string E.g. 'A1'
$pValue	$pValue	PHPExcel_Style_Conditional[]

[ Top ]

method setDataValidation [line 2321]

PHPExcel_Worksheet setDataValidation(
[string
$pCellCoordinate = 'A1'], [
$pDataValidation = null])

Set data validation

Tags:

access:

public

Parameters:

string	$pCellCoordinate	Cell coordinate to insert data validation
PHPExcel_Cell_DataValidation	$pDataValidation

[ Top ]

method setDefaultStyle [line 1150]

PHPExcel_Worksheet setDefaultStyle(

$value)

Set default style - should only be used by PHPExcel_IReader implementations!

Tags:

deprecated:
throws:	Exception
access:	public

Parameters:

PHPExcel_Style

$value

[ Top ]

method setHashIndex [line 2197]

void setHashIndex(
string
$value)

Set hash index Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Tags:

access:

public

Parameters:

string

$value

Hash index

[ Top ]

method setHeaderFooter [line 748]

PHPExcel_Worksheet setHeaderFooter(
PHPExcel_Worksheet_HeaderFooter
$pValue)

Set page header/footer

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_HeaderFooter

$pValue

[ Top ]

method setHyperlink [line 2264]

PHPExcel_Worksheet setHyperlink(
[string
$pCellCoordinate = 'A1'], [
$pHyperlink = null])

Set hyperlnk

Tags:

access:

public

Parameters:

string	$pCellCoordinate	Cell coordinate to insert hyperlink
PHPExcel_Cell_Hyperlink	$pHyperlink

[ Top ]

method setPageMargins [line 726]

PHPExcel_Worksheet setPageMargins(
PHPExcel_Worksheet_PageMargins
$pValue)

Set page margins

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_PageMargins

$pValue

[ Top ]

method setPageSetup [line 704]

PHPExcel_Worksheet setPageSetup(
PHPExcel_Worksheet_PageSetup
$pValue)

Set page setup

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_PageSetup

$pValue

[ Top ]

method setPrintGridlines [line 1814]

PHPExcel_Worksheet setPrintGridlines(
[boolean
$pValue = false])

Set print gridlines

Tags:

access:

public

Parameters:

boolean

$pValue

Print gridlines (true/false)

[ Top ]

method setProtection [line 792]

PHPExcel_Worksheet setProtection(
PHPExcel_Worksheet_Protection
$pValue)

Set Protection

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_Protection

$pValue

[ Top ]

method setRightToLeft [line 2012]

PHPExcel_Worksheet setRightToLeft(
[boolean
$value = false])

Set right-to-left

Tags:

access:

public

Parameters:

boolean

$value

Right-to-left true/false

[ Top ]

method setSelectedCell [line 1949]

PHPExcel_Worksheet setSelectedCell(
[string
$pCell = ''])

Selected cell

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCell

Cell (i.e. A1)

[ Top ]

method setSelectedCellByColumnAndRow [line 1992]

PHPExcel_Worksheet setSelectedCellByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Selected cell by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

method setSharedStyle [line 1260]

PHPExcel_Worksheet setSharedStyle(
[
$pSharedCellStyle = null], [string
$pRange = ''])

Set shared cell style to a range of cells

Set shared cell style to a range of cells Please note that this will overwrite existing cell styles for cells in range!

Tags:

deprecated:
throws:	Exception
access:	public

Parameters:

PHPExcel_Style	$pSharedCellStyle	Cell style to share
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

[ Top ]

method setSheetView [line 770]

PHPExcel_Worksheet setSheetView(
PHPExcel_Worksheet_SheetView
$pValue)

Set sheet view

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_SheetView

$pValue

[ Top ]

method setShowGridlines [line 1794]

PHPExcel_Worksheet setShowGridlines(
[boolean
$pValue = false])

Set show gridlines

Tags:

access:

public

Parameters:

boolean

$pValue

Show gridlines (true/false)

[ Top ]

method setShowSummaryBelow [line 1834]

PHPExcel_Worksheet setShowSummaryBelow(
[boolean
$pValue = true])

Set show summary below

Tags:

access:

public

Parameters:

boolean

$pValue

Show summary below (true/false)

[ Top ]

method setShowSummaryRight [line 1854]

PHPExcel_Worksheet setShowSummaryRight(
[boolean
$pValue = true])

Set show summary right

Tags:

access:

public

Parameters:

boolean

$pValue

Show summary right (true/false)

[ Top ]

method setTitle [line 648]

PHPExcel_Worksheet setTitle(
[string
$pValue = 'Worksheet'])

Set title

Tags:

throws:	Exception
access:	public

Parameters:

string

$pValue

String containing the dimension of this worksheet

[ Top ]

method setXSelectedCells [line 1969]

PHPExcel_Worksheet setXSelectedCells(
[
$pCoordinate = 'A1:A1'], string
$pCell)

Temporary method used by style supervisor.

Temporary method used by style supervisor. Will be removed

Tags:

throws:	Exception
access:	public

Parameters:

string	$pCell	Cell (i.e. A1)
	$pCoordinate

[ Top ]

method sortCellCollection [line 428]

PHPExcel_Worksheet sortCellCollection(
)

Sort collection of cells

Tags:

access:

public

[ Top ]

method toArray [line 2060]

array toArray(
[mixed
$nullValue = null], [boolean
$calculateFormulas = true])

Create array from worksheet

Tags:

access:

public

Parameters:

mixed	$nullValue	Value treated as "null"
boolean	$calculateFormulas	Should formulas be calculated?

[ Top ]

method unfreezePane [line 1669]

PHPExcel_Worksheet unfreezePane(
)

Unfreeze Pane

Tags:

access:

public

[ Top ]

method unmergeCells [line 1440]

PHPExcel_Worksheet unmergeCells(
[string
$pRange = 'A1:A1'])

Remove merge on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell range (e.g. A1:E1)

[ Top ]

method unmergeCellsByColumnAndRow [line 1468]

PHPExcel_Worksheet unmergeCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0])

Remove merge on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell

[ Top ]

method unprotectCells [line 1531]

PHPExcel_Worksheet unprotectCells(
[string
$pRange = 'A1'])

Remove protection on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell (e.g. A1) or cell range (e.g. A1:E1)

[ Top ]

method unprotectCellsByColumnAndRow [line 1556]

PHPExcel_Worksheet unprotectCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])

Remove protection on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

[ Top ]

method __clone [line 2367]

void __clone(
)

Implement PHP __clone to create a deep clone, not just a shallow copy.

Tags:

access:

public

[ Top ]

Class: PHPExcel_Worksheet

Class Overview

Author(s):

Copyright:

Variables

Constants

Methods

Class Details

Tags:

Class Variables

$_autoFilter = ''

Tags:

$_breaks = array()

Tags:

$_cachedHighestColumn = null

Tags:

$_cachedHighestRow = null

Tags:

$_cellCollection = array()

Tags:

$_cellCollectionIsSorted = false

Tags:

$_columnDimensions = array()

Tags:

$_comments = array()

Tags:

$_conditionalStylesCollection = array()

Tags:

$_dataValidationCollection = array()

Tags:

$_defaultColumnDimension = null

Tags:

$_defaultRowDimension = null

Tags:

$_drawingCollection = null

Tags:

$_freezePane = ''

Tags:

$_hashIndex =

Tags:

$_headerFooter =

Tags:

$_hyperlinkCollection = array()

Tags:

$_mergeCells = array()

Tags:

$_pageMargins =

Tags:

$_pageSetup =

Tags:

$_parent =

Tags:

$_printGridlines = false

Tags:

$_protectedCells = array()

Tags:

$_protection =

Tags:

$_rightToLeft = false

Tags:

$_rowDimensions = array()

Tags:

$_selectedCell = 'A1'

Tags:

$_sheetView =

Tags:

$_showGridlines = true

Tags:

$_showSummaryBelow = true

Tags:

$_showSummaryRight = true

Tags:

$_styles = array()

Tags:

$_title =

Tags:

$_xActiveCell = 'A1'

Tags:

$_xSelectedCells = 'A1:A1'

Tags: