class 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

Methods

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

Create a new NamedRange

string
getName()

Get name

setName(string $value = null)

Set name

setWorksheet(PHPExcel_Worksheet $value = null)

Set worksheet

string
getRange()

Get range

setRange(string $value = null)

Set range

bool
getLocalOnly()

Get localOnly

setLocalOnly(bool $value = false)

Set localOnly

getScope()

Get scope

resolveRange(string $pNamedRange = '', PHPExcel_Worksheet $pSheet)

Resolve a named range to a regular cell range

__clone()

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

Details

at line 84
__construct(string $pName = null, PHPExcel_Worksheet $pWorksheet, string $pRange = 'A1', bool $pLocalOnly = false, PHPExcel_Worksheet|null $pScope = null)

Create a new NamedRange

Parameters

string $pName
PHPExcel_Worksheet $pWorksheet
string $pRange
bool $pLocalOnly
PHPExcel_Worksheet|null $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope.

Exceptions

PHPExcel_Exception

at line 104
string getName()

Get name

Return Value

string

at line 115
PHPExcel_NamedRange setName(string $value = null)

Set name

Parameters

string $value

Return Value

PHPExcel_NamedRange

at line 143
PHPExcel_Worksheet getWorksheet()

Get worksheet

Return Value

PHPExcel_Worksheet

at line 154
PHPExcel_NamedRange setWorksheet(PHPExcel_Worksheet $value = null)

Set worksheet

Parameters

PHPExcel_Worksheet $value

Return Value

PHPExcel_NamedRange

at line 167
string getRange()

Get range

Return Value

string

at line 178
PHPExcel_NamedRange setRange(string $value = null)

Set range

Parameters

string $value

Return Value

PHPExcel_NamedRange

at line 191
bool getLocalOnly()

Get localOnly

Return Value

bool

at line 202
PHPExcel_NamedRange setLocalOnly(bool $value = false)

Set localOnly

Parameters

bool $value

Return Value

PHPExcel_NamedRange

at line 214
PHPExcel_Worksheet|null getScope()

Get scope

Return Value

PHPExcel_Worksheet|null

at line 225
PHPExcel_NamedRange setScope(PHPExcel_Worksheet $value = null)

Set scope

Parameters

PHPExcel_Worksheet $value

Return Value

PHPExcel_NamedRange

at line 239
static PHPExcel_NamedRange resolveRange(string $pNamedRange = '', PHPExcel_Worksheet $pSheet)

Resolve a named range to a regular cell range

Parameters

string $pNamedRange Named range
PHPExcel_Worksheet $pSheet Scope. Use null for global scope

Return Value

PHPExcel_NamedRange

at line 247
__clone()

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