Properties

$zoom

$zoom : mixed

Magnification Setting

Type

mixed — either integer, in which case it treated as a percent, or one of PhpOffice\PhpWord\SimpleType\Zoom

$mirrorMargins

$mirrorMargins : boolean

Mirror Page Margins

Type

boolean

$hideSpellingErrors

$hideSpellingErrors : boolean

Hide spelling errors

Type

boolean

$hideGrammaticalErrors

$hideGrammaticalErrors : boolean

Hide grammatical errors

Type

boolean

$trackRevisions

$trackRevisions : boolean

Track Revisions to Document

Type

boolean

$doNotTrackMoves

$doNotTrackMoves : boolean

Do Not Use Move Syntax When Tracking Revisions

Type

boolean

$doNotTrackFormatting

$doNotTrackFormatting : boolean

Do Not Track Formatting Revisions When Tracking Revisions

Type

boolean

$evenAndOddHeaders

$evenAndOddHeaders : boolean

Enables different header for odd and even pages.

Type

boolean

$updateFields

$updateFields : boolean

Automatically Recalculate Fields on Open

Type

boolean

$decimalSymbol

$decimalSymbol : string

Radix Point for Field Code Evaluation

Type

string

$autoHyphenation

$autoHyphenation : boolean|null

Automatically hyphenate document contents when displayed

Type

boolean|null

$consecutiveHyphenLimit

$consecutiveHyphenLimit : integer|null

Maximum number of consecutively hyphenated lines

Type

integer|null

$hyphenationZone

$hyphenationZone : float|null

The allowed amount of whitespace before hyphenation is applied

Type

float|null

$doNotHyphenateCaps

$doNotHyphenateCaps : boolean|null

Do not hyphenate words in all capital letters

Type

boolean|null

Methods

hasHideSpellingErrors()

hasHideSpellingErrors() : boolean

Are spelling errors hidden

Returns

boolean

setHideSpellingErrors()

setHideSpellingErrors(boolean  $hideSpellingErrors) 

Hide spelling errors

Parameters

boolean $hideSpellingErrors

hasHideGrammaticalErrors()

hasHideGrammaticalErrors() : boolean

Are grammatical errors hidden

Returns

boolean

setHideGrammaticalErrors()

setHideGrammaticalErrors(boolean  $hideGrammaticalErrors) 

Hide grammatical errors

Parameters

boolean $hideGrammaticalErrors

hasEvenAndOddHeaders()

hasEvenAndOddHeaders() : boolean

Returns

boolean

setEvenAndOddHeaders()

setEvenAndOddHeaders(boolean  $evenAndOddHeaders) 

Parameters

boolean $evenAndOddHeaders

hasTrackRevisions()

hasTrackRevisions() : boolean

Returns

boolean

setTrackRevisions()

setTrackRevisions(boolean  $trackRevisions) 

Parameters

boolean $trackRevisions

hasDoNotTrackMoves()

hasDoNotTrackMoves() : boolean

Returns

boolean

setDoNotTrackMoves()

setDoNotTrackMoves(boolean  $doNotTrackMoves) 

Parameters

boolean $doNotTrackMoves

hasDoNotTrackFormatting()

hasDoNotTrackFormatting() : boolean

Returns

boolean

setDoNotTrackFormatting()

setDoNotTrackFormatting(boolean  $doNotTrackFormatting) 

Parameters

boolean $doNotTrackFormatting

getZoom()

getZoom() : mixed

Returns

mixed

setZoom()

setZoom(mixed  $zoom) 

Parameters

mixed $zoom

hasMirrorMargins()

hasMirrorMargins() : boolean

Returns

boolean

setMirrorMargins()

setMirrorMargins(boolean  $mirrorMargins) 

Parameters

boolean $mirrorMargins

setThemeFontLang()

setThemeFontLang(\PhpOffice\PhpWord\Style\Language  $themeFontLang) 

sets the Language for this document

Parameters

\PhpOffice\PhpWord\Style\Language $themeFontLang

hasUpdateFields()

hasUpdateFields() : boolean

Returns

boolean

setUpdateFields()

setUpdateFields(boolean  $updateFields) 

Parameters

boolean $updateFields

getDecimalSymbol()

getDecimalSymbol() : string

Returns the Radix Point for Field Code Evaluation

Returns

string

setDecimalSymbol()

setDecimalSymbol(string  $decimalSymbol) 

sets the Radix Point for Field Code Evaluation

Parameters

string $decimalSymbol

hasAutoHyphenation()

hasAutoHyphenation() : boolean|null

Returns

boolean|null

setAutoHyphenation()

setAutoHyphenation(boolean  $autoHyphenation) 

Parameters

boolean $autoHyphenation

getConsecutiveHyphenLimit()

getConsecutiveHyphenLimit() : integer|null

Returns

integer|null

setConsecutiveHyphenLimit()

setConsecutiveHyphenLimit(integer  $consecutiveHyphenLimit) 

Parameters

integer $consecutiveHyphenLimit

getHyphenationZone()

getHyphenationZone() : float|null

Returns

float|null

setHyphenationZone()

setHyphenationZone(float  $hyphenationZone) 

Parameters

float $hyphenationZone

Measurement unit is twip

hasDoNotHyphenateCaps()

hasDoNotHyphenateCaps() : null|boolean

Returns

null|boolean

setDoNotHyphenateCaps()

setDoNotHyphenateCaps(boolean  $doNotHyphenateCaps) 

Parameters

boolean $doNotHyphenateCaps