Class TableRowProperties

Represents table row properties (trPr) in a WordprocessingML document.

The trPr element specifies properties for a table row including height, whether it can split across pages, and whether it's a header row.

Reference: http://officeopenxml.com/WPtableRowProperties.php

Example

new TableRowProperties({
  cantSplit: true,
  tableHeader: true,
  height: {
    value: 1000,
    rule: HeightRule.EXACT,
  },
});

Hierarchy (View Summary)

IgnoreIfEmptyXmlComponent
- TableRowProperties

Index

Constructors

Methods

addChildElement prepForXml

Constructors

constructor

new TableRowProperties(options: ITableRowPropertiesOptions): TableRowProperties
Parameters
- options: ITableRowPropertiesOptions
Returns TableRowProperties
Overrides IgnoreIfEmptyXmlComponent.constructor
- Defined in file/table/table-row/table-row-properties.ts:109

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

prepForXml

prepForXml(context: IContext): IXmlableObject | undefined
Prepares the component for XML serialization, excluding it if empty.
Parameters
- context: IContext
  The serialization context
Returns IXmlableObject | undefined
The XML-serializable object, or undefined if empty
Inherited from IgnoreIfEmptyXmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:173