Documentation

Settings
in package

Setting class.

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

Table of Contents

Properties

$autoHyphenation  : null|bool
Automatically hyphenate document contents when displayed.
$bookFoldPrinting  : bool
Enable or disable book-folded printing.
$consecutiveHyphenLimit  : null|int
Maximum number of consecutively hyphenated lines.
$decimalSymbol  : string
Radix Point for Field Code Evaluation.
$documentProtection  : Protection
Document Editing Restrictions.
$doNotHyphenateCaps  : null|bool
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  : null|float|int
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|null
Theme Font Languages.
$trackRevisions  : bool
Track Revisions to Document.
$updateFields  : bool
Automatically Recalculate Fields on Open.
$zoom  : mixed
Magnification Setting.

Methods

getConsecutiveHyphenLimit()  : null|int
getDecimalSymbol()  : string
Returns the Radix Point for Field Code Evaluation.
getDocumentProtection()  : Protection
getHyphenationZone()  : null|float|int
getProofState()  : ProofState
getRevisionView()  : TrackChangesView
Get the Visibility of Annotation Types.
getThemeFontLang()  : Language|null
Returns the Language.
getZoom()  : mixed
hasAutoHyphenation()  : null|bool
hasBookFoldPrinting()  : bool
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()  : void
setBookFoldPrinting()  : self
setConsecutiveHyphenLimit()  : void
setDecimalSymbol()  : void
sets the Radix Point for Field Code Evaluation.
setDocumentProtection()  : void
setDoNotHyphenateCaps()  : void
setDoNotTrackFormatting()  : void
setDoNotTrackMoves()  : void
setEvenAndOddHeaders()  : void
setHideGrammaticalErrors()  : void
Hide grammatical errors.
setHideSpellingErrors()  : void
Hide spelling errors.
setHyphenationZone()  : void
setMirrorMargins()  : void
setProofState()  : void
setRevisionView()  : void
Set the Visibility of Annotation Types.
setThemeFontLang()  : self
Sets the Language for this document.
setTrackRevisions()  : void
setUpdateFields()  : void
setZoom()  : void

Properties

$autoHyphenation

Automatically hyphenate document contents when displayed.

private null|bool $autoHyphenation

$bookFoldPrinting

Enable or disable book-folded printing.

private bool $bookFoldPrinting = false

$consecutiveHyphenLimit

Maximum number of consecutively hyphenated lines.

private null|int $consecutiveHyphenLimit

$decimalSymbol

Radix Point for Field Code Evaluation.

private string $decimalSymbol = '.'

$documentProtection

Document Editing Restrictions.

private Protection $documentProtection

$doNotHyphenateCaps

Do not hyphenate words in all capital letters.

private null|bool $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 null|float|int $hyphenationZone

$trackRevisions

Track Revisions to Document.

private bool $trackRevisions = false

$updateFields

Automatically Recalculate Fields on Open.

private bool $updateFields = false

Methods

getConsecutiveHyphenLimit()

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

getDecimalSymbol()

Returns the Radix Point for Field Code Evaluation.

public getDecimalSymbol() : string
Return values
string

getHyphenationZone()

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

hasAutoHyphenation()

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

hasBookFoldPrinting()

public hasBookFoldPrinting() : bool
Return values
bool

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) : void
Parameters
$autoHyphenation : bool

setBookFoldPrinting()

public setBookFoldPrinting(bool $bookFoldPrinting) : self
Parameters
$bookFoldPrinting : bool
Return values
self

setConsecutiveHyphenLimit()

public setConsecutiveHyphenLimit(int $consecutiveHyphenLimit) : void
Parameters
$consecutiveHyphenLimit : int

setDecimalSymbol()

sets the Radix Point for Field Code Evaluation.

public setDecimalSymbol(string $decimalSymbol) : void
Parameters
$decimalSymbol : string

setDoNotHyphenateCaps()

public setDoNotHyphenateCaps(bool $doNotHyphenateCaps) : void
Parameters
$doNotHyphenateCaps : bool

setDoNotTrackFormatting()

public setDoNotTrackFormatting(bool|null $doNotTrackFormatting) : void
Parameters
$doNotTrackFormatting : bool|null

setDoNotTrackMoves()

public setDoNotTrackMoves(bool|null $doNotTrackMoves) : void
Parameters
$doNotTrackMoves : bool|null

setEvenAndOddHeaders()

public setEvenAndOddHeaders(bool|null $evenAndOddHeaders) : void
Parameters
$evenAndOddHeaders : bool|null

setHideGrammaticalErrors()

Hide grammatical errors.

public setHideGrammaticalErrors(bool|null $hideGrammaticalErrors) : void
Parameters
$hideGrammaticalErrors : bool|null

setHideSpellingErrors()

Hide spelling errors.

public setHideSpellingErrors(bool|null $hideSpellingErrors) : void
Parameters
$hideSpellingErrors : bool|null

setHyphenationZone()

public setHyphenationZone(null|float|int $hyphenationZone) : void
Parameters
$hyphenationZone : null|float|int

Measurement unit is twip

setMirrorMargins()

public setMirrorMargins(bool $mirrorMargins) : void
Parameters
$mirrorMargins : bool

setRevisionView()

Set the Visibility of Annotation Types.

public setRevisionView([TrackChangesView|null $trackChangesView = null ]) : void
Parameters
$trackChangesView : TrackChangesView|null = null

setThemeFontLang()

Sets the Language for this document.

public setThemeFontLang(Language $themeFontLang) : self
Parameters
$themeFontLang : Language
Return values
self

setTrackRevisions()

public setTrackRevisions(bool|null $trackRevisions) : void
Parameters
$trackRevisions : bool|null

setUpdateFields()

public setUpdateFields(bool|null $updateFields) : void
Parameters
$updateFields : bool|null

setZoom()

public setZoom(mixed $zoom) : void
Parameters
$zoom : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results