Class SymbolRun

Represents a symbol character in a WordprocessingML document.

SymbolRun is used to insert special characters from symbol fonts.

Example

new SymbolRun({
  char: "F04A",
  symbolfont: "Wingdings",
});

Hierarchy (View Summary)

Run
- SymbolRun

Index

Constructors

Methods

addChildElement prepForXml

Constructors

constructor

new SymbolRun(options: string | ISymbolRunOptions): SymbolRun
Parameters
- options: string | ISymbolRunOptions
Returns SymbolRun
Overrides Run.constructor
- Defined in file/paragraph/run/symbol-run.ts:37

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Parameters
- child: string | XmlComponent
Returns XmlComponent
Deprecated
Do not use this method. It is only used internally by the library. It will be removed in a future version.
Inherited from Run.addChildElement
- Defined in file/xml-components/xml-component.ts:67

prepForXml

prepForXml(context: IContext): undefined | IXmlableObject
Parameters
- context: IContext
Returns undefined | IXmlableObject
Inherited from Run.prepForXml
- Defined in file/xml-components/xml-component.ts:39