class PHPExcel_Comment implements PHPExcel_IComparable

PHPExcel_Comment

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()

Create a new PHPExcel_Comment

string
getAuthor()

Get Author

setAuthor(string $pValue = '')

Set Author

getText()

Get Rich text comment

setText(PHPExcel_RichText $pValue)

Set Rich text comment

string
getWidth()

Get comment width (CSS style, i.e. XXpx or YYpt)

setWidth(string $value = '96pt')

Set comment width (CSS style, i.e. XXpx or YYpt)

string
getHeight()

Get comment height (CSS style, i.e. XXpx or YYpt)

setHeight(string $value = '55.5pt')

Set comment height (CSS style, i.e. XXpx or YYpt)

string
getMarginLeft()

Get left margin (CSS style, i.e. XXpx or YYpt)

setMarginLeft(string $value = '59.25pt')

Set left margin (CSS style, i.e. XXpx or YYpt)

string
getMarginTop()

Get top margin (CSS style, i.e. XXpx or YYpt)

setMarginTop(string $value = '1.5pt')

Set top margin (CSS style, i.e. XXpx or YYpt)

boolean
getVisible()

Is the comment visible by default?

setVisible(boolean $value = false)

Set comment default visibility

setAlignment(string $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL)

Set Alignment

string
getAlignment()

Get Alignment

string
getHashCode()

Get hash code

__clone()

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

string
__toString()

Convert to string

Details

at line 107
__construct()

Create a new PHPExcel_Comment

Exceptions

PHPExcel_Exception

at line 121
string getAuthor()

Get Author

Return Value

string

at line 132
PHPExcel_Comment setAuthor(string $pValue = '')

Set Author

Parameters

string $pValue

Return Value

PHPExcel_Comment

at line 143
PHPExcel_RichText getText()

Get Rich text comment

Return Value

PHPExcel_RichText

at line 154
PHPExcel_Comment setText(PHPExcel_RichText $pValue)

Set Rich text comment

Parameters

PHPExcel_RichText $pValue

Return Value

PHPExcel_Comment

at line 165
string getWidth()

Get comment width (CSS style, i.e. XXpx or YYpt)

Return Value

string

at line 176
PHPExcel_Comment setWidth(string $value = '96pt')

Set comment width (CSS style, i.e. XXpx or YYpt)

Parameters

string $value

Return Value

PHPExcel_Comment

at line 187
string getHeight()

Get comment height (CSS style, i.e. XXpx or YYpt)

Return Value

string

at line 198
PHPExcel_Comment setHeight(string $value = '55.5pt')

Set comment height (CSS style, i.e. XXpx or YYpt)

Parameters

string $value

Return Value

PHPExcel_Comment

at line 209
string getMarginLeft()

Get left margin (CSS style, i.e. XXpx or YYpt)

Return Value

string

at line 220
PHPExcel_Comment setMarginLeft(string $value = '59.25pt')

Set left margin (CSS style, i.e. XXpx or YYpt)

Parameters

string $value

Return Value

PHPExcel_Comment

at line 231
string getMarginTop()

Get top margin (CSS style, i.e. XXpx or YYpt)

Return Value

string

at line 242
PHPExcel_Comment setMarginTop(string $value = '1.5pt')

Set top margin (CSS style, i.e. XXpx or YYpt)

Parameters

string $value

Return Value

PHPExcel_Comment

at line 253
boolean getVisible()

Is the comment visible by default?

Return Value

boolean

at line 264
PHPExcel_Comment setVisible(boolean $value = false)

Set comment default visibility

Parameters

boolean $value

Return Value

PHPExcel_Comment

at line 275
PHPExcel_Style_Color getFillColor()

Get fill color

Return Value

PHPExcel_Style_Color

at line 286
PHPExcel_Comment setAlignment(string $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL)

Set Alignment

Parameters

string $pValue

Return Value

PHPExcel_Comment

at line 297
string getAlignment()

Get Alignment

Return Value

string

at line 307
string getHashCode()

Get hash code

Return Value

string Hash code

at line 326
__clone()

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

at line 343
string __toString()

Convert to string

Return Value

string