WIKINDX API trunk

MISC

Table of Contents

Functions

needNumbering()  : bool
Set and get the flag indicating if the word/numbering.xml file needs to be written (e.g., for lists, endnotes, and so on)
needTables()  : bool
Set and get the flag indicating if the xml string needs DOM-traversal in order to insert table headers (see \DOCX\format\TABLES\writeTableHeaders())
needSections()  : bool
Set and get the flag indicating if the xml string needs DOM-traversal in order to insert sections (see \DOCX\format\SECTIONS\writeSections())
needFootnotes()  : bool
Set and get the flag indicating if the xml string needs DOM-traversal in order to insert footnotes (see \FOOTNOTES)
needEndnotes()  : bool
Set and get the flag indicating if the xml string needs DOM-traversal in order to insert endnotes (see \ENDNOTES)
hr()  : void
Horizontal ruler (hr)
startHyperlink()  : void
Start a hyperlink (a)
endHyperlink()  : void
End a hyperlink (a)
startHeading()  : void
Start a heading (h1, h2, etc.)
endHeading()  : void
End a heading (h1, h2, etc.)
getXmlRelsId()  : string
Produce an incrementing rId number for the document.xml.rels file.
getDotRelsId()  : string
Produce an incrementing rId number for the .rels file
genHex()  : string
Generate a unique random 8 digit hex value used for paragraph ids, table cell ids, etc.
pxToEmu()  : float
Convert pixels to emus (English Metric Units)
twipToEmu()  : int
Convert twips to emus (English Metric Units)

Functions

needNumbering()

Set and get the flag indicating if the word/numbering.xml file needs to be written (e.g., for lists, endnotes, and so on)

needNumbering(string $method) : bool
Parameters
$method : string
Return values
bool

needTables()

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert table headers (see \DOCX\format\TABLES\writeTableHeaders())

needTables(string $method) : bool
Parameters
$method : string
Return values
bool

needSections()

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert sections (see \DOCX\format\SECTIONS\writeSections())

needSections(string $method) : bool
Parameters
$method : string
Return values
bool

needFootnotes()

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert footnotes (see \FOOTNOTES)

needFootnotes(string $method) : bool
Parameters
$method : string
Return values
bool

needEndnotes()

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert endnotes (see \ENDNOTES)

needEndnotes(string $method) : bool
Parameters
$method : string
Return values
bool

hr()

Horizontal ruler (hr)

hr(XMLWriter $xml) : void
Parameters
$xml : XMLWriter

startHyperlink()

Start a hyperlink (a)

startHyperlink(XMLWriter $xml, string $url) : void
Parameters
$xml : XMLWriter
$url : string

endHyperlink()

End a hyperlink (a)

endHyperlink(XMLWriter $xml) : void
Parameters
$xml : XMLWriter

startHeading()

Start a heading (h1, h2, etc.)

startHeading([XMLWriter $xml = NULL ], string $size) : void

A heading is text enclosed within a paragraph

Parameters
$xml : XMLWriter = NULL

Default NULL

$size : string

endHeading()

End a heading (h1, h2, etc.)

endHeading(XMLWriter $xml) : void
Parameters
$xml : XMLWriter

getXmlRelsId()

Produce an incrementing rId number for the document.xml.rels file.

getXmlRelsId() : string

This is also used for the generation of rId numbers for footnotes, endnotes, hyperlinks, and images.

Return values
string

getDotRelsId()

Produce an incrementing rId number for the .rels file

getDotRelsId() : string
Return values
string

genHex()

Generate a unique random 8 digit hex value used for paragraph ids, table cell ids, etc.

genHex() : string
Return values
string

pxToEmu()

Convert pixels to emus (English Metric Units)

pxToEmu(float $px) : float

There are 96 pixels / inch There are 914,400 emus / inch Therefore, each pixel is 9525 emus (914,400 / 96)

Parameters
$px : float
Return values
float

twipToEmu()

Convert twips to emus (English Metric Units)

twipToEmu(int $twip) : int

There are 1440 twips / inch There are 914,400 emus / inch Therefore, each twip is 635 emus (914,400 / 1440)

Parameters
$twip : int
Return values
int 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results