PHPExcel

# Class: PHPExcel_NamedRange Source Location: /PHPExcel/NamedRange.php
### Class Overview
PHPExcel_NamedRange #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_localOnly $_name $_range $_worksheet | ### Methods __construct getLocalOnly getName getRange getWorksheet resolveRange setLocalOnly setName setRange setWorksheet __clone
### Class Details [line 54] PHPExcel_NamedRange PHPExcel_NamedRange #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_localOnly = [line 82] Is the named range local? (i. Is the named range local? (i.e. can only be used on $this->_worksheet) #### Tags:
access: | private
Type: | bool
[ Top ] #### $_name = [line 61] Range name Range name #### Tags:
access: | private
Type: | string
[ Top ] #### $_range = [line 75] Range of the referenced cells Range of the referenced cells #### Tags:
access: | private
Type: | string
[ Top ] #### $_worksheet = [line 68] Worksheet on which the named range can be resolved Worksheet on which the named range can be resolved #### Tags:
access: | private
Type: | PHPExcel_Worksheet
[ Top ] ### Class Methods ### static method resolveRange [line 214]
`static PHPExcel_NamedRange resolveRange( [string $pNamedRange = ''], $pSheet)`
Resolve a named range to a regular cell range Resolve a named range to a regular cell range #### Tags:
access: | public
#### Parameters:
string | $pNamedRange | Named range
PHPExcel_Worksheet | $pSheet | Worksheet
[ Top ] ### constructor __construct [line 92]
`PHPExcel_NamedRange __construct( [string $pName = null], $pWorksheet, [string $pRange = 'A1'], [bool $pLocalOnly = false])`
Create a new NamedRange Create a new NamedRange #### Tags:
access: | public
#### Parameters:
string | $pName |
PHPExcel_Worksheet | $pWorksheet |
string | $pRange |
bool | $pLocalOnly |
[ Top ] ### method getLocalOnly [line 192]
`bool getLocalOnly( )`
Get localOnly Get localOnly #### Tags:
access: | public
[ Top ] ### method getName [line 111]
`string getName( )`
Get name Get name #### Tags:
access: | public
[ Top ] ### method getRange [line 170]
`string getRange( )`
Get range Get range #### Tags:
access: | public
[ Top ] ### method getWorksheet [line 148]
`PHPExcel_Worksheet getWorksheet( )`
Get worksheet Get worksheet #### Tags:
access: | public
[ Top ] ### method setLocalOnly [line 202]
`PHPExcel_NamedRange setLocalOnly( [bool $value = false])`
Set localOnly Set localOnly #### Tags:
access: | public
#### Parameters:
bool | $value |
[ Top ] ### method setName [line 121]
`PHPExcel_NamedRange setName( [string $value = null])`
Set name Set name #### Tags:
access: | public
#### Parameters:
string | $value |
[ Top ] ### method setRange [line 180]
`PHPExcel_NamedRange setRange( [string $value = null])`
Set range Set range #### Tags:
access: | public
#### Parameters:
string | $value |
[ Top ] ### method setWorksheet [line 158]
`PHPExcel_NamedRange setWorksheet( [ $value = null])`
Set worksheet Set worksheet #### Tags:
access: | public
#### Parameters:
PHPExcel_Worksheet | $value |
[ Top ] ### method __clone [line 221]
`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 ] Documentation generated on Mon, 11 Jan 2010 08:12:11 +0100 by phpDocumentor 1.4.1