PHP Class PhpOffice\PhpPresentation\PresentationProperties

Show file Open project: phpoffice/phppowerpoint Class Usage Examples

Protected Properties

Property Type Description
$arrayView
$isCommentVisible *
$isLoopUntilEsc *
$lastView *
$markAsFinal boolean Mark as final
$thumbnail *
$zoom float Zoom

Public Methods

Method Description
getLastView ( ) : string
getThumbnailPath ( ) : string Return the thumbnail file path
getZoom ( ) : float Return the zoom (in percentage)
isCommentVisible ( ) : string
isLoopContinuouslyUntilEsc ( ) : boolean
isMarkedAsFinal ( ) : boolean Return if this document is marked as final
markAsFinal ( boolean $state = true ) : PhpPresentation Mark a document as final
setCommentVisible ( boolean $value = false )
setLastView ( string $value = self::VIEW_SLIDE )
setLoopContinuouslyUntilEsc ( boolean $value = false ) : PresentationProperties
setThumbnailPath ( string $path = '' ) : PresentationProperties Define the path for the thumbnail file / preview picture
setZoom ( float $zoom = 1 ) : PhpPresentation Set the zoom of the document (in percentage)

Method Details

getLastView() public method

public getLastView ( ) : string
return string

getThumbnailPath() public method

Return the thumbnail file path
public getThumbnailPath ( ) : string
return string

getZoom() public method

Return the zoom (in percentage)
public getZoom ( ) : float
return float

isCommentVisible() public method

public isCommentVisible ( ) : string
return string

isLoopContinuouslyUntilEsc() public method

public isLoopContinuouslyUntilEsc ( ) : boolean
return boolean

isMarkedAsFinal() public method

Return if this document is marked as final
public isMarkedAsFinal ( ) : boolean
return boolean

markAsFinal() public method

Mark a document as final
public markAsFinal ( boolean $state = true ) : PhpPresentation
$state boolean
return PhpPresentation

setCommentVisible() public method

public setCommentVisible ( boolean $value = false )
$value boolean

setLastView() public method

public setLastView ( string $value = self::VIEW_SLIDE )
$value string

setLoopContinuouslyUntilEsc() public method

public setLoopContinuouslyUntilEsc ( boolean $value = false ) : PresentationProperties
$value boolean
return PresentationProperties

setThumbnailPath() public method

Define the path for the thumbnail file / preview picture
public setThumbnailPath ( string $path = '' ) : PresentationProperties
$path string
return PresentationProperties

setZoom() public method

Set the zoom of the document (in percentage)
public setZoom ( float $zoom = 1 ) : PhpPresentation
$zoom float
return PhpPresentation

Property Details

$arrayView protected property

protected $arrayView

$isCommentVisible protected property

*
protected $isCommentVisible

$isLoopUntilEsc protected property

*
protected $isLoopUntilEsc

$lastView protected property

*
protected $lastView

$markAsFinal protected property

Mark as final
protected bool $markAsFinal
return boolean

$thumbnail protected property

*
protected $thumbnail

$zoom protected property

Zoom
protected float $zoom
return float