Class Paragraph

Hierarchy

XmlComponent
- Paragraph

Index

Constructors

constructor

Properties

root
rootKey

Methods

Constructors

constructor

new Paragraph(text?: undefined | string): Paragraph

Overrides XmlComponent.constructor
- Defined in file/paragraph/paragraph.ts:20
Parameters
- Optional text: undefined | string
Returns Paragraph

Properties

Protected root

root: Array<BaseXmlComponent | string>

Protected rootKey

rootKey: string

Methods

addHyperLink

addHyperLink(hyperlink: Hyperlink): Paragraph

- Defined in file/paragraph/paragraph.ts:36
Parameters
- hyperlink: Hyperlink
Returns Paragraph

addRun

addRun(run: Run): Paragraph

- Defined in file/paragraph/paragraph.ts:31
Parameters
- run: Run
Returns Paragraph

bullet

bullet(indentLevel?: number): Paragraph

- Defined in file/paragraph/paragraph.ts:138
Parameters
- Default value indentLevel: number = 0
Returns Paragraph

center

center(): Paragraph

- Defined in file/paragraph/paragraph.ts:88
Returns Paragraph

centerTabStop

centerTabStop(position: number): Paragraph

- Defined in file/paragraph/paragraph.ts:133
Parameters
- position: number
Returns Paragraph

createPictureRun

createPictureRun(imageData: IMediaData): PictureRun

- Defined in file/paragraph/paragraph.ts:47
Parameters
- imageData: IMediaData
Returns PictureRun

createTextRun

createTextRun(text: string): TextRun

- Defined in file/paragraph/paragraph.ts:41
Parameters
- text: string
Returns TextRun

heading1

heading1(): Paragraph

- Defined in file/paragraph/paragraph.ts:53
Returns Paragraph

heading2

heading2(): Paragraph

- Defined in file/paragraph/paragraph.ts:58
Returns Paragraph

heading3

heading3(): Paragraph

- Defined in file/paragraph/paragraph.ts:63
Returns Paragraph

heading4

heading4(): Paragraph

- Defined in file/paragraph/paragraph.ts:68
Returns Paragraph

heading5

heading5(): Paragraph

- Defined in file/paragraph/paragraph.ts:73
Returns Paragraph

heading6

heading6(): Paragraph

- Defined in file/paragraph/paragraph.ts:78
Returns Paragraph

indent

indent(attrs: object): Paragraph

- Defined in file/paragraph/paragraph.ts:155
Parameters
- attrs: object
Returns Paragraph

justified

justified(): Paragraph

- Defined in file/paragraph/paragraph.ts:103
Returns Paragraph

keepLines

keepLines(): Paragraph

- Defined in file/paragraph/paragraph.ts:170
Returns Paragraph

keepNext

keepNext(): Paragraph

- Defined in file/paragraph/paragraph.ts:165
Returns Paragraph

left

left(): Paragraph

- Defined in file/paragraph/paragraph.ts:93
Returns Paragraph

leftTabStop

leftTabStop(position: number): Paragraph

- Defined in file/paragraph/paragraph.ts:123
Parameters
- position: number
Returns Paragraph

maxRightTabStop

maxRightTabStop(): Paragraph

- Defined in file/paragraph/paragraph.ts:118
Returns Paragraph

pageBreak

pageBreak(): Paragraph

- Defined in file/paragraph/paragraph.ts:113
Returns Paragraph

prepForXml

prepForXml(): IXmlableObject

Inherited from XmlComponent.prepForXml

Overrides BaseXmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:13
Returns IXmlableObject

right

right(): Paragraph

- Defined in file/paragraph/paragraph.ts:98
Returns Paragraph

rightTabStop

rightTabStop(position: number): Paragraph

- Defined in file/paragraph/paragraph.ts:128
Parameters
- position: number
Returns Paragraph

setNumbering

setNumbering(numbering: Num, indentLevel: number): Paragraph

- Defined in file/paragraph/paragraph.ts:144
Parameters
- numbering: Num
- indentLevel: number
Returns Paragraph

spacing

spacing(params: ISpacingProperties): Paragraph

- Defined in file/paragraph/paragraph.ts:160
Parameters
- params: ISpacingProperties
Returns Paragraph

style

style(styleId: string): Paragraph

- Defined in file/paragraph/paragraph.ts:150
Parameters
- styleId: string
Returns Paragraph

thematicBreak

thematicBreak(): Paragraph

- Defined in file/paragraph/paragraph.ts:108
Returns Paragraph

title

title(): Paragraph

- Defined in file/paragraph/paragraph.ts:83
Returns Paragraph

Generated using TypeDoc