Class RunPropertiesChange

Represents a run properties change element for revision tracking.

This element is used to track changes to run properties when revision tracking is enabled in the document.

Hierarchy (View Summary)

XmlComponent
- RunPropertiesChange

Index

Constructors

Methods

addChildElement prepForXml

Constructors

constructor

new RunPropertiesChange(
options: IRunPropertiesChangeOptions,
): RunPropertiesChange
Parameters
- options: IRunPropertiesChangeOptions
Returns RunPropertiesChange
Overrides XmlComponent.constructor
- Defined in file/paragraph/run/properties.ts:436

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Adds a child element to this component.
Parameters
- child: string | XmlComponent
  The child component or text string to add
Returns XmlComponent
This component (for chaining)

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:126

prepForXml

prepForXml(context: IContext): IXmlableObject | undefined
Prepares this component and its children for XML serialization.

This method is called by the Formatter to convert the component tree into an object structure compatible with the xml library (https://www.npmjs.com/package/xml). It recursively processes all children and handles special cases like attribute-only elements and empty elements.

The method can be overridden by subclasses to customize XML representation or execute side effects during serialization (e.g., creating relationships).
Parameters
- context: IContext
  The serialization context containing document state
Returns IXmlableObject | undefined
The XML-serializable object, or undefined to exclude from output
Example
```
// Override to add custom serialization logic
prepForXml(context: IContext): IXmlableObject | undefined {
  // Custom logic here
  return super.prepForXml(context);
}
```
Inherited from XmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:88