PHP Class PhpOffice\PhpPresentation\Shape\RichText

Inheritance: extends PhpOffice\PhpPresentation\AbstractShape, implements PhpOffice\PhpPresentation\ComparableInterface

Afficher le fichier Open project: phpoffice/phppowerpoint Class Usage Examples

Méthodes publiques

Méthode	Description
__construct ( )	Create a new \PhpOffice\PhpPresentation\Shape\RichText instance
__toString ( ) : string	Convert to string
addText ( PhpOffice\PhpPresentation\Shape\RichText\TextElementInterface $pText = null ) : RichText	Add text
createBreak ( ) : BreakElement	Create break
createParagraph ( ) : Paragraph	Create paragraph
createText ( string $pText = '' ) : TextElement	Create text (can not be formatted !)
createTextRun ( string $pText = '' ) : PhpOffice\PhpPresentation\Shape\RichText\Run	Create text run (can be formatted)
getActiveParagraph ( ) : Paragraph	Get active paragraph
getActiveParagraphIndex ( ) : integer	Get active paragraph index
getAutoFit ( ) : string	Get autofit
getColumns ( ) : integer	Get columns
getFontScale ( ) : float	Get pourcentage of fontScale
getHashCode ( ) : string	Get hash code
getHorizontalOverflow ( ) : string	Get horizontal overflow
getInsetBottom ( ) : float	Get bottom inset
getInsetLeft ( ) : float	Get left inset
getInsetRight ( ) : float	Get right inset
getInsetTop ( ) : float	Get top inset
getLineSpaceReduction ( ) : float	Get pourcentage of the line space reduction
getParagraph ( integer $index ) : Paragraph	Get paragraph
getParagraphs ( ) : Paragraph[]	Get paragraphs
getPlainText ( ) : string	Get plain text
getVerticalOverflow ( ) : string	Get vertical overflow
getWrap ( ) : string	Get text wrapping
hasAutoShrinkHorizontal ( ) : boolean	Get horizontal auto shrink
hasAutoShrinkVertical ( ) : boolean	Set vertical auto shrink
isUpright ( ) : boolean	Get upright
isVertical ( ) : boolean	Get vertical
setActiveParagraph ( integer $index ) : Paragraph	Set active paragraph
setAutoFit ( $value = self::AUTOFIT_DEFAULT, $fontScale = null, $lnSpcReduction = null ) : RichText	Set autofit
setAutoShrinkHorizontal ( boolean $value = null )	Set horizontal auto shrink
setAutoShrinkVertical ( boolean $value = null )	Set vertical auto shrink
setColumns ( $value = 1 ) : RichText	Set columns
setHorizontalOverflow ( $value = self::OVERFLOW_OVERFLOW ) : RichText	Set horizontal overflow
setInsetBottom ( $value = 4.8 ) : RichText	Set bottom inset
setInsetLeft ( $value = 9.6 ) : RichText	Set left inset
setInsetRight ( $value = 9.6 ) : RichText	Set left inset
setInsetTop ( $value = 4.8 ) : RichText	Set top inset
setParagraphs ( Paragraph[] $paragraphs = null ) : RichText	Set paragraphs
setUpright ( $value = false ) : RichText	Set vertical
setVertical ( $value = false ) : RichText	Set vertical
setVerticalOverflow ( $value = self::OVERFLOW_OVERFLOW ) : RichText	Set vertical overflow
setWrap ( $value = self::WRAP_SQUARE ) : RichText	Set text wrapping

Method Details

__construct() public méthode

Create a new \PhpOffice\PhpPresentation\Shape\RichText instance

public __construct ( )

__toString() public méthode

Convert to string

public __toString ( ) : string
Résultat	string

addText() public méthode

Add text

public addText ( PhpOffice\PhpPresentation\Shape\RichText\TextElementInterface $pText = null ) : RichText
$pText	PhpOffice\PhpPresentation\Shape\RichText\TextElementInterface	Rich text element
Résultat	RichText

createBreak() public méthode

Create break

public createBreak ( ) : BreakElement
Résultat	PhpOffice\PhpPresentation\Shape\RichText\BreakElement

createParagraph() public méthode

Create paragraph

public createParagraph ( ) : Paragraph
Résultat	PhpOffice\PhpPresentation\Shape\RichText\Paragraph

createText() public méthode

Create text (can not be formatted !)

public createText ( string $pText = '' ) : TextElement
$pText	string	Text
Résultat	PhpOffice\PhpPresentation\Shape\RichText\TextElement

createTextRun() public méthode

Create text run (can be formatted)

public createTextRun ( string $pText = '' ) : PhpOffice\PhpPresentation\Shape\RichText\Run
$pText	string	Text
Résultat	PhpOffice\PhpPresentation\Shape\RichText\Run

getActiveParagraph() public méthode

Get active paragraph

public getActiveParagraph ( ) : Paragraph
Résultat	PhpOffice\PhpPresentation\Shape\RichText\Paragraph

getActiveParagraphIndex() public méthode

Get active paragraph index

public getActiveParagraphIndex ( ) : integer
Résultat	integer

getAutoFit() public méthode

Get autofit

public getAutoFit ( ) : string
Résultat	string

getColumns() public méthode

Get columns

public getColumns ( ) : integer
Résultat	integer

getFontScale() public méthode

Get pourcentage of fontScale

public getFontScale ( ) : float
Résultat	float

getHashCode() public méthode

Get hash code

public getHashCode ( ) : string
Résultat	string	Hash code

getHorizontalOverflow() public méthode

Get horizontal overflow

public getHorizontalOverflow ( ) : string
Résultat	string

getInsetBottom() public méthode

Get bottom inset

public getInsetBottom ( ) : float
Résultat	float

getInsetLeft() public méthode

Get left inset

public getInsetLeft ( ) : float
Résultat	float

getInsetRight() public méthode

Get right inset

public getInsetRight ( ) : float
Résultat	float

getInsetTop() public méthode

Get top inset

public getInsetTop ( ) : float
Résultat	float

getLineSpaceReduction() public méthode

Get pourcentage of the line space reduction

public getLineSpaceReduction ( ) : float
Résultat	float

getParagraph() public méthode

Get paragraph

public getParagraph ( integer $index ) : Paragraph
$index	integer
Résultat	PhpOffice\PhpPresentation\Shape\RichText\Paragraph

getParagraphs() public méthode

Get paragraphs

public getParagraphs ( ) : Paragraph[]
Résultat	PhpOffice\PhpPresentation\Shape\RichText\Paragraph[]

getPlainText() public méthode

Get plain text

public getPlainText ( ) : string
Résultat	string

getVerticalOverflow() public méthode

Get vertical overflow

public getVerticalOverflow ( ) : string
Résultat	string

getWrap() public méthode

Get text wrapping

public getWrap ( ) : string
Résultat	string

hasAutoShrinkHorizontal() public méthode

Get horizontal auto shrink

public hasAutoShrinkHorizontal ( ) : boolean
Résultat	boolean

hasAutoShrinkVertical() public méthode

Set vertical auto shrink

public hasAutoShrinkVertical ( ) : boolean
Résultat	boolean

isUpright() public méthode

Get upright

public isUpright ( ) : boolean
Résultat	boolean

isVertical() public méthode

Get vertical

public isVertical ( ) : boolean
Résultat	boolean

setActiveParagraph() public méthode

Set active paragraph

public setActiveParagraph ( integer $index ) : Paragraph
$index	integer
Résultat	PhpOffice\PhpPresentation\Shape\RichText\Paragraph

setAutoFit() public méthode

Set autofit

public setAutoFit ( $value = self::AUTOFIT_DEFAULT, $fontScale = null, $lnSpcReduction = null ) : RichText
$value		string
$fontScale		float
$lnSpcReduction		float
Résultat	RichText

setAutoShrinkHorizontal() public méthode

Set horizontal auto shrink

public setAutoShrinkHorizontal ( boolean $value = null )
$value	boolean

setAutoShrinkVertical() public méthode

Set vertical auto shrink

public setAutoShrinkVertical ( boolean $value = null )
$value	boolean

setColumns() public méthode

Set columns

public setColumns ( $value = 1 ) : RichText
$value		int
Résultat	RichText

setHorizontalOverflow() public méthode

Set horizontal overflow

public setHorizontalOverflow ( $value = self::OVERFLOW_OVERFLOW ) : RichText
$value		string
Résultat	RichText

setInsetBottom() public méthode

Set bottom inset

public setInsetBottom ( $value = 4.8 ) : RichText
$value		float
Résultat	RichText

setInsetLeft() public méthode

Set left inset

public setInsetLeft ( $value = 9.6 ) : RichText
$value		float
Résultat	RichText

setInsetRight() public méthode

Set left inset

public setInsetRight ( $value = 9.6 ) : RichText
$value		float
Résultat	RichText

setInsetTop() public méthode

Set top inset

public setInsetTop ( $value = 4.8 ) : RichText
$value		float
Résultat	RichText

setParagraphs() public méthode

Set paragraphs

public setParagraphs ( Paragraph[] $paragraphs = null ) : RichText
$paragraphs	PhpOffice\PhpPresentation\Shape\RichText\Paragraph[]	Array of paragraphs
Résultat	RichText

setUpright() public méthode

Set vertical

public setUpright ( $value = false ) : RichText
$value		boolean
Résultat	RichText

setVertical() public méthode

Set vertical

public setVertical ( $value = false ) : RichText
$value		boolean
Résultat	RichText

setVerticalOverflow() public méthode

Set vertical overflow

public setVerticalOverflow ( $value = self::OVERFLOW_OVERFLOW ) : RichText
$value		string
Résultat	RichText

setWrap() public méthode

Set text wrapping

public setWrap ( $value = self::WRAP_SQUARE ) : RichText
$value		string
Résultat	RichText