Class CharacterStyle

Hierarchy

Style
- CharacterStyle
  - HyperlinkStyle
  - FootnoteTextChar

Index

Constructors

constructor

Accessors

IsDeleted

Methods

Constructors

constructor

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

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

Accessors

IsDeleted

get IsDeleted(): boolean

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

Methods

addChildElement

addChildElement(child: XmlComponent | string): XmlComponent

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

addRunProperty

addRunProperty(property: XmlComponent): CharacterStyle

- Defined in file/styles/style/index.ts:252
Parameters
- property: XmlComponent
Returns CharacterStyle

basedOn

basedOn(parentId: string): CharacterStyle

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

color

color(color: string): CharacterStyle

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

delete

delete(): void

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

prepForXml

prepForXml(): IXmlableObject | undefined

Inherited from XmlComponent.prepForXml

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

push

push(styleSegment: XmlComponent): void

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

size

size(twips: number): CharacterStyle

- Defined in file/styles/style/index.ts:265
Parameters
- twips: number
Returns CharacterStyle

underline

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

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

Generated using TypeDoc