Class Comments

Hierarchy (View Summary)

XmlComponent
- Comments

Index

Constructors

Methods

addChildElement prepForXml

Constructors

constructor

new Comments(__namedParameters: ICommentsOptions): Comments
Parameters
- __namedParameters: ICommentsOptions
Returns Comments
Overrides XmlComponent.constructor
- Defined in file/paragraph/run/comment-run.ts:139

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 XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:48

prepForXml

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