Class CharacterStyle

Hierarchy

Style
- CharacterStyle

Index

Constructors

constructor

Accessors

IsDeleted

Methods

Constructors

constructor

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

Overrides Style.constructor
- Defined in file/styles/style/character-style.ts:8
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:14
Returns boolean

Methods

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

addRunProperty

addRunProperty(property: XmlComponent): CharacterStyle

- Defined in file/styles/style/character-style.ts:23
Parameters
- property: XmlComponent
Returns CharacterStyle

basedOn

basedOn(parentId: string): CharacterStyle

- Defined in file/styles/style/character-style.ts:18
Parameters
- parentId: string
Returns CharacterStyle

bold

bold(): CharacterStyle

- Defined in file/styles/style/character-style.ts:32
Returns CharacterStyle

color

color(color: string): CharacterStyle

- Defined in file/styles/style/character-style.ts:28
Parameters
- color: string
Returns CharacterStyle

delete

delete(): void

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

highlight

highlight(color: string): CharacterStyle

- Defined in file/styles/style/character-style.ts:62
Parameters
- color: string
Returns CharacterStyle

italics

italics(): CharacterStyle

- Defined in file/styles/style/character-style.ts:36
Returns CharacterStyle

link

link(link: string): CharacterStyle

- Defined in file/styles/style/character-style.ts:52
Parameters
- link: string
Returns CharacterStyle

prepForXml

prepForXml(): IXmlableObject | undefined

Inherited from XmlComponent.prepForXml

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

push

push(styleSegment: XmlComponent): void

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

semiHidden

semiHidden(): CharacterStyle

- Defined in file/styles/style/character-style.ts:57
Returns CharacterStyle

shadow

shadow(value: string, fill: string, color: string): CharacterStyle

- Defined in file/styles/style/character-style.ts:66
Parameters
- value: string
- fill: string
- color: string
Returns CharacterStyle

size

size(twips: number): CharacterStyle

- Defined in file/styles/style/character-style.ts:48
Parameters
- twips: number
Returns CharacterStyle

superScript

superScript(): CharacterStyle

- Defined in file/styles/style/character-style.ts:44
Returns CharacterStyle

underline

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

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

Generated using TypeDoc