PHPExcel_Worksheet
[ class tree: PHPExcel_Worksheet ] [ index: PHPExcel_Worksheet ] [ all elements ]
Packages:
default
com-tecnick-tcpdf
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Best_Fit
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
BaseDrawing.php
CellIterator.php
ColumnDimension.php
HeaderFooter.php
HeaderFooterDrawing.php
MemoryDrawing.php
PageMargins.php
PageSetup.php
Protection.php
Row.php
RowDimension.php
RowIterator.php
SheetView.php
Worksheet.php

Classes:
PHPExcel_Worksheet
PHPExcel_Worksheet_BaseDrawing
PHPExcel_Worksheet_CellIterator
PHPExcel_Worksheet_ColumnDimension
PHPExcel_Worksheet_HeaderFooter
PHPExcel_Worksheet_HeaderFooterDrawing
PHPExcel_Worksheet_MemoryDrawing
PHPExcel_Worksheet_PageMargins
PHPExcel_Worksheet_PageSetup
PHPExcel_Worksheet_Protection
PHPExcel_Worksheet_Row
PHPExcel_Worksheet_RowDimension
PHPExcel_Worksheet_RowIterator
PHPExcel_Worksheet_SheetView

Class: PHPExcel_Worksheet

Source Location: /PHPExcel/Worksheet.php

Class Overview




PHPExcel_Worksheet




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 120]

PHPExcel_Worksheet

PHPExcel_Worksheet





Tags:





  

    copyright:  Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
$_activeCell =  'A1'

	
[line 326]

  Active cell.

Active cell. (Only one!)





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_autoFilter =  ''

	
[line 277]

  Autofilter Range

Autofilter Range





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_breaks = array()

	
[line 256]

  Collection of breaks

Collection of breaks





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_cachedHighestColumn =  'A'

	
[line 340]

  Cached highest column

Cached highest column





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_cachedHighestRow =  1

	
[line 347]

  Cached highest row

Cached highest row





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_cellCollection = array()

	
[line 144]

  Collection of cells

Collection of cells





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Cell[]
    

      

	



	
[ Top ]


	
	

	
$_cellCollectionIsSorted =  false

	
[line 249]

  Is the current cell collection sorted already?

Is the current cell collection sorted already?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_columnDimensions = array()

	
[line 165]

  Collection of column dimensions

Collection of column dimensions





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_ColumnDimension[]
    

      

	



	
[ Top ]


	
	

	
$_comments = array()

	
[line 319]

  Collection of comments

Collection of comments





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Comment[]
    

      

	



	
[ Top ]


	
	

	
$_conditionalStylesCollection = array()

	
[line 242]

  Conditional styles.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_dataValidationCollection = array()

	
[line 368]

  Data validation objects.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_defaultColumnDimension =  null

	
[line 172]

  Default column dimension

Default column dimension





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_ColumnDimension
    

      

	



	
[ Top ]


	
	

	
$_defaultRowDimension =  null

	
[line 158]

  Default row dimension

Default row dimension





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_RowDimension
    

      

	



	
[ Top ]


	
	

	
$_drawingCollection =  null

	
[line 179]

  Collection of drawings

Collection of drawings





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_BaseDrawing[]
    

      

	



	
[ Top ]


	
	

	
$_freezePane =  ''

	
[line 284]

  Freeze pane

Freeze pane





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_headerFooter = 

	
[line 214]

  Page header/footer

Page header/footer





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_HeaderFooter
    

      

	



	
[ Top ]


	
	

	
$_hyperlinkCollection = array()

	
[line 361]

  Hyperlinks.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_mergeCells = array()

	
[line 263]

  Collection of merged cell ranges

Collection of merged cell ranges





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_pageMargins = 

	
[line 207]

  Page margins

Page margins





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_PageMargins
    

      

	



	
[ Top ]


	
	

	
$_pageSetup = 

	
[line 200]

  Page setup

Page setup





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_PageSetup
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 137]

  Parent spreadsheet

Parent spreadsheet





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel
    

      

	



	
[ Top ]


	
	

	
$_printGridlines =  false

	
[line 298]

  Print gridlines?

Print gridlines?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_protectedCells = array()

	
[line 270]

  Collection of protected cell ranges

Collection of protected cell ranges





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_protection = 

	
[line 228]

  Protection

Protection





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_Protection
    

      

	



	
[ Top ]


	
	

	
$_rightToLeft =  false

	
[line 354]

  Right-to-left?

Right-to-left?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_rowDimensions = array()

	
[line 151]

  Collection of row dimensions

Collection of row dimensions





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_RowDimension[]
    

      

	



	
[ Top ]


	
	

	
$_selectedCells =  'A1'

	
[line 333]

  Selected cells

Selected cells





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_sheetState = 

	
[line 193]

  Sheet state

Sheet state





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_sheetView = 

	
[line 221]

  Sheet view

Sheet view





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_SheetView
    

      

	



	
[ Top ]


	
	

	
$_showGridlines =  true

	
[line 291]

  Show gridlines?

Show gridlines?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_showSummaryBelow =  true

	
[line 305]

  Show summary below? (Row/Column outline)

Show summary below? (Row/Column outline)





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_showSummaryRight =  true

	
[line 312]

  Show summary right? (Row/Column outline)

Show summary right? (Row/Column outline)





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_styles = array()

	
[line 235]

  Collection of styles

Collection of styles





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style[]
    

      

	



	
[ Top ]


	
	

	
$_tabColor = 

	
[line 375]

  Tab color

Tab color





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Color
    

      

	



	
[ Top ]


	
	

	
$_title = 

	
[line 186]

  Worksheet title

Worksheet title





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method extractSheetTitle [line 2281]

	

    

    

		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 ]

  

  

	
	
static method _checkSheetTitle [line 430]

	

    

    

		static string _checkSheetTitle(
string
$pValue)
    

    


	
		Check sheet title for valid Excel syntax

Check sheet title for valid Excel syntax





Tags:





  

    return:  The valid string
  

  

    throws:  Exception
  

  

    access:  private
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        The string to check
      

        

    


        
[ Top ]

  


  

	
	
constructor __construct [line 383]

	

    

    

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

    


	
		Create a new worksheet

Create a new worksheet





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel  
        $pParent  
        
      

          

        string  
        $pTitle  
        
      

        

    


        
[ Top ]

  

  

	
	
method calculateColumnWidths [line 602]

	

    

    

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

    


	
		Calculate widths for auto-size columns

Calculate widths for auto-size columns





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $calculateMergeCells  
        Calculate merge cell width
      

        

    


        
[ Top ]

  

  

	
	
method calculateWorksheetDimension [line 590]

	

    

    

		string calculateWorksheetDimension(
)
    

    


	
		Calculate worksheet dimension

Calculate worksheet dimension





Tags:





  

    return:  String containing the dimension of this worksheet
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method cellExists [line 1057]

	

    

    

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

    


	
		Cell at a specific coordinate exists?

Cell at a specific coordinate exists?





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCoordinate  
        Coordinate of the cell
      

        

    


        
[ Top ]

  

  

	
	
method cellExistsByColumnAndRow [line 1104]

	

    

    

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

    


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

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 1242]

	

    

    

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

    


	
		Do conditional styles exist for this cell?

Do conditional styles exist for this cell?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCoordinate  
        
      

        

    


        
[ Top ]

  

  

	
	
method copy [line 2464]

	

    

    

		PHPExcel_Worksheet copy(
)
    

    


	
		Copy worksheet (!= clone!)

Copy worksheet (!= clone!)





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method dataValidationExists [line 2408]

	

    

    

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

    


	
		Data validation at a specific coordinate exists?

Data validation at a specific coordinate exists?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        
      

          

          
        $pCoordinate  
        
      

        

    


        
[ Top ]

  

  

	
	
method duplicateStyle [line 1324]

	

    

    

		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 1392]

	

    

    

		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 1699]

	

    

    

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

    


	
		Freeze Pane

Freeze Pane





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCell  
        Cell (i.e. A1)
      

        

    


        
[ Top ]

  

  

	
	
method freezePaneByColumnAndRow [line 1720]

	

    

    

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

    


	
		Freeze Pane by using numeric cell coordinates

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 2090]

	

    

    

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

    


	
		Fill worksheet from values in array

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 2183]

	

    

    

		PHPExcel_Worksheet garbageCollect(
)
    

    


	
		Run PHPExcel garabage collector.

Run PHPExcel garabage collector.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getActiveCell [line 1989]

	

    

    

		string getActiveCell(
)
    

    


	
		Get active cell

Get active cell





Tags:





  

    return:  Example: 'A1'
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getAutoFilter [line 1638]

	

    

    

		string getAutoFilter(
)
    

    


	
		Get Autofilter Range

Get Autofilter Range





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getBreaks [line 1439]

	

    

    

		array[] getBreaks(
)
    

    


	
		Get breaks

Get breaks





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getCell [line 948]

	

    

    

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

    


	
		Get cell at a specific coordinate

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 1030]

	

    

    

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

    


	
		Get cell at a specific coordinate by using numeric cell coordinates

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 451]

	

    

    

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

    


	
		Get collection of cells

Get collection of cells





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pSorted  
        Also sort the cell collection?
      

        

    


        
[ Top ]

  

  

	
	
method getColumnDimension [line 1136]

	

    

    

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

    


	
		Get column dimension at a specific column

Get column dimension at a specific column





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pColumn  
        String index of the column
      

        

    


        
[ Top ]

  

  

	
	
method getColumnDimensionByColumn [line 1158]

	

    

    

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

    


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

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 522]

	

    

    

		PHPExcel_Worksheet_ColumnDimension[] getColumnDimensions(
)
    

    


	
		Get collection of column dimensions

Get collection of column dimensions





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getComment [line 1937]

	

    

    

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

    


	
		Get comment for cell

Get comment for cell





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        Cell coordinate to get comment for
      

        

    


        
[ Top ]

  

  

	
	
method getCommentByColumnAndRow [line 1968]

	

    

    

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

    


	
		Get comment for cell by using numeric cell coordinates

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 1925]

	

    

    

		PHPExcel_Comment[] getComments(
)
    

    


	
		Get comments

Get comments





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getConditionalStyles [line 1228]

	

    

    

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

    


	
		Get conditional styles for a cell

Get conditional styles for a cell





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCoordinate  
        
      

        

    


        
[ Top ]

  

  

	
	
method getConditionalStylesCollection [line 1267]

	

    

    

		array getConditionalStylesCollection(
)
    

    


	
		Get collection of conditional styles

Get collection of conditional styles





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDataValidation [line 2371]

	

    

    

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

    


	
		Get data validation

Get data validation





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        Cell coordinate to get data validation for
      

        

    


        
[ Top ]

  

  

	
	
method getDataValidationCollection [line 2418]

	

    

    

		PHPExcel_Cell_DataValidation[] getDataValidationCollection(
)
    

    


	
		Get collection of data validations

Get collection of data validations





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDefaultColumnDimension [line 532]

	

    

    

		PHPExcel_Worksheet_ColumnDimension getDefaultColumnDimension(
)
    

    


	
		Get default column dimension

Get default column dimension





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDefaultRowDimension [line 512]

	

    

    

		PHPExcel_Worksheet_RowDimension getDefaultRowDimension(
)
    

    


	
		Get default row dimension

Get default row dimension





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDefaultStyle [line 1180]

	

    

    

		PHPExcel_Style getDefaultStyle(
)
    

    


	
		Get default style of workbork.

Get default style of workbork.





Tags:





  

    deprecated:  
  

  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDrawingCollection [line 542]

	

    

    

		PHPExcel_Worksheet_BaseDrawing[] getDrawingCollection(
)
    

    


	
		Get collection of drawings

Get collection of drawings





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFreezePane [line 1687]

	

    

    

		string getFreezePane(
)
    

    


	
		Get Freeze Pane

Get Freeze Pane





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 2261]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHeaderFooter [line 803]

	

    

    

		PHPExcel_Worksheet_HeaderFooter getHeaderFooter(
)
    

    


	
		Get page header/footer

Get page header/footer





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHighestColumn [line 869]

	

    

    

		string getHighestColumn(
)
    

    


	
		Get highest worksheet column

Get highest worksheet column





Tags:





  

    return:  Highest column name
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHighestRow [line 879]

	

    

    

		int getHighestRow(
)
    

    


	
		Get highest worksheet row

Get highest worksheet row





Tags:





  

    return:  Highest row number
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHyperlink [line 2314]

	

    

    

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

    


	
		Get hyperlink

Get hyperlink





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        Cell coordinate to get hyperlink for
      

        

    


        
[ Top ]

  

  

	
	
method getHyperlinkCollection [line 2361]

	

    

    

		PHPExcel_Cell_Hyperlink[] getHyperlinkCollection(
)
    

    


	
		Get collection of hyperlinks

Get collection of hyperlinks





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getMergeCells [line 1527]

	

    

    

		array[] getMergeCells(
)
    

    


	
		Get merge cells array.

Get merge cells array.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPageMargins [line 781]

	

    

    

		PHPExcel_Worksheet_PageMargins getPageMargins(
)
    

    


	
		Get page margins

Get page margins





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPageSetup [line 759]

	

    

    

		PHPExcel_Worksheet_PageSetup getPageSetup(
)
    

    


	
		Get page setup

Get page setup





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getParent [line 656]

	

    

    

		PHPExcel getParent(
)
    

    


	
		Get parent

Get parent





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPrintGridlines [line 1865]

	

    

    

		boolean getPrintGridlines(
)
    

    


	
		Print gridlines?

Print gridlines?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getProtectedCells [line 1628]

	

    

    

		array[] getProtectedCells(
)
    

    


	
		Get protected cells

Get protected cells





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getProtection [line 847]

	

    

    

		PHPExcel_Worksheet_Protection getProtection(
)
    

    


	
		Get Protection

Get Protection





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRightToLeft [line 2067]

	

    

    

		boolean getRightToLeft(
)
    

    


	
		Get right-to-left

Get right-to-left





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRowDimension [line 1115]

	

    

    

		PHPExcel_Worksheet_RowDimension getRowDimension(
[int
$pRow = 0])
    

    


	
		Get row dimension at a specific row

Get row dimension at a specific row





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pRow  
        Numeric index of the row
      

        

    


        
[ Top ]

  

  

	
	
method getRowDimensions [line 502]

	

    

    

		PHPExcel_Worksheet_RowDimension[] getRowDimensions(
)
    

    


	
		Get collection of row dimensions

Get collection of row dimensions





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRowIterator [line 2174]

	

    

    

		PHPExcel_Worksheet_RowIterator getRowIterator(
)
    

    


	
		Get row iterator

Get row iterator





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSelectedCell [line 1979]

	

    

    

		string getSelectedCell(
)
    

    


	
		Get selected cell

Get selected cell





Tags:





  

    deprecated:  
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSelectedCells [line 1999]

	

    

    

		string getSelectedCells(
)
    

    


	
		Get selected cells

Get selected cells





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSheetState [line 739]

	

    

    

		string getSheetState(
)
    

    


	
		Get sheet state

Get sheet state





Tags:





  

    return:  Sheet state (visible, hidden, veryHidden)
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSheetView [line 825]

	

    

    

		PHPExcel_Worksheet_HeaderFooter getSheetView(
)
    

    


	
		Get sheet view

Get sheet view





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getShowGridlines [line 1845]

	

    

    

		boolean getShowGridlines(
)
    

    


	
		Show gridlines?

Show gridlines?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getShowSummaryBelow [line 1885]

	

    

    

		boolean getShowSummaryBelow(
)
    

    


	
		Show summary below? (Row/Column outlining)

Show summary below? (Row/Column outlining)





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getShowSummaryRight [line 1905]

	

    

    

		boolean getShowSummaryRight(
)
    

    


	
		Show summary right? (Row/Column outlining)

Show summary right? (Row/Column outlining)





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStyle [line 1211]

	

    

    

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

    


	
		Get style for cell

Get style for cell





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        Cell coordinate to get style for
      

        

    


        
[ Top ]

  

  

	
	
method getStyleByColumnAndRow [line 1292]

	

    

    

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

    


	
		Get style for cell by using numeric cell coordinates

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 1168]

	

    

    

		PHPExcel_Style[] getStyles(
)
    

    


	
		Get styles

Get styles





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTabColor [line 2428]

	

    

    

		PHPExcel_Style_Color getTabColor(
)
    

    


	
		Get tab color

Get tab color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTitle [line 685]

	

    

    

		string getTitle(
)
    

    


	
		Get title

Get title





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method hyperlinkExists [line 2351]

	

    

    

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

    


	
		Hyperlink at a specific coordinate exists?

Hyperlink at a specific coordinate exists?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        
      

          

          
        $pCoordinate  
        
      

        

    


        
[ Top ]

  

  

	
	
method insertNewColumnBefore [line 1761]

	

    

    

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

    


	
		Insert a new column, updating all possible related data

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 1779]

	

    

    

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

    


	
		Insert a new column, updating all possible related data

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 1743]

	

    

    

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

    


	
		Insert a new row, updating all possible related data

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 isTabColorSet [line 2454]

	

    

    

		boolean isTabColorSet(
)
    

    


	
		Tab color set?

Tab color set?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method mergeCells [line 1451]

	

    

    

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

    


	
		Set merge on a cell range

Set merge on a cell range





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pRange  
        Cell range (e.g. A1:E1)
      

        

    


        
[ Top ]

  

  

	
	
method mergeCellsByColumnAndRow [line 1475]

	

    

    

		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

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 1554]

	

    

    

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

    


	
		Set protection on a cell range

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 1579]

	

    

    

		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

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 666]

	

    

    

		PHPExcel_Worksheet rebindParent(

$parent)
    

    


	
		Re-bind parent

Re-bind parent





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel  
        $parent  
        
      

        

    


        
[ Top ]

  

  

	
	
method refreshColumnDimensions [line 552]

	

    

    

		PHPExcel_Worksheet refreshColumnDimensions(
)
    

    


	
		Refresh column dimensions

Refresh column dimensions





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method refreshRowDimensions [line 571]

	

    

    

		PHPExcel_Worksheet refreshRowDimensions(
)
    

    


	
		Refresh row dimensions

Refresh row dimensions





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method removeColumn [line 1813]

	

    

    

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

    


	
		Remove a column, updating all possible related data

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 1832]

	

    

    

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

    


	
		Remove a column, updating all possible related data

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 1256]

	

    

    

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

    


	
		Removes conditional styles for a cell

Removes conditional styles for a cell





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCoordinate  
        
      

        

    


        
[ Top ]

  

  

	
	
method removeRow [line 1795]

	

    

    

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

    


	
		Delete a row, updating all possible related data

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 resetTabColor [line 2441]

	

    

    

		PHPExcel_Worksheet resetTabColor(
)
    

    


	
		Reset tab color

Reset tab color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setAutoFilter [line 1650]

	

    

    

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

    


	
		Set Autofilter Range

Set Autofilter Range





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pRange  
        Cell range (i.e. A1:E10)
      

        

    


        
[ Top ]

  

  

	
	
method setAutoFilterByColumnAndRow [line 1673]

	

    

    

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

    


	
		Set Autofilter Range by using numeric cell coordinates

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 1406]

	

    

    

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

    


	
		Set break on a cell

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 1429]

	

    

    

		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

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 891]

	

    

    

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

    


	
		Set a cell value

Set a cell value





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCoordinate  
        Coordinate of the cell
      

          

        mixed  
        $pValue  
        Value of the cell
      

        

    


        
[ Top ]

  

  

	
	
method setCellValueByColumnAndRow [line 907]

	

    

    

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

    


	
		Set a cell value by using numeric cell coordinates

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 920]

	

    

    

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

    


	
		Set a cell value

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 936]

	

    

    

		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

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 1279]

	

    

    

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

    


	
		Set conditional styles

Set conditional styles





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        $pCoordinate  
        $pCoordinate  
        string E.g. 'A1'
      

          

        $pValue  
        $pValue  
        PHPExcel_Style_Conditional[]
      

        

    


        
[ Top ]

  

  

	
	
method setDataValidation [line 2391]

	

    

    

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

    


	
		Set data validation

Set data validation





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        Cell coordinate to insert data validation
      

          

        PHPExcel_Cell_DataValidation  
        $pDataValidation  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDefaultStyle [line 1193]

	

    

    

		PHPExcel_Worksheet setDefaultStyle(

$pValue, PHPExcel_Style
$value)
    

    


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

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





Tags:





  

    deprecated:  
  

  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style  
        $value  
        
      

          

        PHPExcel_Style  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHeaderFooter [line 814]

	

    

    

		PHPExcel_Worksheet setHeaderFooter(
PHPExcel_Worksheet_HeaderFooter
$pValue)
    

    


	
		Set page header/footer

Set page header/footer





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet_HeaderFooter  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHyperlink [line 2334]

	

    

    

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

    


	
		Set hyperlnk

Set hyperlnk





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCellCoordinate  
        Cell coordinate to insert hyperlink
      

          

        PHPExcel_Cell_Hyperlink  
        $pHyperlink  
        
      

        

    


        
[ Top ]

  

  

	
	
method setMergeCells [line 1538]

	

    

    

		void setMergeCells(
[array
$pValue = array()])
    

    


	
		Set merge cells array for the entire sheet. a single cell range.

Set merge cells array for the entire sheet. Use instead mergeCells() to merge a single cell range.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setPageMargins [line 792]

	

    

    

		PHPExcel_Worksheet setPageMargins(
PHPExcel_Worksheet_PageMargins
$pValue)
    

    


	
		Set page margins

Set page margins





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet_PageMargins  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setPageSetup [line 770]

	

    

    

		PHPExcel_Worksheet setPageSetup(
PHPExcel_Worksheet_PageSetup
$pValue)
    

    


	
		Set page setup

Set page setup





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet_PageSetup  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setPrintGridlines [line 1875]

	

    

    

		PHPExcel_Worksheet setPrintGridlines(
[boolean
$pValue = false])
    

    


	
		Set print gridlines

Set print gridlines





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        Print gridlines (true/false)
      

        

    


        
[ Top ]

  

  

	
	
method setProtection [line 858]

	

    

    

		PHPExcel_Worksheet setProtection(
PHPExcel_Worksheet_Protection
$pValue)
    

    


	
		Set Protection

Set Protection





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet_Protection  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setRightToLeft [line 2077]

	

    

    

		PHPExcel_Worksheet setRightToLeft(
[boolean
$value = false])
    

    


	
		Set right-to-left

Set right-to-left





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $value  
        Right-to-left true/false
      

        

    


        
[ Top ]

  

  

	
	
method setSelectedCell [line 2010]

	

    

    

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

    


	
		Selected cell

Selected cell





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCell  
        Cell (i.e. A1)
      

          

          
        $pCoordinate  
        
      

        

    


        
[ Top ]

  

  

	
	
method setSelectedCellByColumnAndRow [line 2057]

	

    

    

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

    


	
		Selected cell by using numeric cell coordinates

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 setSelectedCells [line 2022]

	

    

    

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

    


	
		Select a range of cells.

Select a range of cells.





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pCoordinate  
        Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6'
      

        

    


        
[ Top ]

  

  

	
	
method setSharedStyle [line 1308]

	

    

    

		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 setSheetState [line 749]

	

    

    

		PHPExcel_Worksheet setSheetState(
[string
$value = PHPExcel_Worksheet::SHEETSTATE_VISIBLE])
    

    


	
		Set sheet state

Set sheet state





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        Sheet state (visible, hidden, veryHidden)
      

        

    


        
[ Top ]

  

  

	
	
method setSheetView [line 836]

	

    

    

		PHPExcel_Worksheet setSheetView(
PHPExcel_Worksheet_SheetView
$pValue)
    

    


	
		Set sheet view

Set sheet view





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet_SheetView  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setShowGridlines [line 1855]

	

    

    

		PHPExcel_Worksheet setShowGridlines(
[boolean
$pValue = false])
    

    


	
		Set show gridlines

Set show gridlines





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        Show gridlines (true/false)
      

        

    


        
[ Top ]

  

  

	
	
method setShowSummaryBelow [line 1895]

	

    

    

		PHPExcel_Worksheet setShowSummaryBelow(
[boolean
$pValue = true])
    

    


	
		Set show summary below

Set show summary below





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        Show summary below (true/false)
      

        

    


        
[ Top ]

  

  

	
	
method setShowSummaryRight [line 1915]

	

    

    

		PHPExcel_Worksheet setShowSummaryRight(
[boolean
$pValue = true])
    

    


	
		Set show summary right

Set show summary right





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        Show summary right (true/false)
      

        

    


        
[ Top ]

  

  

	
	
method setTitle [line 696]

	

    

    

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

    


	
		Set title

Set title





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        String containing the dimension of this worksheet
      

        

    


        
[ Top ]

  

  

	
	
method sortCellCollection [line 466]

	

    

    

		PHPExcel_Worksheet sortCellCollection(
)
    

    


	
		Sort collection of cells

Sort collection of cells





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method toArray [line 2125]

	

    

    

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

    


	
		Create array from worksheet

Create array from worksheet





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $nullValue  
        Value treated as "null"
      

          

        boolean  
        $calculateFormulas  
        Should formulas be calculated?
      

        

    


        
[ Top ]

  

  

	
	
method unfreezePane [line 1730]

	

    

    

		PHPExcel_Worksheet unfreezePane(
)
    

    


	
		Unfreeze Pane

Unfreeze Pane





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method unmergeCells [line 1488]

	

    

    

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

    


	
		Remove merge on a cell range

Remove merge on a cell range





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pRange  
        Cell range (e.g. A1:E1)
      

        

    


        
[ Top ]

  

  

	
	
method unmergeCellsByColumnAndRow [line 1516]

	

    

    

		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

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 1592]

	

    

    

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

    


	
		Remove protection on a cell range

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 1617]

	

    

    

		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

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 2473]

	

    

    

		void __clone(
)
    

    


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

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





Tags:





  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
BREAK_COLUMN =  2

	
[line 125]

  
  

	
[ Top ]


	
	

	
BREAK_NONE =  0

	
[line 123]

  
  

	
[ Top ]


	
	

	
BREAK_ROW =  1

	
[line 124]

  
  

	
[ Top ]


	
	

	
SHEETSTATE_HIDDEN =  'hidden'

	
[line 129]

  
  

	
[ Top ]


	
	

	
SHEETSTATE_VERYHIDDEN =  'veryHidden'

	
[line 130]

  
  

	
[ Top ]


	
	

	
SHEETSTATE_VISIBLE =  'visible'

	
[line 128]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 11 Jan 2010 08:19:00 +0100 by phpDocumentor 1.4.1