Properties

$_author

$_author : string

Author

Type

string

$_width

$_width : string

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

Type

string

$_marginLeft

$_marginLeft : string

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

Type

string

$_marginTop

$_marginTop : string

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

Type

string

$_visible

$_visible : bool

Visible

Type

bool

$_height

$_height : string

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

Type

string

$_alignment

$_alignment : string

Alignment

Type

string

Methods

__construct()

__construct() : mixed

Create a new PHPExcel_Comment

Throws

\PHPExcel_Exception

Returns

mixed —

getAuthor()

getAuthor() : string

Get Author

Returns

string —

setAuthor()

setAuthor(string  $pValue = '') : \PHPExcel_Comment

Set Author

Parameters

string $pValue

Returns

\PHPExcel_Comment —

getText()

getText() : \PHPExcel_RichText

Get Rich text comment

Returns

\PHPExcel_RichText —

setText()

setText(\PHPExcel_RichText  $pValue) : \PHPExcel_Comment

Set Rich text comment

Parameters

\PHPExcel_RichText $pValue

Returns

\PHPExcel_Comment —

getWidth()

getWidth() : string

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

Returns

string —

setWidth()

setWidth(string  $value = '96pt') : \PHPExcel_Comment

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

Parameters

string $value

Returns

\PHPExcel_Comment —

getHeight()

getHeight() : string

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

Returns

string —

setHeight()

setHeight(string  $value = '55.5pt') : \PHPExcel_Comment

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

Parameters

string $value

Returns

\PHPExcel_Comment —

getMarginLeft()

getMarginLeft() : string

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

Returns

string —

setMarginLeft()

setMarginLeft(string  $value = '59.25pt') : \PHPExcel_Comment

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

Parameters

string $value

Returns

\PHPExcel_Comment —

getMarginTop()

getMarginTop() : string

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

Returns

string —

setMarginTop()

setMarginTop(string  $value = '1.5pt') : \PHPExcel_Comment

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

Parameters

string $value

Returns

\PHPExcel_Comment —

getVisible()

getVisible() : bool

Is the comment visible by default?

Returns

bool —

setVisible()

setVisible(bool  $value = false) : \PHPExcel_Comment

Set comment default visibility

Parameters

bool $value

Returns

\PHPExcel_Comment —

getFillColor()

getFillColor() : \PHPExcel_Style_Color

Get fill color

Returns

\PHPExcel_Style_Color —

setAlignment()

setAlignment(string  $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL) : \PHPExcel_Comment

Set Alignment

Parameters

string $pValue

Returns

\PHPExcel_Comment —

getAlignment()

getAlignment() : string

Get Alignment

Returns

string —

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code

__clone()

__clone() : mixed

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

Returns

mixed —

__toString()

__toString() : string

Convert to string

Returns

string —