Class TableOfContents

Hierarchy (View Summary)

FileChild
- TableOfContents

Index

Constructors

Properties

Methods

addChildElement prepForXml

Constructors

constructor

new TableOfContents(
alias?: string,
properties?: ITableOfContentsOptions,
): TableOfContents
Parameters
- alias: string = "Table of Contents"
- Optionalproperties: ITableOfContentsOptions
Returns TableOfContents
Overrides FileChild.constructor
- Defined in file/table-of-contents/table-of-contents.ts:14

Properties

`Readonly`fileChild

fileChild: symbol = ...

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

prepForXml

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