Class FootNoteReferenceRunAttributes`Internal`

Represents the attributes for a footnote reference element.

Hierarchy (View Summary)

XmlAttributeComponent<{ id: number }>
- FootNoteReferenceRunAttributes

Index

Constructors

Accessors

Methods

Constructors

constructor

new FootNoteReferenceRunAttributes(
root: { id: number },
): FootNoteReferenceRunAttributes
Creates a new attribute component.
Parameters
- root: { id: number }
  The attribute data object
  - Readonlyid: number
    
    Unique identifier linking to the footnote
Returns FootNoteReferenceRunAttributes
Inherited from XmlAttributeComponent.constructor
- Defined in file/xml-components/default-attributes.ts:60

Accessors

writtenAs

get writtenAs(): readonly BaseXmlComponent[] | undefined
Internal
The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

Returns readonly BaseXmlComponent[] | undefined
Inherited from XmlAttributeComponent.writtenAs
- Defined in file/xml-components/base.ts:84

Methods

prepForXml

prepForXml(_: IContext): IXmlableObject
Converts the attribute data to an XML-serializable object.

This method transforms the property names using xmlKeys (if defined) and filters out undefined values.
Parameters
- _: IContext
  Context (unused for attributes)
Returns IXmlableObject
Object with _attr key containing the mapped attributes
Inherited from XmlAttributeComponent.prepForXml
- Defined in file/xml-components/default-attributes.ts:73