Documentation

Hyperlink
in package

Hyperlink element.

Table of Contents

Properties

$relationId  : string
Slide relation ID (should not be used by user code!).
$hashIndex  : int
Hash index.
$isTextColorUsed  : bool
If true, uses the text color, instead of theme color.
$slideNumber  : int
Slide number to link to.
$tooltip  : string
Tooltip to display on the hyperlink.
$url  : string
URL to link the shape to.

Methods

__construct()  : mixed
Create a new \PhpOffice\PhpPresentation\Shape\Hyperlink.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getSlideNumber()  : int
Get slide number.
getTooltip()  : string
Get tooltip.
getUrl()  : string
Get URL.
isInternal()  : bool
Is this hyperlink internal? (to another slide).
isTextColorUsed()  : bool
Get whether or not to use text color for a hyperlink, instead of theme color.
setHashIndex()  : $this
Set hash index.
setIsTextColorUsed()  : self
Set whether or not to use text color for a hyperlink, instead of theme color.
setSlideNumber()  : self
Set slide number.
setTooltip()  : self
Set tooltip.
setUrl()  : self
Set URL.

Properties

$relationId

Slide relation ID (should not be used by user code!).

public string $relationId

$hashIndex

Hash index.

private int $hashIndex

$isTextColorUsed

If true, uses the text color, instead of theme color.

private bool $isTextColorUsed = false

$slideNumber

Slide number to link to.

private int $slideNumber

$tooltip

Tooltip to display on the hyperlink.

private string $tooltip

$url

URL to link the shape to.

private string $url

Methods

__construct()

Create a new \PhpOffice\PhpPresentation\Shape\Hyperlink.

public __construct([string $pUrl = '' ][, string $pTooltip = '' ]) : mixed
Parameters
$pUrl : string = ''

Url to link the shape to

$pTooltip : string = ''

Tooltip to display on the hyperlink

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

getSlideNumber()

Get slide number.

public getSlideNumber() : int
Return values
int

getTooltip()

Get tooltip.

public getTooltip() : string
Return values
string

getUrl()

Get URL.

public getUrl() : string
Return values
string

isInternal()

Is this hyperlink internal? (to another slide).

public isInternal() : 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

setSlideNumber()

Set slide number.

public setSlideNumber([int $value = 1 ]) : self
Parameters
$value : int = 1
Return values
self

setTooltip()

Set tooltip.

public setTooltip([string $value = '' ]) : self
Parameters
$value : string = ''
Return values
self

setUrl()

Set URL.

public setUrl([string $value = '' ]) : self
Parameters
$value : string = ''
Return values
self

        
On this page

Search results