Documentation

Font extends AbstractStyle

Font style

Table of Contents

FGCOLOR_BLACK  = 'black'

FGCOLOR_BLUE  = 'blue'

FGCOLOR_CYAN  = 'cyan'

FGCOLOR_DARKBLUE  = 'darkBlue'

FGCOLOR_DARKCYAN  = 'darkCyan'

FGCOLOR_DARKGRAY  = 'darkGray'

FGCOLOR_DARKGREEN  = 'darkGreen'

FGCOLOR_DARKMAGENTA  = 'darkMagenta'

FGCOLOR_DARKRED  = 'darkRed'

FGCOLOR_DARKYELLOW  = 'darkYellow'

FGCOLOR_LIGHTGRAY  = 'lightGray'

FGCOLOR_LIGHTGREEN  = 'green'

FGCOLOR_MAGENTA  = 'magenta'

FGCOLOR_RED  = 'red'

FGCOLOR_YELLOW  = 'yellow'

Foreground colors

UNDERLINE_DASH  = 'dash'

UNDERLINE_DASHHEAVY  = 'dashHeavy'

UNDERLINE_DASHLONG  = 'dashLong'

UNDERLINE_DASHLONGHEAVY  = 'dashLongHeavy'

UNDERLINE_DOTDASH  = 'dotDash'

UNDERLINE_DOTDASHHEAVY  = 'dotDashHeavy'

UNDERLINE_DOTDOTDASH  = 'dotDotDash'

UNDERLINE_DOTDOTDASHHEAVY  = 'dotDotDashHeavy'

UNDERLINE_DOTHASH  = 'dotDash'

UNDERLINE_DOTHASHHEAVY  = 'dotDashHeavy'

UNDERLINE_DOTTED  = 'dotted'

UNDERLINE_DOTTEDHEAVY  = 'dottedHeavy'

UNDERLINE_DOUBLE  = 'dbl'

UNDERLINE_HEAVY  = 'heavy'

UNDERLINE_NONE  = 'none'

Underline types

UNDERLINE_SINGLE  = 'single'

UNDERLINE_WAVY  = 'wavy'

UNDERLINE_WAVYDOUBLE  = 'wavyDbl'

UNDERLINE_WAVYHEAVY  = 'wavyHeavy'

UNDERLINE_WORDS  = 'words'

$aliases  : array<string|int, mixed>

Aliases

$index  : int|null

Index number in Style collection for named style

$styleName  : string

Style name

$allCaps  : bool

All caps

$bold  : bool

Bold

$color  : string

Font color

$doubleStrikethrough  : bool

Double strikethrough

$fgColor  : string

Foreground/highlight

$hidden  : bool

Hidden text

$hint  : string

Font Content Type

$isAuto  : bool

Is this an automatic style? (Used primarily in OpenDocument driver)

$italic  : bool

Italic

$kerning  : int|float

Font kerning: halfpoint

$lang  : Language

Languages

$name  : string

Font name

$noProof  : bool

noProof (disables AutoCorrect)

$paragraph  : Paragraph

Paragraph style

$position  : int

Vertically Raised or Lowered Text

$rtl  : bool

Right to left languages

$scale  : int

Expanded/compressed text: 0-600 (percent)

$shading  : Shading

Shading

$size  : int|float

Font size

$smallCaps  : bool

Small caps

$spacing  : int|float

Character spacing adjustment: twip

$strikethrough  : bool

Strikethrough

$subScript  : bool

Subscript

$superScript  : bool

Superscript

$type  : string

Font style type

$underline  : string

Undeline

__construct()  : mixed

Create new font style

getBgColor()  : string

Get background

getBold()  : mixed

Get bold

getChildStyleValue()  : mixed

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`

getColor()  : string

Get font color

getFgColor()  : string

Get foreground/highlight color

getHint()  : string

Get Font Content Type

getIndex()  : int|null

Get index number

getItalic()  : mixed

Get italic

getKerning()  : int|float

Get font kerning

getLang()  : Language

Get language

getLineHeight()  : int|float

Get line height

getName()  : string

Get font name

getParagraph()  : Paragraph

Get paragraph style

getParagraphStyle()  : mixed

Get paragraph style

getPosition()  : int

Get position

getScale()  : int

Get scale

getShading()  : Shading

Get shading

getSize()  : int|float

Get font size

getSpacing()  : int|float

Get font spacing

getStrikethrough()  : mixed

Get strikethrough

getStyleName()  : string

Get style name

getStyleType()  : string

Get style type

getStyleValues()  : array<string|int, mixed>

Get style values

getSubScript()  : mixed

Get subscript

getSuperScript()  : mixed

Get superscript

getUnderline()  : string

Get underline

isAllCaps()  : bool

Get all caps

isAuto()  : bool

Get is automatic style flag

isBold()  : bool

Get bold

isDoubleStrikethrough()  : bool

Get double strikethrough

isHidden()  : bool

Get hidden text

isItalic()  : bool

Get italic

isNoProof()  : bool

Get noProof (disables autocorrect)

isRTL()  : bool

Get rtl

isSmallCaps()  : bool

Get small caps

isStrikethrough()  : bool

Get strikethrough

isSubScript()  : bool

Get subscript

isSuperScript()  : bool

Get superscript

setAllCaps()  : self

Set all caps

setArrayStyle()  : self

Set style using associative array

setAuto()  : self

Set is automatic style flag

setBgColor()  : Table

Set background

setBold()  : self

Set bold

setColor()  : self

Set font color

setDoubleStrikethrough()  : self

Set double strikethrough

setFgColor()  : self

Set foreground/highlight color

setHidden()  : self

Set hidden text

setHint()  : self

Set Font Content Type

setIndex()  : self

Set index number

setItalic()  : self

Set italic

setKerning()  : self

Set font kerning

setLang()  : self

Set language

setLineHeight()  : self

Set lineheight

setName()  : self

Set font name

setNoProof()  : $this

Set noProof (disables autocorrect)

setParagraph()  : self

Set Paragraph

setPosition()  : self

Set position

setRTL()  : self

Set rtl

setScale()  : self

Set scale

setShading()  : self

Set shading

setSize()  : self

Set font size

setSmallCaps()  : self

Set small caps

setSpacing()  : self

Set font spacing

setStrikethrough()  : self

Set strikethrough

setStyleByArray()  : self

Set style by using associative array

setStyleName()  : self

Set style name

setStyleValue()  : self

Set style value template method

setSubScript()  : self

Set subscript

setSuperScript()  : self

Set superscript

setUnderline()  : self

Set underline

setBoolVal()  : bool

Set bool value

setEnumVal()  : mixed

Set enum value

setFloatVal()  : float|null

Set float value: Convert string that contains only numeric into float

setIntVal()  : int|null

Set integer value: Convert string that contains only numeric into integer

setNonEmptyVal()  : string

Set default for null and empty value

setNumericVal()  : int|float|null

Set numeric value

setObjectVal()  : mixed

Set object value

setPairedVal()  : self

Set $property value and set $pairProperty = false when $value = true