PHPExcel
[ class tree: PHPExcel ] [ index: PHPExcel ] [ all elements ]
Packages:
default
com-tecnick-tcpdf
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Best_Fit
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
Comment.php
DocumentProperties.php
DocumentSecurity.php
HashTable.php
IComparable.php
IOFactory.php
NamedRange.php
PHPExcel.php
ReferenceHelper.php
WorksheetIterator.php

Interfaces:
PHPExcel_IComparable
Classes:
PHPExcel
PHPExcel_Comment
PHPExcel_DocumentProperties
PHPExcel_DocumentSecurity
PHPExcel_HashTable
PHPExcel_IOFactory
PHPExcel_NamedRange
PHPExcel_ReferenceHelper
PHPExcel_WorksheetIterator

Class: PHPExcel_Comment

Source Location: /PHPExcel/Comment.php

Class Overview




PHPExcel_Comment




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 54]

PHPExcel_Comment

PHPExcel_Comment





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_author = 

	
[line 61]

  Author

Author





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_fillColor = 

	
[line 110]

  Comment fill color

Comment fill color





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Color
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 298]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_height =  '55.5pt'

	
[line 103]

  Comment height (CSS style, i.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_marginLeft =  '59.25pt'

	
[line 82]

  Left margin (CSS style, i.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_marginTop =  '1.5pt'

	
[line 89]

  Top margin (CSS style, i.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_text = 

	
[line 68]

  Rich text comment

Rich text comment





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_RichText
    

      

	



	
[ Top ]


	
	

	
$_visible =  false

	
[line 96]

  Visible

Visible





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_width =  '96pt'

	
[line 75]

  Comment width (CSS style, i.

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 117]

	

    

    

		PHPExcel_Comment __construct(
)
    

    


	
		Create a new PHPExcel_Comment

Create a new PHPExcel_Comment





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getAuthor [line 130]

	

    

    

		string getAuthor(
)
    

    


	
		Get Author

Get Author





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFillColor [line 270]

	

    

    

		PHPExcel_Style_Color getFillColor(
)
    

    


	
		Get fill color

Get fill color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 279]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









			

		
Implementation of:

			

			
PHPExcel_IComparable::getHashCode()

						
Get hash code

					

		
        
[ Top ]

  

  

	
	
method getHashIndex [line 308]

	

    

    

		string getHashIndex(
)
    

    


	
		Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    return:  Hash index
  

  

    access:  public
  









			

		
Implementation of:

			

			
PHPExcel_IComparable::getHashIndex()

						
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

					

		
        
[ Top ]

  

  

	
	
method getHeight [line 190]

	

    

    

		string getHeight(
)
    

    


	
		Get comment height (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getMarginLeft [line 210]

	

    

    

		string getMarginLeft(
)
    

    


	
		Get left margin (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getMarginTop [line 230]

	

    

    

		string getMarginTop(
)
    

    


	
		Get top margin (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getText [line 150]

	

    

    

		PHPExcel_RichText getText(
)
    

    


	
		Get Rich text comment

Get Rich text comment





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getVisible [line 250]

	

    

    

		boolean getVisible(
)
    

    


	
		Is the comment visible by default?

Is the comment visible by default?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getWidth [line 170]

	

    

    

		string getWidth(
)
    

    


	
		Get comment width (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setAuthor [line 140]

	

    

    

		PHPExcel_Comment setAuthor(
[string
$pValue = ''])
    

    


	
		Set Author

Set Author





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 320]

	

    

    

		void setHashIndex(
string
$value)
    

    


	
		Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
PHPExcel_IComparable::setHashIndex()

						
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

					

		
        
Parameters:

    

    

          

        string  
        $value  
        Hash index
      

        

    


        
[ Top ]

  

  

	
	
method setHeight [line 200]

	

    

    

		PHPExcel_Comment setHeight(
[string
$value = '55.5pt'])
    

    


	
		Set comment height (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setMarginLeft [line 220]

	

    

    

		PHPExcel_Comment setMarginLeft(
[string
$value = '59.25pt'])
    

    


	
		Set left margin (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setMarginTop [line 240]

	

    

    

		PHPExcel_Comment setMarginTop(
[string
$value = '1.5pt'])
    

    


	
		Set top margin (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setText [line 160]

	

    

    

		PHPExcel_Comment setText(

$pValue)
    

    


	
		Set Rich text comment

Set Rich text comment





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_RichText  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setVisible [line 260]

	

    

    

		PHPExcel_Comment setVisible(
[boolean
$value = false])
    

    


	
		Set comment default visibility

Set comment default visibility





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWidth [line 180]

	

    

    

		PHPExcel_Comment setWidth(
[string
$value = '96pt'])
    

    


	
		Set comment width (CSS style, i.

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





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 327]

	

    

    

		void __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.





Tags:





  

    access:  public
  









	
        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 10 Aug 2009 08:02:47 +0200 by phpDocumentor 1.4.1