\PHPExcel_NamedRange

PHPExcel_NamedRange

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
getName()
setName()
getWorksheet()
setWorksheet()
getRange()
setRange()
getLocalOnly()
setLocalOnly()
getScope()
setScope()
resolveRange()
__clone()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$name
$worksheet
$range
$localOnly
$scope
N/A

Properties

$name

$name : string

Range name

Type

string

$worksheet

$worksheet : \PHPExcel_Worksheet

Worksheet on which the named range can be resolved

Type

\PHPExcel_Worksheet

$range

$range : string

Range of the referenced cells

Type

string

$localOnly

$localOnly : boolean

Is the named range local? (i.e. can only be used on $this->worksheet)

Type

boolean

Methods

__construct()

__construct(string  $pName = null, \PHPExcel_Worksheet  $pWorksheet, string  $pRange = 'A1', boolean  $pLocalOnly = false, \PHPExcel_Worksheet|null  $pScope = null) 

Create a new NamedRange

Parameters

string $pName
\PHPExcel_Worksheet $pWorksheet
string $pRange
boolean $pLocalOnly
\PHPExcel_Worksheet|null $pScope

Scope. Only applies when $pLocalOnly = true. Null for global scope.

Throws

\PHPExcel_Exception

getName()

getName() : string

Get name

Returns

string

setName()

setName(string  $value = null) : \PHPExcel_NamedRange

Set name

Parameters

string $value

Returns

\PHPExcel_NamedRange

getWorksheet()

getWorksheet() : \PHPExcel_Worksheet

Get worksheet

Returns

\PHPExcel_Worksheet

getRange()

getRange() : string

Get range

Returns

string

setRange()

setRange(string  $value = null) : \PHPExcel_NamedRange

Set range

Parameters

string $value

Returns

\PHPExcel_NamedRange

getLocalOnly()

getLocalOnly() : boolean

Get localOnly

Returns

boolean

setLocalOnly()

setLocalOnly(boolean  $value = false) : \PHPExcel_NamedRange

Set localOnly

Parameters

boolean $value

Returns

\PHPExcel_NamedRange

resolveRange()

resolveRange(string  $pNamedRange = '', \PHPExcel_Worksheet|null  $pSheet) : \PHPExcel_NamedRange

Resolve a named range to a regular cell range

Parameters

string $pNamedRange

Named range

\PHPExcel_Worksheet|null $pSheet

Scope. Use null for global scope

Returns

\PHPExcel_NamedRange

__clone()

__clone() 

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