Documentation

Border
in package
implements ComparableInterface

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Constants

DASH_DASH  = 'dash'
DASH_DASHDOT  = 'dashDot'
DASH_DOT  = 'dot'
DASH_LARGEDASH  = 'lgDash'
DASH_LARGEDASHDOT  = 'lgDashDot'
DASH_LARGEDASHDOTDOT  = 'lgDashDotDot'
DASH_SOLID  = 'solid'
DASH_SYSDASH  = 'sysDash'
DASH_SYSDASHDOT  = 'sysDashDot'
DASH_SYSDASHDOTDOT  = 'sysDashDotDot'
DASH_SYSDOT  = 'sysDot'
LINE_DOUBLE  = 'dbl'
LINE_NONE  = 'none'
LINE_SINGLE  = 'sng'
LINE_THICKTHIN  = 'thickThin'
LINE_THINTHICK  = 'thinThick'
LINE_TRI  = 'tri'

Properties

$color  : Color
Border color.
$dashStyle  : string
Dash style.
$hashIndex  : int
Hash index.
$lineStyle  : string
Line style.
$lineWidth  : int
Line width.

Methods

__construct()  : mixed
getColor()  : Color|null
Get Border Color.
getDashStyle()  : string
Get dash style.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getLineStyle()  : string
Get line style.
getLineWidth()  : int
Get line width (in points).
setColor()  : self
Set Border Color.
setDashStyle()  : self
Set dash style.
setHashIndex()  : $this
Set hash index.
setLineStyle()  : self
Set line style.
setLineWidth()  : self
Set line width (in points).

Constants

DASH_DASH

public mixed DASH_DASH = 'dash'

DASH_DASHDOT

public mixed DASH_DASHDOT = 'dashDot'

DASH_DOT

public mixed DASH_DOT = 'dot'

DASH_LARGEDASH

public mixed DASH_LARGEDASH = 'lgDash'

DASH_LARGEDASHDOT

public mixed DASH_LARGEDASHDOT = 'lgDashDot'

DASH_LARGEDASHDOTDOT

public mixed DASH_LARGEDASHDOTDOT = 'lgDashDotDot'

DASH_SOLID

public mixed DASH_SOLID = 'solid'

DASH_SYSDASH

public mixed DASH_SYSDASH = 'sysDash'

DASH_SYSDASHDOT

public mixed DASH_SYSDASHDOT = 'sysDashDot'

DASH_SYSDASHDOTDOT

public mixed DASH_SYSDASHDOTDOT = 'sysDashDotDot'

DASH_SYSDOT

public mixed DASH_SYSDOT = 'sysDot'

LINE_DOUBLE

public mixed LINE_DOUBLE = 'dbl'

LINE_NONE

public mixed LINE_NONE = 'none'

LINE_SINGLE

public mixed LINE_SINGLE = 'sng'

LINE_THICKTHIN

public mixed LINE_THICKTHIN = 'thickThin'

LINE_THINTHICK

public mixed LINE_THINTHICK = 'thinThick'

LINE_TRI

public mixed LINE_TRI = 'tri'

Properties

$dashStyle

Dash style.

private string $dashStyle = self::DASH_SOLID

$hashIndex

Hash index.

private int $hashIndex

$lineStyle

Line style.

private string $lineStyle = self::LINE_SINGLE

$lineWidth

Line width.

private int $lineWidth = 1

Methods

__construct()

public __construct() : mixed

getColor()

Get Border Color.

public getColor() : Color|null
Return values
Color|null

getDashStyle()

Get dash style.

public getDashStyle() : string
Return values
string

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string —

Hash code

getHashIndex()

Get hash index.

public getHashIndex() : null|int

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.

Return values
null|int —

Hash index

getLineStyle()

Get line style.

public getLineStyle() : string
Return values
string

getLineWidth()

Get line width (in points).

public getLineWidth() : int
Return values
int

setColor()

Set Border Color.

public setColor([Color|null $color = null ]) : self
Parameters
$color : Color|null = null
Return values
self

setDashStyle()

Set dash style.

public setDashStyle([string $pValue = self::DASH_SOLID ]) : self
Parameters
$pValue : string = self::DASH_SOLID
Return values
self

setHashIndex()

Set hash index.

public setHashIndex(int $value) : $this

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
$value : int

Hash index

Return values
$this

setLineStyle()

Set line style.

public setLineStyle([string $pValue = self::LINE_SINGLE ]) : self
Parameters
$pValue : string = self::LINE_SINGLE
Return values
self

setLineWidth()

Set line width (in points).

public setLineWidth([int $pValue = 1 ]) : self
Parameters
$pValue : int = 1
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results