Class CharacterStyle

Hierarchy

Style
- CharacterStyle
  - HyperlinkStyle

Index

Constructors

constructor

Properties

root
rootKey

Methods

Constructors

constructor

new CharacterStyle(styleId: string, name?: undefined | string): CharacterStyle

Overrides Style.constructor
- Defined in file/styles/style/index.ts:254
Parameters
- styleId: string
- Optional name: undefined | string
Returns CharacterStyle

Properties

Protected root

root: Array<BaseXmlComponent | string>

Protected rootKey

rootKey: string

Methods

addRunProperty

addRunProperty(property: XmlComponent): void

- Defined in file/styles/style/index.ts:269
Parameters
- property: XmlComponent
Returns void

basedOn

basedOn(parentId: string): CharacterStyle

- Defined in file/styles/style/index.ts:264
Parameters
- parentId: string
Returns CharacterStyle

color

color(color: string): CharacterStyle

- Defined in file/styles/style/index.ts:273
Parameters
- color: string
Returns CharacterStyle

prepForXml

prepForXml(): IXmlableObject

Inherited from XmlComponent.prepForXml

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

push

push(styleSegment: XmlComponent): void

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

underline

underline(underlineType?: undefined | string, color?: undefined | string): CharacterStyle

- Defined in file/styles/style/index.ts:278
Parameters
- Optional underlineType: undefined | string
- Optional color: undefined | string
Returns CharacterStyle

Generated using TypeDoc