PhpOffice\PhpSpreadsheet\Comment Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Comment:

Public Member Functions
	__construct ()
	Create a new Comment.
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy.
	__toString ()
	Convert to string.
	getAlignment ()
	Get Alignment.
	getAuthor ()
	Get Author.
	getBackgroundImage ()
	Returns background image.
	getFillColor ()
	Get fill color.
	getHashCode ()
	Get hash code.
	getHeight ()
	Get comment height (CSS style, i.e.
	getMarginLeft ()
	Get left margin (CSS style, i.e.
	getMarginTop ()
	Get top margin (CSS style, i.e.
	getText ()
	Get Rich text comment.
	getVisible ()
	Is the comment visible by default?
	getWidth ()
	Get comment width (CSS style, i.e.
	hasBackgroundImage ()
	Check is background image exists.
	setAlignment (string $alignment)
	Set Alignment.
	setAuthor (string $author)
	Set Author.
	setBackgroundImage (Drawing $objDrawing)
	Sets background image.
	setFillColor (Color $color)
	Set fill color.
	setHeight (string $height)
	Set comment height (CSS style, i.e.
	setMarginLeft (string $margin)
	Set left margin (CSS style, i.e.
	setMarginTop (string $margin)
	Set top margin (CSS style, i.e.
	setSizeAsBackgroundImage ()
	Sets size of comment as size of background image.
	setText (RichText $text)
	Set Rich text comment.
	setVisible (bool $visibility)
	Set comment default visibility.
	setWidth (string $width)
	Set comment width (CSS style, i.e.

Member Function Documentation

getHashCode()

PhpOffice\PhpSpreadsheet\Comment::getHashCode

(

)

Get hash code.

Implements PhpOffice\PhpSpreadsheet\IComparable.

getHeight()

PhpOffice\PhpSpreadsheet\Comment::getHeight

(

)

Get comment height (CSS style, i.e.

XXpx or YYpt).

getMarginLeft()

PhpOffice\PhpSpreadsheet\Comment::getMarginLeft

(

)

Get left margin (CSS style, i.e.

XXpx or YYpt).

getMarginTop()

PhpOffice\PhpSpreadsheet\Comment::getMarginTop

(

)

Get top margin (CSS style, i.e.

XXpx or YYpt).

getWidth()

PhpOffice\PhpSpreadsheet\Comment::getWidth

(

)

Get comment width (CSS style, i.e.

XXpx or YYpt).

setHeight()

PhpOffice\PhpSpreadsheet\Comment::setHeight

(

string

$height

)

Set comment height (CSS style, i.e.

XXpx or YYpt). Default unit is pt.

setMarginLeft()

PhpOffice\PhpSpreadsheet\Comment::setMarginLeft

(

string

$margin

)

Set left margin (CSS style, i.e.

XXpx or YYpt). Default unit is pt.

setMarginTop()

PhpOffice\PhpSpreadsheet\Comment::setMarginTop

(

string

$margin

)

Set top margin (CSS style, i.e.

XXpx or YYpt). Default unit is pt.

setWidth()

PhpOffice\PhpSpreadsheet\Comment::setWidth

(

string

$width

)

Set comment width (CSS style, i.e.

XXpx or YYpt). Default unit is pt.

---

The documentation for this class was generated from the following file:

• lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/Comment.php