Docs For Class PHPExcel_Writer_Excel2007_Comments

PHPExcel_Writer_Excel2007

# Class: PHPExcel_Writer_Excel2007_Comments

Source Location: /PHPExcel/Writer/Excel2007/Comments.php

### Class Overview

    PHPExcel_Writer_Excel2007_WriterPart
       |
       --PHPExcel_Writer_Excel2007_Comments

PHPExcel_Writer_Excel2007_Comments

#### Author(s):

#### Copyright:

- Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

### Methods

- writeComments
- writeVMLComments
- _writeComment
- _writeVMLComment

### Inherited Methods

#### Class: PHPExcel_Writer_Excel2007_WriterPart

PHPExcel_Writer_Excel2007_WriterPart::__construct()
  Set parent IWriter object
PHPExcel_Writer_Excel2007_WriterPart::getParentWriter()
  Get parent IWriter object
PHPExcel_Writer_Excel2007_WriterPart::setParentWriter()
  Set parent IWriter object

### Class Details

[line 36]
PHPExcel_Writer_Excel2007_Comments

#### Tags:

copyright: | Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

[ Top ]

### Class Methods

### method writeComments [line 45]

`string writeComments( [ $pWorksheet = null])`

Write comments to XML format

#### Tags:

return: | XML Output
throws: | Exception
access: | public

#### Parameters:

PHPExcel_Worksheet | $pWorksheet |

[ Top ]

### method writeVMLComments [line 125]

`string writeVMLComments( [ $pWorksheet = null])`

Write VML comments to XML format

#### Tags:

return: | XML Output
throws: | Exception
access: | public

#### Parameters:

PHPExcel_Worksheet | $pWorksheet |

[ Top ]

### method _writeComment [line 103]

`void _writeComment( [ $objWriter = null], [string $pCellReference = 'A1'], [ $pComment = null], [array $pAuthors = null])`

Write comment to XML format

#### Tags:

throws: | Exception
access: | public

#### Parameters:

PHPExcel_Shared_XMLWriter | $objWriter | XML Writer
string | $pCellReference | Cell reference
PHPExcel_Comment | $pComment | Comment
array | $pAuthors | Array of authors

[ Top ]

### method _writeVMLComment [line 198]

`void _writeVMLComment( [ $objWriter = null], [string $pCellReference = 'A1'], [ $pComment = null])`

Write VML comment to XML format

#### Tags:

throws: | Exception
access: | public

#### Parameters:

PHPExcel_Shared_XMLWriter | $objWriter | XML Writer
string | $pCellReference | Cell reference
PHPExcel_Comment | $pComment | Comment

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:29:09 -0800 by phpDocumentor 1.4.3