Documentation

Alignment
in package
implements ComparableInterface

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Constants

HORIZONTAL_CENTER  = 'ctr'
HORIZONTAL_DISTRIBUTED  = 'dist'
HORIZONTAL_GENERAL  = 'l'
HORIZONTAL_JUSTIFY  = 'just'
HORIZONTAL_LEFT  = 'l'
HORIZONTAL_RIGHT  = 'r'
TEXT_DIRECTION_HORIZONTAL  = 'horz'
TEXT_DIRECTION_STACKED  = 'wordArtVert'
TEXT_DIRECTION_VERTICAL_270  = 'vert270'
TEXT_DIRECTION_VERTICAL_90  = 'vert'
VERTICAL_AUTO  = 'auto'
VERTICAL_BASE  = 'base'
VERTICAL_BOTTOM  = 'b'
VERTICAL_CENTER  = 'ctr'
VERTICAL_TOP  = 't'

Properties

$hashIndex  : int
Hash index.
$horizontal  : string
Horizontal.
$indent  : float
Indent - only possible with horizontal alignment left and right.
$isRTL  : bool
RTL Direction Support.
$level  : int
Level.
$marginBottom  : float
Margin bottom.
$marginLeft  : float
Margin left - only possible with horizontal alignment left and right.
$marginRight  : float
Margin right - only possible with horizontal alignment left and right.
$marginTop  : float
Margin top.
$supportedStyles  : array<int, string>
$textDirection  : string
Text Direction.
$vertical  : string
Vertical.

Methods

getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getHorizontal()  : string
Get Horizontal.
getIndent()  : float
Get indent.
getLevel()  : int
Get Level.
getMarginBottom()  : float
Get margin bottom.
getMarginLeft()  : float
Get margin left.
getMarginRight()  : float
Get margin right.
getMarginTop()  : float
Get margin top.
getTextDirection()  : string
getVertical()  : string
Get Vertical.
isRTL()  : bool
setHashIndex()  : $this
Set hash index.
setHorizontal()  : self
Set Horizontal.
setIndent()  : self
Set indent.
setIsRTL()  : self
setLevel()  : self
Set Level.
setMarginBottom()  : self
Set margin bottom.
setMarginLeft()  : self
Set margin left.
setMarginRight()  : self
Set margin ight.
setMarginTop()  : self
Set margin top.
setTextDirection()  : self
setVertical()  : self
Set Vertical.

Constants

HORIZONTAL_CENTER

public mixed HORIZONTAL_CENTER = 'ctr'

HORIZONTAL_DISTRIBUTED

public mixed HORIZONTAL_DISTRIBUTED = 'dist'

HORIZONTAL_GENERAL

public mixed HORIZONTAL_GENERAL = 'l'

HORIZONTAL_JUSTIFY

public mixed HORIZONTAL_JUSTIFY = 'just'

HORIZONTAL_LEFT

public mixed HORIZONTAL_LEFT = 'l'

HORIZONTAL_RIGHT

public mixed HORIZONTAL_RIGHT = 'r'

TEXT_DIRECTION_HORIZONTAL

public mixed TEXT_DIRECTION_HORIZONTAL = 'horz'

TEXT_DIRECTION_STACKED

public mixed TEXT_DIRECTION_STACKED = 'wordArtVert'

TEXT_DIRECTION_VERTICAL_270

public mixed TEXT_DIRECTION_VERTICAL_270 = 'vert270'

TEXT_DIRECTION_VERTICAL_90

public mixed TEXT_DIRECTION_VERTICAL_90 = 'vert'

VERTICAL_AUTO

public mixed VERTICAL_AUTO = 'auto'

VERTICAL_BASE

public mixed VERTICAL_BASE = 'base'

VERTICAL_BOTTOM

public mixed VERTICAL_BOTTOM = 'b'

VERTICAL_CENTER

public mixed VERTICAL_CENTER = 'ctr'

VERTICAL_TOP

public mixed VERTICAL_TOP = 't'

Properties

$hashIndex

Hash index.

private int $hashIndex

$horizontal

Horizontal.

private string $horizontal = self::HORIZONTAL_LEFT

$indent

Indent - only possible with horizontal alignment left and right.

private float $indent = 0

$isRTL

RTL Direction Support.

private bool $isRTL = false

$marginBottom

Margin bottom.

private float $marginBottom = 0

$marginLeft

Margin left - only possible with horizontal alignment left and right.

private float $marginLeft = 0

$marginRight

Margin right - only possible with horizontal alignment left and right.

private float $marginRight = 0

$marginTop

Margin top.

private float $marginTop = 0

$supportedStyles

private array<int, string> $supportedStyles = [self::HORIZONTAL_GENERAL, self::HORIZONTAL_LEFT, self::HORIZONTAL_RIGHT]

$textDirection

Text Direction.

private string $textDirection = self::TEXT_DIRECTION_HORIZONTAL

$vertical

Vertical.

private string $vertical = self::VERTICAL_BASE

Methods

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

getHorizontal()

Get Horizontal.

public getHorizontal() : string
Return values
string

getIndent()

Get indent.

public getIndent() : float
Return values
float

getLevel()

Get Level.

public getLevel() : int
Return values
int

getMarginBottom()

Get margin bottom.

public getMarginBottom() : float
Return values
float

getMarginLeft()

Get margin left.

public getMarginLeft() : float
Return values
float

getMarginRight()

Get margin right.

public getMarginRight() : float
Return values
float

getMarginTop()

Get margin top.

public getMarginTop() : float
Return values
float

getTextDirection()

public getTextDirection() : string
Return values
string

getVertical()

Get Vertical.

public getVertical() : string
Return values
string

isRTL()

public isRTL() : bool
Return values
bool

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

setHorizontal()

Set Horizontal.

public setHorizontal([string $pValue = self::HORIZONTAL_LEFT ]) : self
Parameters
$pValue : string = self::HORIZONTAL_LEFT
Return values
self

setIndent()

Set indent.

public setIndent([float $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self

setIsRTL()

public setIsRTL([bool $value = false ]) : self
Parameters
$value : bool = false
Return values
self

setLevel()

Set Level.

public setLevel([int $pValue = 0 ]) : self
Parameters
$pValue : int = 0

Ranging 0 - 8

Return values
self

setMarginBottom()

Set margin bottom.

public setMarginBottom([float $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self

setMarginLeft()

Set margin left.

public setMarginLeft([float $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self

setMarginRight()

Set margin ight.

public setMarginRight([float $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self

setMarginTop()

Set margin top.

public setMarginTop([float $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self

setTextDirection()

public setTextDirection([string $pValue = self::TEXT_DIRECTION_HORIZONTAL ]) : self
Parameters
$pValue : string = self::TEXT_DIRECTION_HORIZONTAL
Return values
self

setVertical()

Set Vertical.

public setVertical([string $pValue = self::VERTICAL_BASE ]) : self
Parameters
$pValue : string = self::VERTICAL_BASE
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results