Documentation

Settings

Setting class

Tags
since
0.14.0
see
http://www.datypic.com/sc/ooxml/t-w_CT_Settings.html

Table of Contents

$autoHyphenation  : bool|null
Automatically hyphenate document contents when displayed
$consecutiveHyphenLimit  : int|null
Maximum number of consecutively hyphenated lines
$decimalSymbol  : string
Radix Point for Field Code Evaluation
$documentProtection  : Protection
Document Editing Restrictions
$doNotHyphenateCaps  : bool|null
Do not hyphenate words in all capital letters
$doNotTrackFormatting  : bool
Do Not Track Formatting Revisions When Tracking Revisions
$doNotTrackMoves  : bool
Do Not Use Move Syntax When Tracking Revisions
$evenAndOddHeaders  : bool
Enables different header for odd and even pages.
$hideGrammaticalErrors  : bool
Hide grammatical errors
$hideSpellingErrors  : bool
Hide spelling errors
$hyphenationZone  : float|null
The allowed amount of whitespace before hyphenation is applied
$mirrorMargins  : bool
Mirror Page Margins
$proofState  : ProofState
Spelling and Grammatical Checking State
$revisionView  : TrackChangesView
Visibility of Annotation Types
$themeFontLang  : Language
Theme Font Languages
$trackRevisions  : bool
Track Revisions to Document
$updateFields  : bool
Automatically Recalculate Fields on Open
$zoom  : mixed
Magnification Setting
getConsecutiveHyphenLimit()  : int|null
getDecimalSymbol()  : string
Returns the Radix Point for Field Code Evaluation
getDocumentProtection()  : Protection
getHyphenationZone()  : float|null
getProofState()  : ProofState
getRevisionView()  : TrackChangesView
Get the Visibility of Annotation Types
getThemeFontLang()  : Language
Returns the Language
getZoom()  : mixed
hasAutoHyphenation()  : bool|null
hasDoNotHyphenateCaps()  : null|bool
hasDoNotTrackFormatting()  : bool
hasDoNotTrackMoves()  : bool
hasEvenAndOddHeaders()  : bool
hasHideGrammaticalErrors()  : bool
Are grammatical errors hidden
hasHideSpellingErrors()  : bool
Are spelling errors hidden
hasMirrorMargins()  : bool
hasTrackRevisions()  : bool
hasUpdateFields()  : bool
setAutoHyphenation()  : mixed
setConsecutiveHyphenLimit()  : mixed
setDecimalSymbol()  : mixed
sets the Radix Point for Field Code Evaluation
setDocumentProtection()  : mixed
setDoNotHyphenateCaps()  : mixed
setDoNotTrackFormatting()  : mixed
setDoNotTrackMoves()  : mixed
setEvenAndOddHeaders()  : mixed
setHideGrammaticalErrors()  : mixed
Hide grammatical errors
setHideSpellingErrors()  : mixed
Hide spelling errors
setHyphenationZone()  : mixed
setMirrorMargins()  : mixed
setProofState()  : mixed
setRevisionView()  : mixed
Set the Visibility of Annotation Types
setThemeFontLang()  : mixed
sets the Language for this document
setTrackRevisions()  : mixed
setUpdateFields()  : mixed
setZoom()  : mixed

Properties

$autoHyphenation

Automatically hyphenate document contents when displayed

private bool|null $autoHyphenation

$consecutiveHyphenLimit

Maximum number of consecutively hyphenated lines

private int|null $consecutiveHyphenLimit

$decimalSymbol

Radix Point for Field Code Evaluation

private string $decimalSymbol = '.'

$doNotHyphenateCaps

Do not hyphenate words in all capital letters

private bool|null $doNotHyphenateCaps

$doNotTrackFormatting

Do Not Track Formatting Revisions When Tracking Revisions

private bool $doNotTrackFormatting = false

$doNotTrackMoves

Do Not Use Move Syntax When Tracking Revisions

private bool $doNotTrackMoves = false

$evenAndOddHeaders

Enables different header for odd and even pages.

private bool $evenAndOddHeaders = false

$hideGrammaticalErrors

Hide grammatical errors

private bool $hideGrammaticalErrors = false

$hideSpellingErrors

Hide spelling errors

private bool $hideSpellingErrors = false

$hyphenationZone

The allowed amount of whitespace before hyphenation is applied

private float|null $hyphenationZone

$trackRevisions

Track Revisions to Document

private bool $trackRevisions = false

$updateFields

Automatically Recalculate Fields on Open

private bool $updateFields = false

Methods

getConsecutiveHyphenLimit()

public getConsecutiveHyphenLimit() : int|null
Return values
int|null —

getDecimalSymbol()

Returns the Radix Point for Field Code Evaluation

public getDecimalSymbol() : string
Return values
string —

getHyphenationZone()

public getHyphenationZone() : float|null
Return values
float|null —

getZoom()

public getZoom() : mixed
Return values
mixed —

hasAutoHyphenation()

public hasAutoHyphenation() : bool|null
Return values
bool|null —

hasDoNotHyphenateCaps()

public hasDoNotHyphenateCaps() : null|bool
Return values
null|bool —

hasDoNotTrackFormatting()

public hasDoNotTrackFormatting() : bool
Return values
bool —

hasDoNotTrackMoves()

public hasDoNotTrackMoves() : bool
Return values
bool —

hasEvenAndOddHeaders()

public hasEvenAndOddHeaders() : bool
Return values
bool —

hasHideGrammaticalErrors()

Are grammatical errors hidden

public hasHideGrammaticalErrors() : bool
Return values
bool —

hasHideSpellingErrors()

Are spelling errors hidden

public hasHideSpellingErrors() : bool
Return values
bool —

hasMirrorMargins()

public hasMirrorMargins() : bool
Return values
bool —

hasTrackRevisions()

public hasTrackRevisions() : bool
Return values
bool —

hasUpdateFields()

public hasUpdateFields() : bool
Return values
bool —

setAutoHyphenation()

public setAutoHyphenation(bool $autoHyphenation) : mixed
Parameters
$autoHyphenation : bool
Return values
mixed —

setConsecutiveHyphenLimit()

public setConsecutiveHyphenLimit(int $consecutiveHyphenLimit) : mixed
Parameters
$consecutiveHyphenLimit : int
Return values
mixed —

setDecimalSymbol()

sets the Radix Point for Field Code Evaluation

public setDecimalSymbol(string $decimalSymbol) : mixed
Parameters
$decimalSymbol : string
Return values
mixed —

setDocumentProtection()

public setDocumentProtection(Protection $documentProtection) : mixed
Parameters
$documentProtection : Protection
Return values
mixed —

setDoNotHyphenateCaps()

public setDoNotHyphenateCaps(bool $doNotHyphenateCaps) : mixed
Parameters
$doNotHyphenateCaps : bool
Return values
mixed —

setDoNotTrackFormatting()

public setDoNotTrackFormatting(bool $doNotTrackFormatting) : mixed
Parameters
$doNotTrackFormatting : bool
Return values
mixed —

setDoNotTrackMoves()

public setDoNotTrackMoves(bool $doNotTrackMoves) : mixed
Parameters
$doNotTrackMoves : bool
Return values
mixed —

setEvenAndOddHeaders()

public setEvenAndOddHeaders(bool $evenAndOddHeaders) : mixed
Parameters
$evenAndOddHeaders : bool
Return values
mixed —

setHideGrammaticalErrors()

Hide grammatical errors

public setHideGrammaticalErrors(bool $hideGrammaticalErrors) : mixed
Parameters
$hideGrammaticalErrors : bool
Return values
mixed —

setHideSpellingErrors()

Hide spelling errors

public setHideSpellingErrors(bool $hideSpellingErrors) : mixed
Parameters
$hideSpellingErrors : bool
Return values
mixed —

setHyphenationZone()

public setHyphenationZone(float $hyphenationZone) : mixed
Parameters
$hyphenationZone : float

Measurement unit is twip

Return values
mixed —

setMirrorMargins()

public setMirrorMargins(bool $mirrorMargins) : mixed
Parameters
$mirrorMargins : bool
Return values
mixed —

setRevisionView()

Set the Visibility of Annotation Types

public setRevisionView([TrackChangesView $trackChangesView = null ]) : mixed
Parameters
$trackChangesView : TrackChangesView = null
Return values
mixed —

setThemeFontLang()

sets the Language for this document

public setThemeFontLang(Language $themeFontLang) : mixed
Parameters
$themeFontLang : Language
Return values
mixed —

setTrackRevisions()

public setTrackRevisions(bool $trackRevisions) : mixed
Parameters
$trackRevisions : bool
Return values
mixed —

setUpdateFields()

public setUpdateFields(bool $updateFields) : mixed
Parameters
$updateFields : bool
Return values
mixed —

setZoom()

public setZoom(mixed $zoom) : mixed
Parameters
$zoom : mixed
Return values
mixed —

Search results