Class NumberedItemReference

Creates a field/cross reference to a numbered item in the document.

Hierarchy (View Summary)

SimpleField
- NumberedItemReference

Index

Constructors

Methods

addChildElement prepForXml

Constructors

constructor

new NumberedItemReference(
    bookmarkId: string,
    cachedValue?: string,
    options?: INumberedItemReferenceOptions,
): NumberedItemReference
Parameters
- bookmarkId: string
- OptionalcachedValue: string
  The cached value of the field. This is used to display the field result in the document.
- options: INumberedItemReferenceOptions = {}
Returns NumberedItemReference
Overrides SimpleField.constructor
- Defined in file/paragraph/links/numbered-item-ref.ts:46

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

prepForXml

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