Class Paragraph

Hierarchy

XmlComponent
- Paragraph
  - ImageParagraph

Index

Constructors

constructor

Accessors

IsDeleted

Methods

Constructors

constructor

new Paragraph(options: string | PictureRun | IParagraphOptions): Paragraph

Overrides XmlComponent.constructor
- Defined in file/paragraph/paragraph.ts:61
Parameters
- options: string | PictureRun | IParagraphOptions
Returns Paragraph

Accessors

IsDeleted

get IsDeleted(): boolean

Inherited from BaseXmlComponent.IsDeleted
- Defined in file/xml-components/base.ts:14
Returns boolean

Methods

addBookmark

addBookmark(bookmark: Bookmark): Paragraph

- Defined in file/paragraph/paragraph.ts:185
Parameters
- bookmark: Bookmark
Returns Paragraph

addChildElement

addChildElement(child: XmlComponent | string): XmlComponent

Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:43
Parameters
- child: XmlComponent | string
Returns XmlComponent

addHyperLink

addHyperLink(hyperlink: Hyperlink): Paragraph

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

addImage

addImage(image: Image): PictureRun

- Defined in file/paragraph/paragraph.ts:193
Parameters
- image: Image
Returns PictureRun

addRun

addRun(run: Run): Paragraph

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

addRunToFront

addRunToFront(run: Run): Paragraph

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

addSequentialIdentifier

addSequentialIdentifier(identifier: string): Paragraph

- Defined in file/paragraph/paragraph.ts:215
Parameters
- identifier: string
Returns Paragraph

delete

delete(): void

Inherited from XmlComponent.delete
- Defined in file/xml-components/xml-component.ts:49
Returns void

pageBreak

pageBreak(): Paragraph

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

prepForXml

prepForXml(): IXmlableObject | undefined

Inherited from XmlComponent.prepForXml

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

referenceFootnote

referenceFootnote(id: number): Paragraph

- Defined in file/paragraph/paragraph.ts:205
Parameters
- id: number
Returns Paragraph

Generated using TypeDoc