FootnoteProperties
in package
FinalYes
Footnote properties.
Tags
Table of Contents
Constants
- POSITION_BENEATH_TEXT = 'beneathText'
- POSITION_DOC_END = 'docEnd'
- POSITION_PAGE_BOTTOM = 'pageBottom'
- POSITION_SECTION_END = 'sectEnd'
- RESTART_NUMBER_CONTINUOUS = 'continuous'
- RESTART_NUMBER_EACH_PAGE = 'eachPage'
- RESTART_NUMBER_EACH_SECTION = 'eachSect'
Properties
- $numFmt : string
- Footnote Numbering Format w:numFmt, one of PhpOffice\PhpWord\SimpleType\NumberFormat.
- $numRestart : string
- Footnote and Endnote Numbering Restart Location.
- $numStart : float
- Footnote and Endnote Numbering Starting Value.
- $pos : string
- Footnote Positioning Location.
Methods
- getNumFmt() : string
- Get the Footnote Numbering Format.
- getNumRestart() : string
- Get the Footnote and Endnote Numbering Starting Value.
- getNumStart() : float
- Get the Footnote Numbering Format.
- getPos() : string
- Get the Footnote Positioning Location.
- setNumFmt() : self
- Set the Footnote Numbering Format.
- setNumRestart() : self
- Set the Footnote and Endnote Numbering Starting Value (continuous, eachSect, eachPage).
- setNumStart() : self
- Set the Footnote Numbering Format.
- setPos() : self
- Set the Footnote Positioning Location (pageBottom, beneathText, sectEnd, docEnd).
Constants
POSITION_BENEATH_TEXT
public
mixed
POSITION_BENEATH_TEXT
= 'beneathText'
POSITION_DOC_END
public
mixed
POSITION_DOC_END
= 'docEnd'
POSITION_PAGE_BOTTOM
public
mixed
POSITION_PAGE_BOTTOM
= 'pageBottom'
POSITION_SECTION_END
public
mixed
POSITION_SECTION_END
= 'sectEnd'
RESTART_NUMBER_CONTINUOUS
public
mixed
RESTART_NUMBER_CONTINUOUS
= 'continuous'
RESTART_NUMBER_EACH_PAGE
public
mixed
RESTART_NUMBER_EACH_PAGE
= 'eachPage'
RESTART_NUMBER_EACH_SECTION
public
mixed
RESTART_NUMBER_EACH_SECTION
= 'eachSect'
Properties
$numFmt
Footnote Numbering Format w:numFmt, one of PhpOffice\PhpWord\SimpleType\NumberFormat.
private
string
$numFmt
$numRestart
Footnote and Endnote Numbering Restart Location.
private
string
$numRestart
$numStart
Footnote and Endnote Numbering Starting Value.
private
float
$numStart
$pos
Footnote Positioning Location.
private
string
$pos
Methods
getNumFmt()
Get the Footnote Numbering Format.
public
getNumFmt() : string
Return values
stringgetNumRestart()
Get the Footnote and Endnote Numbering Starting Value.
public
getNumRestart() : string
Return values
stringgetNumStart()
Get the Footnote Numbering Format.
public
getNumStart() : float
Return values
floatgetPos()
Get the Footnote Positioning Location.
public
getPos() : string
Return values
stringsetNumFmt()
Set the Footnote Numbering Format.
public
setNumFmt(string $numFmt) : self
Parameters
- $numFmt : string
-
One of NumberFormat
Return values
selfsetNumRestart()
Set the Footnote and Endnote Numbering Starting Value (continuous, eachSect, eachPage).
public
setNumRestart(string $numRestart) : self
Parameters
- $numRestart : string
Return values
selfsetNumStart()
Set the Footnote Numbering Format.
public
setNumStart(float $numStart) : self
Parameters
- $numStart : float
Return values
selfsetPos()
Set the Footnote Positioning Location (pageBottom, beneathText, sectEnd, docEnd).
public
setPos(string $pos) : self
Parameters
- $pos : string