Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel
  • PHPExcel_Autoloader
  • PHPExcel_Comment
  • PHPExcel_DocumentProperties
  • PHPExcel_DocumentSecurity
  • PHPExcel_HashTable
  • PHPExcel_IOFactory
  • PHPExcel_NamedRange
  • PHPExcel_ReferenceHelper
  • PHPExcel_WorksheetIterator

Interfaces

  • PHPExcel_IComparable

Exceptions

  • PHPExcel_Exception
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Comment

PHPExcel_Comment

PHPExcel_Comment implements PHPExcel_IComparable
Package: PHPExcel
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Comment.php
Methods summary
public
# __construct( )

Create a new PHPExcel_Comment

Create a new PHPExcel_Comment

Throws

PHPExcel_Exception
public string
# getAuthor( )

Get Author

Get Author

Returns

string
public PHPExcel_Comment
# setAuthor( string $pValue = '' )

Set Author

Set Author

Parameters

$pValue

Returns

PHPExcel_Comment
public PHPExcel_RichText
# getText( )

Get Rich text comment

Get Rich text comment

Returns

PHPExcel_RichText
public PHPExcel_Comment
# setText( PHPExcel_RichText $pValue )

Set Rich text comment

Set Rich text comment

Parameters

$pValue

Returns

PHPExcel_Comment
public string
# getWidth( )

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

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

Returns

string
public PHPExcel_Comment
# setWidth( string $value = '96pt' )

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

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

Parameters

$value

Returns

PHPExcel_Comment
public string
# getHeight( )

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

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

Returns

string
public PHPExcel_Comment
# setHeight( string $value = '55.5pt' )

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

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

Parameters

$value

Returns

PHPExcel_Comment
public string
# getMarginLeft( )

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

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

Returns

string
public PHPExcel_Comment
# setMarginLeft( string $value = '59.25pt' )

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

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

Parameters

$value

Returns

PHPExcel_Comment
public string
# getMarginTop( )

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

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

Returns

string
public PHPExcel_Comment
# setMarginTop( string $value = '1.5pt' )

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

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

Parameters

$value

Returns

PHPExcel_Comment
public boolean
# getVisible( )

Is the comment visible by default?

Is the comment visible by default?

Returns

boolean
public PHPExcel_Comment
# setVisible( boolean $value = false )

Set comment default visibility

Set comment default visibility

Parameters

$value

Returns

PHPExcel_Comment
public PHPExcel_Style_Color
# getFillColor( )

Get fill color

Get fill color

Returns

PHPExcel_Style_Color
public PHPExcel_Comment
# setAlignment( string $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL )

Set Alignment

Set Alignment

Parameters

$pValue

Returns

PHPExcel_Comment
public string
# getAlignment( )

Get Alignment

Get Alignment

Returns

string
public string
# getHashCode( )

Get hash code

Get hash code

Returns

string
Hash code

Implementation of

PHPExcel_IComparable::getHashCode()
public
# __clone( )

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

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

public string
# __toString( )

Convert to string

Convert to string

Returns

string
Properties summary
private string $_author

Author

Author

#
private PHPExcel_RichText $_text

Rich text comment

Rich text comment

#
private string $_width

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

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

# '96pt'
private string $_marginLeft

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

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

# '59.25pt'
private string $_marginTop

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

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

# '1.5pt'
private boolean $_visible

Visible

Visible

# false
private string $_height

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

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

# '55.5pt'
private PHPExcel_Style_Color $_fillColor

Comment fill color

Comment fill color

#
private string $_alignment

Alignment

Alignment

#
Autene API documentation generated by ApiGen