Class HeadingStyle

Hierarchy

ParagraphStyle
- HeadingStyle

Index

Constructors

constructor

Properties

root
rootKey

Methods

Constructors

constructor

new HeadingStyle(styleId: string, name: string): HeadingStyle

Overrides ParagraphStyle.constructor
- Defined in styles/style/index.ts:195
Parameters
- styleId: string
- name: string
Returns HeadingStyle

Properties

Protected root

root: Array<BaseXmlComponent | string>

Protected rootKey

rootKey: string

Methods

addParagraphProperty

addParagraphProperty(property: XmlComponent): void

Inherited from ParagraphStyle.addParagraphProperty
- Defined in styles/style/index.ts:52
Parameters
- property: XmlComponent
Returns void

addRunProperty

addRunProperty(property: XmlComponent): void

Inherited from ParagraphStyle.addRunProperty
- Defined in styles/style/index.ts:56
Parameters
- property: XmlComponent
Returns void

allCaps

allCaps(): ParagraphStyle

Inherited from ParagraphStyle.allCaps
- Defined in styles/style/index.ts:97
Returns ParagraphStyle

basedOn

basedOn(parentId: string): ParagraphStyle

Inherited from ParagraphStyle.basedOn
- Defined in styles/style/index.ts:60
Parameters
- parentId: string
Returns ParagraphStyle

bold

bold(): ParagraphStyle

Inherited from ParagraphStyle.bold
- Defined in styles/style/index.ts:82
Returns ParagraphStyle

center

center(): ParagraphStyle

Inherited from ParagraphStyle.center
- Defined in styles/style/index.ts:139
Returns ParagraphStyle

color

color(color: string): ParagraphStyle

Inherited from ParagraphStyle.color
- Defined in styles/style/index.ts:127
Parameters
- color: string
Returns ParagraphStyle

doubleStrike

doubleStrike(): ParagraphStyle

Inherited from ParagraphStyle.doubleStrike
- Defined in styles/style/index.ts:107
Returns ParagraphStyle

font

font(fontName: string): ParagraphStyle

Inherited from ParagraphStyle.font
- Defined in styles/style/index.ts:132
Parameters
- fontName: string
Returns ParagraphStyle

indent

indent(left: number, hanging?: number): ParagraphStyle

Inherited from ParagraphStyle.indent
- Defined in styles/style/index.ts:174
Parameters
- left: number
- Optional hanging: number
Returns ParagraphStyle

italics

italics(): ParagraphStyle

Inherited from ParagraphStyle.italics
- Defined in styles/style/index.ts:87
Returns ParagraphStyle

justified

justified(): ParagraphStyle

Inherited from ParagraphStyle.justified
- Defined in styles/style/index.ts:154
Returns ParagraphStyle

keepLines

keepLines(): ParagraphStyle

Inherited from ParagraphStyle.keepLines
- Defined in styles/style/index.ts:189
Returns ParagraphStyle

keepNext

keepNext(): ParagraphStyle

Inherited from ParagraphStyle.keepNext
- Defined in styles/style/index.ts:184
Returns ParagraphStyle

left

left(): ParagraphStyle

Inherited from ParagraphStyle.left
- Defined in styles/style/index.ts:144
Returns ParagraphStyle

leftTabStop

leftTabStop(position: number): ParagraphStyle

Inherited from ParagraphStyle.leftTabStop
- Defined in styles/style/index.ts:169
Parameters
- position: number
Returns ParagraphStyle

maxRightTabStop

maxRightTabStop(): ParagraphStyle

Inherited from ParagraphStyle.maxRightTabStop
- Defined in styles/style/index.ts:164
Returns ParagraphStyle

next

next(nextId: string): ParagraphStyle

Inherited from ParagraphStyle.next
- Defined in styles/style/index.ts:70
Parameters
- nextId: string
Returns ParagraphStyle

prepForXml

prepForXml(): XmlableObject

Inherited from XmlComponent.prepForXml

Overrides BaseXmlComponent.prepForXml
- Defined in docx/xml-components/index.ts:12
Returns XmlableObject

push

push(styleSegment: XmlComponent): void

Inherited from Style.push
- Defined in styles/style/index.ts:34
Parameters
- styleSegment: XmlComponent
Returns void

quickFormat

quickFormat(): ParagraphStyle

Inherited from ParagraphStyle.quickFormat
- Defined in styles/style/index.ts:65
Returns ParagraphStyle

right

right(): ParagraphStyle

Inherited from ParagraphStyle.right
- Defined in styles/style/index.ts:149
Returns ParagraphStyle

size

size(twips: number): ParagraphStyle

Inherited from ParagraphStyle.size
- Defined in styles/style/index.ts:77
Parameters
- twips: number
Returns ParagraphStyle

smallCaps

smallCaps(): ParagraphStyle

Inherited from ParagraphStyle.smallCaps
- Defined in styles/style/index.ts:92
Returns ParagraphStyle

spacing

spacing(params: ISpacingProperties): ParagraphStyle

Inherited from ParagraphStyle.spacing
- Defined in styles/style/index.ts:179
Parameters
- params: ISpacingProperties
Returns ParagraphStyle

strike

strike(): ParagraphStyle

Inherited from ParagraphStyle.strike
- Defined in styles/style/index.ts:102
Returns ParagraphStyle

subScript

subScript(): ParagraphStyle

Inherited from ParagraphStyle.subScript
- Defined in styles/style/index.ts:112
Returns ParagraphStyle

superScript

superScript(): ParagraphStyle

Inherited from ParagraphStyle.superScript
- Defined in styles/style/index.ts:117
Returns ParagraphStyle

thematicBreak

thematicBreak(): ParagraphStyle

Inherited from ParagraphStyle.thematicBreak
- Defined in styles/style/index.ts:159
Returns ParagraphStyle

underline

underline(underlineType?: string, color?: string): ParagraphStyle

Inherited from ParagraphStyle.underline
- Defined in styles/style/index.ts:122
Parameters
- Optional underlineType: string
- Optional color: string
Returns ParagraphStyle

Generated using TypeDoc