Docs For Class PHPExcel_Style_Border

PHPExcel_Style

# Class: PHPExcel_Style_Border

Source Location: /PHPExcel/Style/Border.php

### Class Overview

PHPExcel_Style_Border

#### Author(s):

#### Copyright:

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

Implements interfaces:

- PHPExcel_IComparable

### Constants

- BORDER_DASHDOT
- BORDER_DASHDOTDOT
- BORDER_DASHED
- BORDER_DOTTED
- BORDER_DOUBLE
- BORDER_HAIR
- BORDER_MEDIUM
- BORDER_MEDIUMDASHDOT
- BORDER_MEDIUMDASHDOTDOT
- BORDER_MEDIUMDASHED
- BORDER_NONE
- BORDER_SLANTDASHDOT
- BORDER_THICK
- BORDER_THIN

### Methods

- applyFromArray
- bindParent
- __construct
- getActiveCell
- getActiveSheet
- getBorderStyle
- getColor
- getHashCode
- getIsSupervisor
- getSelectedCells
- getSharedComponent
- getStyleArray
- setBorderStyle
- setColor
- __clone

### Class Details

[line 36]
PHPExcel_Style_Border

#### Tags:

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

[ Top ]

### Class Methods

### method applyFromArray [line 273]

`PHPExcel_Style_Border applyFromArray( [array $pStyles = null])`

Apply styles from array

1. $objPHPExcel-> getActiveSheet()->getStyle('B2')->getBorders()->getTop()-> applyFromArray(
2. array(
3. 'style' => PHPExcel_Style_Border:: BORDER_DASHDOT,
4. 'color' => array(
5. 'rgb' => '808080'
6. )
7. )
8. );

#### Tags:

throws: | Exception
access: | public

#### Parameters:

array | $pStyles | Array containing style information

[ Top ]

### method bindParent [line 113]

`PHPExcel_Style_Border bindParent( PHPExcel_Style_Borders $parent, string $parentPropertyName)`

Bind parent. Only used for supervisor

#### Tags:

access: | public

#### Parameters:

PHPExcel_Style_Borders | $parent |
string | $parentPropertyName |

[ Top ]

### constructor __construct [line 92]

`PHPExcel_Style_Border __construct( [ $isSupervisor = false])`

Create a new PHPExcel_Style_Border

#### Tags:

access: | public

#### Parameters:

| $isSupervisor |

[ Top ]

### method getActiveCell [line 198]

`string getActiveCell( )`

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

#### Tags:

return: | E.g. 'A1'
access: | public

[ Top ]

### method getActiveSheet [line 176]

`PHPExcel_Worksheet getActiveSheet( )`

Get the currently active sheet. Only used for supervisor

#### Tags:

access: | public

[ Top ]

### method getBorderStyle [line 296]

`string getBorderStyle( )`

Get Border style

#### Tags:

access: | public

[ Top ]

### method getColor [line 328]

`PHPExcel_Style_Color getColor( )`

Get Border Color

#### Tags:

access: | public

[ Top ]

### method getHashCode [line 357]

`string getHashCode( )`

Get hash code

#### Tags:

return: | Hash code
access: | public

[ Top ]

### method getIsSupervisor [line 125]

`boolean getIsSupervisor( )`

Is this a supervisor or a real style component?

#### Tags:

access: | public

[ Top ]

### method getSelectedCells [line 187]

`string getSelectedCells( )`

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

#### Tags:

return: | E.g. 'A1'
access: | public

[ Top ]

### method getSharedComponent [line 137]

`PHPExcel_Style_Border getSharedComponent( )`

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method getStyleArray [line 209]

`array getStyleArray( array $array)`

Build style array from subcomponents

#### Tags:

access: | public

#### Parameters:

array | $array |

[ Top ]

### method setBorderStyle [line 309]

`PHPExcel_Style_Border setBorderStyle( [string $pValue = PHPExcel_Style_Border::BORDER_NONE])`

Set Border style

#### Tags:

access: | public

#### Parameters:

string | $pValue |

[ Top ]

### method setColor [line 339]

`PHPExcel_Style_Border setColor( [PHPExcel_Style_Color $pValue = null])`

Set Border Color

#### Tags:

throws: | Exception
access: | public

#### Parameters:

PHPExcel_Style_Color | $pValue |

[ Top ]

### method __clone [line 371]

`void __clone( )`

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

#### Tags:

access: | public

[ Top ]

### Class Constants

#### BORDER_DASHDOT = 'dashDot'

[line 40]

[ Top ]

#### BORDER_DASHDOTDOT = 'dashDotDot'

[line 41]

[ Top ]

#### BORDER_DASHED = 'dashed'

[line 42]

[ Top ]

#### BORDER_DOTTED = 'dotted'

[line 43]

[ Top ]

#### BORDER_DOUBLE = 'double'

[line 44]

[ Top ]

#### BORDER_HAIR = 'hair'

[line 45]

[ Top ]

#### BORDER_MEDIUM = 'medium'

[line 46]

[ Top ]

#### BORDER_MEDIUMDASHDOT = 'mediumDashDot'

[line 47]

[ Top ]

#### BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot'

[line 48]

[ Top ]

#### BORDER_MEDIUMDASHED = 'mediumDashed'

[line 49]

[ Top ]

#### BORDER_NONE = 'none'

[line 39]

[ Top ]

#### BORDER_SLANTDASHDOT = 'slantDashDot'

[line 50]

[ Top ]

#### BORDER_THICK = 'thick'

[line 51]

[ Top ]

#### BORDER_THIN = 'thin'

[line 52]

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:28:38 -0800 by phpDocumentor 1.4.3